Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListRecordsRequest

example

Click here to see how to use ListRecordsRequest.

Properties

Optional annotationLabelsContains

annotationLabelsContains: Array<string>

Lets the user filter records based on the related annotations.

compartmentId

compartmentId: string

The ID of the compartment in which to list resources.

datasetId

datasetId: string

Filter the results by the OCID of the dataset.

Optional id

id: undefined | string

The unique OCID identifier.

Optional isLabeled

isLabeled: undefined | false | true

Whether the record has been labeled and has associated annotations.

Optional lifecycleState

lifecycleState: undefined | string

A filter to return only resources whose lifecycleState matches the given lifecycleState.

Optional limit

limit: undefined | number

The maximum number of items to return.

Optional name

name: undefined | string

The name of the record.

Optional opcRequestId

opcRequestId: undefined | string

The client request ID for tracing.

Optional page

page: undefined | string

The page token representing the page at which to start retrieving results. This is usually retrieved from a 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. Only one sort order may be provided. The default order for timeCreated is descending. The default order for name is ascending. If no value is specified, timeCreated is used by default.

Optional sortOrder

sortOrder: model.SortOrders

The sort order to use, either 'asc' or 'desc'.