Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListCommitmentsRequest

example

Click here to see how to use ListCommitmentsRequest.

Properties

compartmentId

compartmentId: string

The OCID of the compartment.

Optional limit

limit: undefined | number

The maximum number of items to return in a paginated "List" call. Default: ({@code 50})

Example: {@code 500}

Optional opcRequestId

opcRequestId: undefined | string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Optional page

page: undefined | string

The value of the {@code opc-next-page} response header from the previous "List" call.

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. You can provide one sort order ({@code sortOrder}).

Optional sortOrder

sortOrder: SortOrder

The sort order to use, either ascending ({@code ASC}) or descending ({@code DESC}).

subscribedServiceId

subscribedServiceId: string

This param is used to get the commitments for a particular subscribed service

Optional xOneGatewaySubscriptionId

xOneGatewaySubscriptionId: undefined | string

This header is meant to be used only for internal purposes and will be ignored on any public request. The purpose of this header is to help on Gateway to API calls identification.

Optional xOneOriginRegion

xOneOriginRegion: undefined | string

The OCI home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.