Package com.oracle.bmc.datacatalog.model

Class Pattern

  • @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).

    • Method Detail

      • getKey

        public String getKey()
        Unique pattern key that is immutable.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        A user-friendly display name.

        Does not have to be unique, and it’s changeable. Avoid entering confidential information.

        Returns:
        the value

      • getDescription

        public String getDescription()
        Detailed description of the pattern.
        Returns:
        the value

      • getCatalogId

        public String getCatalogId()
        The data catalog’s OCID.
        Returns:
        the value

      • getLifecycleState

        public LifecycleState getLifecycleState()
        The current state of the pattern.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the pattern was created, in the format defined by RFC3339.

        Example: 2019-03-25T21:10:29.600Z

        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The last time that any change was made to the pattern.

        An RFC3339 formatted datetime string.

        Returns:
        the value

      • getCreatedById

        public String getCreatedById()
        OCID of the user who created the pattern.
        Returns:
        the value

      • getUpdatedById

        public String getUpdatedById()
        OCID of the user who last modified the pattern.
        Returns:
        the value

      • getExpression

        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.

        Returns:
        the value

      • getFilePathPrefix

        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.

        Returns:
        the value

      • getCheckFilePathList

        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.

        Returns:
        the value

      • getIsEnableCheckFailureLimit

        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.
        Returns:
        the value

      • getCheckFailureLimit

        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.

        Returns:
        the value

      • getProperties

        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”}}}

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel