Class ListDesktopPoolsRequest

Inheritance

object

ListDesktopPoolsRequest

Implements

IOciRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DesktopsService.Requests

Assembly: OCI.DotNetSDK.Desktops.dll

Syntax

public class ListDesktopPoolsRequest : IOciRequest

Examples

Click here to see an example of how to use ListDesktopPools request.

Properties

AvailabilityDomain

Declaration

[HttpConverter(TargetEnum.Query, "availabilityDomain")]
public string AvailabilityDomain { get; set; }

Property Value

Type	Description
string	The name of the availability domain.

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment of the desktop pool.

Remarks

Required

DisplayName

Declaration

[HttpConverter(TargetEnum.Query, "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A filter to return only results with the given displayName.

Id

Declaration

[HttpConverter(TargetEnum.Query, "id")]
public string Id { get; set; }

Property Value

Type	Description
string	A filter to return only results with the given OCID.

LifecycleState

Declaration

[HttpConverter(TargetEnum.Query, "lifecycleState")]
public string LifecycleState { get; set; }

Property Value

Type	Description
string	A filter to return only results with the given lifecycleState.

Limit

Declaration

[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }

Property Value

Type	Description
int?	The maximum number of results to return.

OpcRequestId

Declaration

[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }

Property Value

Type	Description
string	The unique identifier of the request.

Page

Declaration

[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }

Property Value

Type	Description
string	For list pagination.

SortBy

Declaration

[HttpConverter(TargetEnum.Query, "sortBy")]
public ListDesktopPoolsRequest.SortByEnum? SortBy { get; set; }

Property Value

Type	Description
ListDesktopPoolsRequest.SortByEnum?	A field to sort by.

SortOrder

Declaration

[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListDesktopPoolsRequest.SortOrderEnum? SortOrder { get; set; }

Property Value

Type	Description
ListDesktopPoolsRequest.SortOrderEnum?	A field to indicate the sort order.

Implements

IOciRequest