Package com.oracle.bmc.datacatalog.model

Class JobDefinition.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • key

        public JobDefinition.Builder key​(String key)
        Unique key of the job definition resource that is immutable.
        Parameters:
        key - the value to set
        Returns:
        this builder

      • displayName

        public JobDefinition.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

      • catalogId

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

      • jobType

        public JobDefinition.Builder jobType​(JobType jobType)
        Type of the job definition.
        Parameters:
        jobType - the value to set
        Returns:
        this builder

      • isIncremental

        public JobDefinition.Builder isIncremental​(Boolean isIncremental)
        Specifies if the job definition is incremental or full.
        Parameters:
        isIncremental - the value to set
        Returns:
        this builder

      • dataAssetKey

        public JobDefinition.Builder dataAssetKey​(String dataAssetKey)
        The key of the data asset for which the job is defined.
        Parameters:
        dataAssetKey - the value to set
        Returns:
        this builder

      • glossaryKey

        public JobDefinition.Builder glossaryKey​(String glossaryKey)
        Unique key of the glossary to which this job applies.
        Parameters:
        glossaryKey - the value to set
        Returns:
        this builder

      • description

        public JobDefinition.Builder description​(String description)
        Detailed description of the job definition.
        Parameters:
        description - the value to set
        Returns:
        this builder

      • connectionKey

        public JobDefinition.Builder connectionKey​(String connectionKey)
        The key of the default connection resource to be used for harvest, sampling, profiling jobs.

        This may be overridden in each job instance.

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

      • internalVersion

        public JobDefinition.Builder internalVersion​(String internalVersion)
        Version of the job definition object.

        Used internally but can be visible to users.

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

      • lifecycleState

        public JobDefinition.Builder lifecycleState​(LifecycleState lifecycleState)
        Lifecycle state of the job definition.
        Parameters:
        lifecycleState - the value to set
        Returns:
        this builder

      • timeCreated

        public JobDefinition.Builder timeCreated​(Date timeCreated)
        The date and time the job definition 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 JobDefinition.Builder timeUpdated​(Date timeUpdated)
        The last time that any change was made to the data asset.

        An RFC3339 formatted datetime string.

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

      • createdById

        public JobDefinition.Builder createdById​(String createdById)
        OCID of the user who created this job definition.
        Parameters:
        createdById - the value to set
        Returns:
        this builder

      • updatedById

        public JobDefinition.Builder updatedById​(String updatedById)
        OCID of the user who updated this job definition.
        Parameters:
        updatedById - the value to set
        Returns:
        this builder

      • uri

        public JobDefinition.Builder uri​(String uri)
        URI to the job definition instance in the API.
        Parameters:
        uri - the value to set
        Returns:
        this builder

      • isSampleDataExtracted

        public JobDefinition.Builder isSampleDataExtracted​(Boolean isSampleDataExtracted)
        Specify if sample data to be extracted as part of this harvest.
        Parameters:
        isSampleDataExtracted - the value to set
        Returns:
        this builder

      • sampleDataSizeInMBs

        public JobDefinition.Builder sampleDataSizeInMBs​(Integer sampleDataSizeInMBs)
        Specify the sample data size in MB, specified as number of rows, for this metadata harvest.
        Parameters:
        sampleDataSizeInMBs - the value to set
        Returns:
        this builder

      • timeLatestExecutionStarted

        public JobDefinition.Builder timeLatestExecutionStarted​(Date timeLatestExecutionStarted)
        Time that the latest job execution started.

        An RFC3339 formatted datetime string.

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

      • timeLatestExecutionEnded

        public JobDefinition.Builder timeLatestExecutionEnded​(Date timeLatestExecutionEnded)
        Time that the latest job execution ended or null if it hasn’t yet completed.

        An RFC3339 formatted datetime string.

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

      • jobExecutionState

        public JobDefinition.Builder jobExecutionState​(JobExecutionState jobExecutionState)
        Status of the latest job execution, such as running, paused, or completed.
        Parameters:
        jobExecutionState - the value to set
        Returns:
        this builder

      • scheduleType

        public JobDefinition.Builder scheduleType​(JobScheduleType scheduleType)
        Type of job schedule for the latest job executed.
        Parameters:
        scheduleType - the value to set
        Returns:
        this builder

      • properties

        public JobDefinition.Builder properties​(Map<String,​Map<String,​String>> properties)
        A map of maps that contains the properties which are specific to the job type.

        Each job type definition may define it’s set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most job definitions have required properties within the “default” category. Example: {“properties”: { “default”: { “host”: “host1”, “port”: “1521”, “database”: “orcl”}}}

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