Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListRulesRequest

example

Click here to see how to use ListRulesRequest.

Properties

catalogId

catalogId: string

Unique catalog identifier.

Optional createdById

createdById: undefined | string

OCID of the user who created the resource.

dataAssetKey

dataAssetKey: string

Unique data asset key.

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

externalKey: undefined | string

Unique external identifier of this resource in the external source system.

Optional fields

fields: Array<Fields>

Specifies the fields to return in a rule summary response.

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 opcRequestId

opcRequestId: undefined | string

The client request ID for tracing.

Optional originType

originType: model.RuleOriginType

Rule origin type used to filter the response to a list rules call.

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 ruleType

ruleType: model.RuleType

Rule type used to filter the response to a list rules call.

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 timeCreated

timeCreated: Date

Time that the resource was created. An RFC3339 formatted datetime string.

Optional timeUpdated

timeUpdated: Date

Time that the resource was updated. An RFC3339 formatted datetime string.

Optional updatedById

updatedById: undefined | string

OCID of the user who updated the resource.