Namespace SearchCriteriaRequest

example: Click here to see how to use SearchCriteriaRequest.

Enumerations

Properties

catalogId

catalogId: string

Unique catalog identifier.

Optional displayName

displayName: undefined | string

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

Optional lifecycleState

lifecycleState: model.LifecycleState

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

Optional limit

limit: undefined | number

The maximum number of items to return.

Optional name

name: undefined | string

Immutable resource name.

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 searchCriteriaDetails

searchCriteriaDetails: model.SearchCriteria

The information used to create an extended search results.

Optional sortBy

sortBy: SortBy

The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

Optional sortOrder

sortOrder: SortOrder

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

Optional timeout

timeout: undefined | string

A search timeout string (for example, timeout=4000ms), bounding the search request to be executed within the specified time value and bail with the hits accumulated up to that point when expired. Defaults to no timeout.