Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListEndpointsRequest

example

Click here to see how to use ListEndpointsRequest.

Properties

compartmentId

compartmentId: string

The OCID of the compartment in which to list resources.

Optional displayName

displayName: undefined | string

A filter to return only resources that match the given display name exactly.

Optional id

id: undefined | string

The OCID of the endpoint.

Optional lifecycleState

lifecycleState: undefined | string

A filter to return only resources that their lifecycle state matches the given lifecycle state.

Optional limit

limit: undefined | number

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

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. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Optional page

page: undefined | string

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

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 only one sort order. Default order for {@code timeCreated} is descending. Default order for {@code displayName} is ascending.

Optional sortOrder

sortOrder: model.SortOrder

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