CreatePatternDetails¶

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

Bases: object

Properties used in pattern create operations.

Methods

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

Attributes

`check_failure_limit`	Gets the check_failure_limit of this CreatePatternDetails.
`check_file_path_list`	Gets the check_file_path_list of this CreatePatternDetails.
`description`	Gets the description of this CreatePatternDetails.
`display_name`	[Required] Gets the display_name of this CreatePatternDetails.
`expression`	Gets the expression of this CreatePatternDetails.
`file_path_prefix`	Gets the file_path_prefix of this CreatePatternDetails.
`is_enable_check_failure_limit`	Gets the is_enable_check_failure_limit of this CreatePatternDetails.
`properties`	Gets the properties of this CreatePatternDetails.

__init__(**kwargs)¶

Initializes a new CreatePatternDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

display_name (str) – The value to assign to the display_name property of this CreatePatternDetails.
description (str) – The value to assign to the description property of this CreatePatternDetails.
expression (str) – The value to assign to the expression property of this CreatePatternDetails.
file_path_prefix (str) – The value to assign to the file_path_prefix property of this CreatePatternDetails.
check_file_path_list (list[str]) – The value to assign to the check_file_path_list property of this CreatePatternDetails.
is_enable_check_failure_limit (bool) – The value to assign to the is_enable_check_failure_limit property of this CreatePatternDetails.
check_failure_limit (int) – The value to assign to the check_failure_limit property of this CreatePatternDetails.
properties (dict(str, dict(str, str))) – The value to assign to the properties property of this CreatePatternDetails.

check_failure_limit¶

Gets the check_failure_limit of this CreatePatternDetails. 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 CreatePatternDetails.
Return type:	int

check_file_path_list¶

Gets the check_file_path_list of this CreatePatternDetails. 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 CreatePatternDetails.
Return type:	list[str]

description¶

Gets the description of this CreatePatternDetails. Detailed description of the Pattern.

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

display_name¶

[Required] Gets the display_name of this CreatePatternDetails. 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 CreatePatternDetails.
Return type:	str

expression¶

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

file_path_prefix¶

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

is_enable_check_failure_limit¶

Gets the is_enable_check_failure_limit of this CreatePatternDetails. 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 CreatePatternDetails.
Return type:	bool

properties¶

Gets the properties of this CreatePatternDetails. 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 CreatePatternDetails.
Return type:	dict(str, dict(str, str))