PatternSummary¶

class oci.data_catalog.models.PatternSummary(**kwargs)¶

Bases: object

Summary of a 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.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a PatternSummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a PatternSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a PatternSummary.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a PatternSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a PatternSummary.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a PatternSummary.
`LIFECYCLE_STATE_MOVING`	A constant which can be used with the lifecycle_state property of a PatternSummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a PatternSummary.
`catalog_id`	Gets the catalog_id of this PatternSummary.
`description`	Gets the description of this PatternSummary.
`display_name`	Gets the display_name of this PatternSummary.
`expression`	Gets the expression of this PatternSummary.
`file_path_prefix`	Gets the file_path_prefix of this PatternSummary.
`key`	[Required] Gets the key of this PatternSummary.
`lifecycle_state`	Gets the lifecycle_state of this PatternSummary.
`time_created`	Gets the time_created of this PatternSummary.

Methods

__init__(**kwargs) Initializes a new PatternSummary object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a PatternSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a PatternSummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a PatternSummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a PatternSummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a PatternSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a PatternSummary. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_MOVING = 'MOVING'¶: A constant which can be used with the lifecycle_state property of a PatternSummary. This constant has a value of “MOVING”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a PatternSummary. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new PatternSummary 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 PatternSummary.
display_name (str) – The value to assign to the display_name property of this PatternSummary.
description (str) – The value to assign to the description property of this PatternSummary.
catalog_id (str) – The value to assign to the catalog_id property of this PatternSummary.
time_created (datetime) – The value to assign to the time_created property of this PatternSummary.
expression (str) – The value to assign to the expression property of this PatternSummary.
file_path_prefix (str) – The value to assign to the file_path_prefix property of this PatternSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this PatternSummary. 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’.

catalog_id¶

Gets the catalog_id of this PatternSummary. The data catalog’s OCID.

Returns:	The catalog_id of this PatternSummary.
Return type:	str

description¶

Gets the description of this PatternSummary. Detailed description of the pattern.

Returns:	The description of this PatternSummary.
Return type:	str

display_name¶

Gets the display_name of this PatternSummary. 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 PatternSummary.
Return type:	str

expression¶

Gets the expression of this PatternSummary. 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 PatternSummary.
Return type:	str

file_path_prefix¶

Gets the file_path_prefix of this PatternSummary. 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 PatternSummary.
Return type:	str

key¶

[Required] Gets the key of this PatternSummary. Unique pattern key that is immutable.

Returns:	The key of this PatternSummary.
Return type:	str

lifecycle_state¶

Gets the lifecycle_state of this PatternSummary. 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 PatternSummary.
Return type:	str

time_created¶

Gets the time_created of this PatternSummary. 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 PatternSummary.
Return type:	datetime