Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListOccCustomerGroupsRequest

example

Click here to see how to use ListOccCustomerGroupsRequest.

Properties

compartmentId

compartmentId: string

The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes.

Optional displayName

displayName: undefined | string

A filter to return only the resources that match the entire display name. The match is not case sensitive.

Optional id

id: undefined | 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.

Optional limit

limit: undefined | number

The maximum number of items to return.

Optional opcRequestId

opcRequestId: undefined | string

The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Optional page

page: undefined | string

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

Optional retryConfiguration

retryConfiguration: RetryConfiguration

RetryConfiguration to be used for the request NOTE : Retries are not supported for requests that have binary or stream bodies this also affects UploadManager operations For all requests with binary/stream bodies, retry attempts are not made

Optional sortBy

sortBy: SortBy

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.

Optional sortOrder

sortOrder: model.SortOrder

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

Optional status

status: undefined | string

A query filter to return the list result based on status.