Class ListPoolsRequest

Inheritance

object

ListPoolsRequest

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.DataflowService.Requests

Assembly: OCI.DotNetSDK.Dataflow.dll

Syntax

public class ListPoolsRequest : IOciRequest

Examples

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

Properties

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.

Remarks

Required

DisplayName

Declaration

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

Property Value

Type	Description
string	The query parameter for the Spark application name.

DisplayNameStartsWith

Declaration

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

Property Value

Type	Description
string	The displayName prefix.

LifecycleState

Declaration

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

Property Value

Type	Description
PoolLifecycleState?	The LifecycleState of the pool.

Limit

Declaration

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

Property Value

Type	Description
int?	The maximum number of results to return in a paginated List call.

OpcRequestId

Declaration

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

Property Value

Type	Description
string	Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service.

OwnerPrincipalId

Declaration

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

Property Value

Type	Description
string	The OCID of the user who created the resource.

Page

Declaration

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

Property Value

Type	Description
string	The value of the opc-next-page or opc-prev-page response header from the last List call to sent back to server for getting the next page of results.

SortBy

Declaration

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

Property Value

Type	Description
ListPoolsRequest.SortByEnum?	The field used to sort the results. Multiple fields are not supported.

SortOrder

Declaration

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

Property Value

Type	Description
ListPoolsRequest.SortOrderEnum?	The ordering of results in ascending or descending order.

Implements

IOciRequest