Show / Hide Table of Contents

Class ListClusterPlacementGroupsRequest

Inheritance
object
ListClusterPlacementGroupsRequest
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.ClusterplacementgroupsService.Requests
Assembly: OCI.DotNetSDK.Clusterplacementgroups.dll
Syntax
public class ListClusterPlacementGroupsRequest : IOciRequest
Examples

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

Properties

Ad

Declaration
[HttpConverter(TargetEnum.Query, "ad")]
public string Ad { get; set; }
Property Value
Type Description
string

A filter to return only the resources that match the specified availability domain.

CompartmentId

Declaration
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

A filter to return only the resources that match the specified compartment OCID.

CompartmentIdInSubtree

Declaration
[HttpConverter(TargetEnum.Query, "compartmentIdInSubtree")]
public bool? CompartmentIdInSubtree { get; set; }
Property Value
Type Description
bool?

When set to true, cluster placement groups in all compartments under the specified compartment are returned. The default is set to false.

Id

Declaration
[HttpConverter(TargetEnum.Query, "id")]
public string Id { get; set; }
Property Value
Type Description
string

A filter to return only the resources that match the specified unique cluster placement group identifier.

LifecycleState

Declaration
[HttpConverter(TargetEnum.Query, "lifecycleState")]
public ClusterPlacementGroup.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
ClusterPlacementGroup.LifecycleStateEnum?

A filter to return only the resources that match the specified lifecycle state.

Limit

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

The maximum number of items to return.

Name

Declaration
[HttpConverter(TargetEnum.Query, "name")]
public string Name { get; set; }
Property Value
Type Description
string

A filter to return only the resources that match the entire display name specified.

OpcRequestId

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

The client request ID for tracing.

Page

Declaration
[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }
Property Value
Type Description
string

A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response.

SortBy

Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListClusterPlacementGroupsRequest.SortByEnum? SortBy { get; set; }
Property Value
Type Description
ListClusterPlacementGroupsRequest.SortByEnum?

The field to sort by. You can specify only one sort order. The default order for timeCreated is descending. The default order for name is ascending.

SortOrder

Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public SortOrder? SortOrder { get; set; }
Property Value
Type Description
SortOrder?

The sort order to use, either 'ASC' or 'DESC'.

Implements

IOciRequest
In this article
Back to top