Class ListOccCustomerGroupsRequest
Implements
Inherited Members
Namespace: Oci.CapacitymanagementService.Requests
Assembly: OCI.DotNetSDK.Capacitymanagement.dll
Syntax
public class ListOccCustomerGroupsRequest : IOciRequest
Examples
Click here to see an example of how to use ListOccCustomerGroups 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 or tenancy in which resources are to be listed. This will also be used for authorization purposes. |
Remarks
Required
DisplayName
Declaration
[HttpConverter(TargetEnum.Query, "displayName")]
public string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string | A filter to return only the resources that match the entire display name. The match is not case sensitive. |
Id
Declaration
[HttpConverter(TargetEnum.Query, "id")]
public string Id { get; set; }
Property Value
Type | Description |
---|---|
string | A query filter to return the list result based on the customer group OCID. This is done for users who have INSPECT permission but do not have READ permission. |
Limit
Declaration
[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }
Property Value
Type | Description |
---|---|
int? | The maximum number of items to return. |
OpcRequestId
Declaration
[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }
Property Value
Type | Description |
---|---|
string | The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash. |
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 |
SortBy
Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListOccCustomerGroupsRequest.SortByEnum? SortBy { get; set; }
Property Value
Type | Description |
---|---|
ListOccCustomerGroupsRequest.SortByEnum? | The field to sort by. Only one sort order may be provided. Default order for name and compartment ID is ascending. Default order for time created is descending. |
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'. |
Status
Declaration
[HttpConverter(TargetEnum.Query, "status")]
public OccCustomerGroup.StatusEnum? Status { get; set; }
Property Value
Type | Description |
---|---|
OccCustomerGroup.StatusEnum? | A query filter to return the list result based on status. |