Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListAddressListsRequest

example

Click here to see how to use ListAddressListsRequest.

Properties

compartmentId

compartmentId: string

The OCID of the compartment. This number is generated when the compartment is created.

Optional id

id: Array<string>

Filter address lists using a list of address lists OCIDs.

Optional lifecycleState

lifecycleState: Array<LifecycleStates>

Filter address lists using a list of lifecycle states.

Optional limit

limit: undefined | number

The maximum number of items to return in a paginated call. If unspecified, defaults to {@code 10}.

Optional name

name: Array<string>

Filter address lists using a list of names.

Optional opcRequestId

opcRequestId: undefined | string

The 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 paginated 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 value by which address lists are sorted in a paginated 'List' call. If unspecified, defaults to {@code timeCreated}.

Optional sortOrder

sortOrder: SortOrder

The value of the sorting direction of resources in a paginated 'List' call. If unspecified, defaults to {@code DESC}.

Optional timeCreatedGreaterThanOrEqualTo

timeCreatedGreaterThanOrEqualTo: Date

A filter that matches address lists created on or after the specified date-time.

Optional timeCreatedLessThan

timeCreatedLessThan: Date

A filter that matches address lists created before the specified date-time.