Class 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.

Inheritance

object

Pattern

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DatacatalogService.Models

Assembly: OCI.DotNetSDK.Datacatalog.dll

Syntax

public class Pattern

Properties

CatalogId

Declaration

[JsonProperty(PropertyName = "catalogId")]
public string CatalogId { get; set; }

Property Value

Type	Description
string	The data catalog's OCID.

CheckFailureLimit

Declaration

[JsonProperty(PropertyName = "checkFailureLimit")]
public int? CheckFailureLimit { get; set; }

Property Value

Type	Description
int?	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.

CheckFilePathList

Declaration

[JsonProperty(PropertyName = "checkFilePathList")]
public List<string> CheckFilePathList { get; set; }

Property Value

Type	Description
List<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.

Type

Description

List<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.

CreatedById

Declaration

[JsonProperty(PropertyName = "createdById")]
public string CreatedById { get; set; }

Property Value

Type	Description
string	OCID of the user who created the pattern.

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	Detailed description of the pattern.

DisplayName

Declaration

[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

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

Expression

Declaration

[JsonProperty(PropertyName = "expression")]
public string Expression { get; set; }

Property Value

Type	Description
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.

FilePathPrefix

Declaration

[JsonProperty(PropertyName = "filePathPrefix")]
public string FilePathPrefix { get; set; }

Property Value

Type	Description
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.

IsEnableCheckFailureLimit

Declaration

[JsonProperty(PropertyName = "isEnableCheckFailureLimit")]
public bool? IsEnableCheckFailureLimit { get; set; }

Property Value

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

Key

Declaration

[Required(ErrorMessage = "Key is required.")]
[JsonProperty(PropertyName = "key")]
public string Key { get; set; }

Property Value

Type	Description
string	Unique pattern key that is immutable.

Remarks

Required

LifecycleState

Declaration

[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public LifecycleState? LifecycleState { get; set; }

Property Value

Type	Description
LifecycleState?	The current state of the pattern.

Properties

Declaration

[JsonProperty(PropertyName = "properties")]
public Dictionary<string, Dictionary<string, string>> Properties { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, string>>	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"}}}

TimeCreated

Declaration

[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the pattern was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

TimeUpdated

Declaration

[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

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

UpdatedById

Declaration

[JsonProperty(PropertyName = "updatedById")]
public string UpdatedById { get; set; }

Property Value

Type	Description
string	OCID of the user who last modified the pattern.