@Generated(value="OracleSDKGenerator",
comments="API Version: 20190325")
public final class Pattern
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
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.
Note: Objects should always be created or deserialized using the Pattern.Builder. This model
distinguishes fields that are null because they are unset from fields that are explicitly
set to null. This is done in the setter methods of the Pattern.Builder, which maintain a
set of all explicitly set fields called Pattern.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set
fields into account. The constructor, on the other hand, does not take the explicitly set fields
into account (since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
Pattern.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
Pattern(String key,
String displayName,
String description,
String catalogId,
LifecycleState lifecycleState,
Date timeCreated,
Date timeUpdated,
String createdById,
String updatedById,
String expression,
String filePathPrefix,
List<String> checkFilePathList,
Boolean isEnableCheckFailureLimit,
Integer checkFailureLimit,
Map<String,Map<String,String>> properties)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Pattern.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getCatalogId()
The data catalog’s OCID.
|
Integer |
getCheckFailureLimit()
The maximum number of UNMATCHED files, in checkFilePathList, above which the check fails.
|
List<String> |
getCheckFilePathList()
List of file paths against which the pattern can be tried, as a check.
|
String |
getCreatedById()
OCID of the user who created the pattern.
|
String |
getDescription()
Detailed description of the pattern.
|
String |
getDisplayName()
A user-friendly display name.
|
String |
getExpression()
Input string which drives the selection process, allowing for fine-grained control using
qualifiers.
|
String |
getFilePathPrefix()
Input string which drives the selection process.
|
Boolean |
getIsEnableCheckFailureLimit()
Indicates whether the pattern check, against the checkFilePathList, will fail the request if
the count of UNMATCHED files is above the checkFailureLimit.
|
String |
getKey()
Unique pattern key that is immutable.
|
LifecycleState |
getLifecycleState()
The current state of the pattern.
|
Map<String,Map<String,String>> |
getProperties()
A map of maps that contains the properties which are specific to the pattern type.
|
Date |
getTimeCreated()
The date and time the pattern was created, in the format defined by
RFC3339.
|
Date |
getTimeUpdated()
The last time that any change was made to the pattern.
|
String |
getUpdatedById()
OCID of the user who last modified the pattern.
|
int |
hashCode() |
Pattern.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"key","displayName","description","catalogId","lifecycleState","timeCreated","timeUpdated","createdById","updatedById","expression","filePathPrefix","checkFilePathList","isEnableCheckFailureLimit","checkFailureLimit","properties"}) public Pattern(String key, String displayName, String description, String catalogId, LifecycleState lifecycleState, Date timeCreated, Date timeUpdated, String createdById, String updatedById, String expression, String filePathPrefix, List<String> checkFilePathList, Boolean isEnableCheckFailureLimit, Integer checkFailureLimit, Map<String,Map<String,String>> properties)
public static Pattern.Builder builder()
Create a new builder.
public Pattern.Builder toBuilder()
public String getKey()
Unique pattern key that is immutable.
public String getDisplayName()
A user-friendly display name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
public String getDescription()
Detailed description of the pattern.
public String getCatalogId()
The data catalog’s OCID.
public LifecycleState getLifecycleState()
The current state of the pattern.
public Date getTimeCreated()
The date and time the pattern was created, in the format defined by
RFC3339. Example: 2019-03-25T21:10:29.600Z
public Date getTimeUpdated()
The last time that any change was made to the pattern. An RFC3339 formatted datetime string.
public String getCreatedById()
OCID of the user who created the pattern.
public String getUpdatedById()
OCID of the user who last modified the pattern.
public String getExpression()
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.
public String getFilePathPrefix()
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.
public List<String> getCheckFilePathList()
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.
public Boolean getIsEnableCheckFailureLimit()
Indicates whether the pattern check, against the checkFilePathList, will fail the request if the count of UNMATCHED files is above the checkFailureLimit.
public Integer getCheckFailureLimit()
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.
public Map<String,Map<String,String>> getProperties()
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"}}}
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.