Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListAggregatedPhysicalEntitiesRequest

example

Click here to see how to use ListAggregatedPhysicalEntitiesRequest.

Properties

catalogId

catalogId: string

Unique catalog identifier.

dataAssetKey

dataAssetKey: string

Unique data asset key.

Optional displayNameContains

displayNameContains: undefined | string

A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.

entityKey

entityKey: string

Unique entity key.

Optional fields

fields: Array<Fields>

Specifies the fields to return in an entity response.

Optional isIncludeProperties

isIncludeProperties: undefined | false | true

Indicates whether the properties map will be provided in the response.

Optional limit

limit: undefined | number

The maximum number of items to return.

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. 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'.