Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListTypesRequest

example

Click here to see how to use ListTypesRequest.

Properties

catalogId

catalogId: string

Unique catalog identifier.

Optional externalTypeName

externalTypeName: undefined | string

Data type as defined in an external system.

Optional fields

fields: Array<Fields>

Specifies the fields to return in a type summary response.

Optional isApproved

isApproved: undefined | string

Indicates whether the type is approved for use as a classifying object.

Optional isInternal

isInternal: undefined | string

Indicates whether the type is internal, making it unavailable for use by metadata elements.

Optional isTag

isTag: undefined | string

Indicates whether the type can be used for tagging metadata elements.

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 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 typeCategory

typeCategory: undefined | string

Indicates the category of this type . For example, data assets or connections.