Class Pattern.Builder

  • Enclosing class:
    Pattern

    public static class Pattern.Builder
    extends Object
    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • key

        public Pattern.Builder key​(String key)
        Unique pattern key that is immutable.
        Parameters:
        key - the value to set
        Returns:
        this builder
      • displayName

        public Pattern.Builder displayName​(String displayName)
        A user-friendly display name.

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

        Parameters:
        displayName - the value to set
        Returns:
        this builder
      • description

        public Pattern.Builder description​(String description)
        Detailed description of the pattern.
        Parameters:
        description - the value to set
        Returns:
        this builder
      • catalogId

        public Pattern.Builder catalogId​(String catalogId)
        The data catalog’s OCID.
        Parameters:
        catalogId - the value to set
        Returns:
        this builder
      • lifecycleState

        public Pattern.Builder lifecycleState​(LifecycleState lifecycleState)
        The current state of the pattern.
        Parameters:
        lifecycleState - the value to set
        Returns:
        this builder
      • timeCreated

        public Pattern.Builder timeCreated​(Date timeCreated)
        The date and time the pattern was created, in the format defined by RFC3339.

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

        Parameters:
        timeCreated - the value to set
        Returns:
        this builder
      • timeUpdated

        public Pattern.Builder timeUpdated​(Date timeUpdated)
        The last time that any change was made to the pattern.

        An RFC3339 formatted datetime string.

        Parameters:
        timeUpdated - the value to set
        Returns:
        this builder
      • createdById

        public Pattern.Builder createdById​(String createdById)
        OCID of the user who created the pattern.
        Parameters:
        createdById - the value to set
        Returns:
        this builder
      • updatedById

        public Pattern.Builder updatedById​(String updatedById)
        OCID of the user who last modified the pattern.
        Parameters:
        updatedById - the value to set
        Returns:
        this builder
      • expression

        public Pattern.Builder expression​(String expression)
        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.

        Parameters:
        expression - the value to set
        Returns:
        this builder
      • filePathPrefix

        public Pattern.Builder filePathPrefix​(String filePathPrefix)
        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.

        Parameters:
        filePathPrefix - the value to set
        Returns:
        this builder
      • checkFilePathList

        public Pattern.Builder checkFilePathList​(List<String> checkFilePathList)
        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.

        Parameters:
        checkFilePathList - the value to set
        Returns:
        this builder
      • isEnableCheckFailureLimit

        public Pattern.Builder isEnableCheckFailureLimit​(Boolean isEnableCheckFailureLimit)
        Indicates whether the pattern check, against the checkFilePathList, will fail the request if the count of UNMATCHED files is above the checkFailureLimit.
        Parameters:
        isEnableCheckFailureLimit - the value to set
        Returns:
        this builder
      • checkFailureLimit

        public Pattern.Builder checkFailureLimit​(Integer checkFailureLimit)
        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.

        Parameters:
        checkFailureLimit - the value to set
        Returns:
        this builder
      • properties

        public Pattern.Builder properties​(Map<String,​Map<String,​String>> properties)
        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”}}}

        Parameters:
        properties - the value to set
        Returns:
        this builder