Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Pattern

A pattern is a data selector or filter which can provide a singular, logical entity view aggregating multiple physical data artifacts for ease of use.

Properties

Optional catalogId

catalogId: undefined | string

The data catalog's OCID.

Optional checkFailureLimit

checkFailureLimit: undefined | number

The maximum number of UNMATCHED files, in checkFilePathList, above which the check fails. Optional, if checkFilePathList is provided - but if isEnableCheckFailureLimit is set to true it is required. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional checkFilePathList

checkFilePathList: Array<string>

List of file paths against which the pattern can be tried, as a check. This documents, for reference purposes, some example objects a pattern is meant to work with. If isEnableCheckFailureLimit is set to true, this will be run as a validation during the request, such that if the check fails the request fails. If isEnableCheckFailureLimit instead is set to (the default) false, a pattern will still be created or updated even if the check fails, with a lifecycleState of FAILED.

Optional createdById

createdById: undefined | string

OCID of the user who created the pattern.

Optional description

description: undefined | string

Detailed description of the pattern.

Optional displayName

displayName: undefined | string

A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Optional expression

expression: undefined | string

Input string which drives the selection process, allowing for fine-grained control using qualifiers. Refer to the user documentation for details of the format and examples. A pattern cannot include both a prefix and an expression.

Optional filePathPrefix

filePathPrefix: undefined | string

Input string which drives the selection process. Refer to the user documentation for details of the format and examples. A pattern cannot include both a prefix and an expression.

Optional isEnableCheckFailureLimit

isEnableCheckFailureLimit: undefined | false | true

Indicates whether the pattern check, against the checkFilePathList, will fail the request if the count of UNMATCHED files is above the checkFailureLimit.

key

key: string

Unique pattern key that is immutable.

Optional lifecycleState

lifecycleState: model.LifecycleState

The current state of the pattern.

Optional properties

properties: undefined | object

A map of maps that contains the properties which are specific to the pattern type. Each pattern type definition defines it's set of required and optional properties. Example: {@code {"properties": { "default": { "tbd"}}}}

Optional timeCreated

timeCreated: Date

The date and time the pattern was created, in the format defined by RFC3339. Example: {@code 2019-03-25T21:10:29.600Z}

Optional timeUpdated

timeUpdated: Date

The last time that any change was made to the pattern. An RFC3339 formatted datetime string.

Optional updatedById

updatedById: undefined | string

OCID of the user who last modified the pattern.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Pattern): object

getJsonObj