Pattern¶
- class oci.data_catalog.models.Pattern(**kwargs)¶
Bases:
objectA pattern is a data selector or filter which can provide a singular, logical entity view aggregating multiple physical data artifacts for ease of use.
Attributes:
A constant which can be used with the lifecycle_state property of a Pattern.
A constant which can be used with the lifecycle_state property of a Pattern.
A constant which can be used with the lifecycle_state property of a Pattern.
A constant which can be used with the lifecycle_state property of a Pattern.
A constant which can be used with the lifecycle_state property of a Pattern.
A constant which can be used with the lifecycle_state property of a Pattern.
A constant which can be used with the lifecycle_state property of a Pattern.
A constant which can be used with the lifecycle_state property of a Pattern.
Gets the catalog_id of this Pattern.
Gets the check_failure_limit of this Pattern.
Gets the check_file_path_list of this Pattern.
Gets the created_by_id of this Pattern.
Gets the description of this Pattern.
Gets the display_name of this Pattern.
Gets the expression of this Pattern.
Gets the file_path_prefix of this Pattern.
Gets the is_enable_check_failure_limit of this Pattern.
[Required] Gets the key of this Pattern.
Gets the lifecycle_state of this Pattern.
Gets the properties of this Pattern.
Gets the time_created of this Pattern.
Gets the time_updated of this Pattern.
Gets the updated_by_id of this Pattern.
Methods:
__init__(**kwargs)Initializes a new Pattern object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a Pattern. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a Pattern. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a Pattern. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a Pattern. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a Pattern. This constant has a value of “FAILED”
- LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶
A constant which can be used with the lifecycle_state property of a Pattern. This constant has a value of “INACTIVE”
- LIFECYCLE_STATE_MOVING = 'MOVING'¶
A constant which can be used with the lifecycle_state property of a Pattern. This constant has a value of “MOVING”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a Pattern. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new Pattern object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
key (str) – The value to assign to the key property of this Pattern.
display_name (str) – The value to assign to the display_name property of this Pattern.
description (str) – The value to assign to the description property of this Pattern.
catalog_id (str) – The value to assign to the catalog_id property of this Pattern.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Pattern. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this Pattern.
time_updated (datetime) – The value to assign to the time_updated property of this Pattern.
created_by_id (str) – The value to assign to the created_by_id property of this Pattern.
updated_by_id (str) – The value to assign to the updated_by_id property of this Pattern.
expression (str) – The value to assign to the expression property of this Pattern.
file_path_prefix (str) – The value to assign to the file_path_prefix property of this Pattern.
check_file_path_list (list[str]) – The value to assign to the check_file_path_list property of this Pattern.
is_enable_check_failure_limit (bool) – The value to assign to the is_enable_check_failure_limit property of this Pattern.
check_failure_limit (int) – The value to assign to the check_failure_limit property of this Pattern.
properties (dict(str, dict(str, str))) – The value to assign to the properties property of this Pattern.
- property catalog_id¶
Gets the catalog_id of this Pattern. The data catalog’s OCID.
- Returns
The catalog_id of this Pattern.
- Return type
str
- property check_failure_limit¶
Gets the check_failure_limit of this Pattern. 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.
- Returns
The check_failure_limit of this Pattern.
- Return type
int
- property check_file_path_list¶
Gets the check_file_path_list of this Pattern. 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.
- Returns
The check_file_path_list of this Pattern.
- Return type
list[str]
- property created_by_id¶
Gets the created_by_id of this Pattern. OCID of the user who created the pattern.
- Returns
The created_by_id of this Pattern.
- Return type
str
- property description¶
Gets the description of this Pattern. Detailed description of the pattern.
- Returns
The description of this Pattern.
- Return type
str
- property display_name¶
Gets the display_name of this Pattern. A user-friendly display name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- Returns
The display_name of this Pattern.
- Return type
str
- property expression¶
Gets the expression of this Pattern. 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.
- Returns
The expression of this Pattern.
- Return type
str
- property file_path_prefix¶
Gets the file_path_prefix of this Pattern. 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.
- Returns
The file_path_prefix of this Pattern.
- Return type
str
- property is_enable_check_failure_limit¶
Gets the is_enable_check_failure_limit of this Pattern. Indicates whether the pattern check, against the checkFilePathList, will fail the request if the count of UNMATCHED files is above the checkFailureLimit.
- Returns
The is_enable_check_failure_limit of this Pattern.
- Return type
bool
- property key¶
[Required] Gets the key of this Pattern. Unique pattern key that is immutable.
- Returns
The key of this Pattern.
- Return type
str
- property lifecycle_state¶
Gets the lifecycle_state of this Pattern. The current state of the pattern.
Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this Pattern.
- Return type
str
- property properties¶
Gets the properties of this Pattern. 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: {“properties”: { “default”: { “tbd”}}}
- Returns
The properties of this Pattern.
- Return type
dict(str, dict(str, str))
- property time_created¶
Gets the time_created of this Pattern. The date and time the pattern was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z
- Returns
The time_created of this Pattern.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this Pattern. The last time that any change was made to the pattern. An RFC3339 formatted datetime string.
- Returns
The time_updated of this Pattern.
- Return type
datetime
- property updated_by_id¶
Gets the updated_by_id of this Pattern. OCID of the user who last modified the pattern.
- Returns
The updated_by_id of this Pattern.
- Return type
str