Class JobMetric.Builder

  • Enclosing class:
    JobMetric

    public static class JobMetric.Builder
    extends Object
    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • key

        public JobMetric.Builder key​(String key)
        Key of the job metric that is immutable.
        Parameters:
        key - the value to set
        Returns:
        this builder
      • description

        public JobMetric.Builder description​(String description)
        Detailed description of the metric.
        Parameters:
        description - the value to set
        Returns:
        this builder
      • jobExecutionKey

        public JobMetric.Builder jobExecutionKey​(String jobExecutionKey)
        The unique key of the parent job execution for which the job metric resource is being created.
        Parameters:
        jobExecutionKey - the value to set
        Returns:
        this builder
      • timeInserted

        public JobMetric.Builder timeInserted​(Date timeInserted)
        The time the metric was logged or captured in the system where the job executed.

        An RFC3339 formatted datetime string.

        Parameters:
        timeInserted - the value to set
        Returns:
        this builder
      • category

        public JobMetric.Builder category​(String category)
        Category of this metric.
        Parameters:
        category - the value to set
        Returns:
        this builder
      • displayName

        public JobMetric.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
      • subCategory

        public JobMetric.Builder subCategory​(String subCategory)
        Sub category of this metric under the category.

        Used for aggregating values. May be null.

        Parameters:
        subCategory - the value to set
        Returns:
        this builder
      • unit

        public JobMetric.Builder unit​(String unit)
        Unit of this metric.
        Parameters:
        unit - the value to set
        Returns:
        this builder
      • value

        public JobMetric.Builder value​(String value)
        Value of this metric.
        Parameters:
        value - the value to set
        Returns:
        this builder
      • batchKey

        public JobMetric.Builder batchKey​(String batchKey)
        Batch key for grouping, may be null.
        Parameters:
        batchKey - the value to set
        Returns:
        this builder
      • uri

        public JobMetric.Builder uri​(String uri)
        URI to the job metric instance in the API.
        Parameters:
        uri - the value to set
        Returns:
        this builder
      • timeCreated

        public JobMetric.Builder timeCreated​(Date timeCreated)
        The date and time the job metric 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 JobMetric.Builder timeUpdated​(Date timeUpdated)
        The last time that this metric was updated.

        An RFC3339 formatted datetime string.

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

        public JobMetric.Builder createdById​(String createdById)
        OCID of the user who created the metric for this job.

        Usually the executor of the job instance.

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

        public JobMetric.Builder updatedById​(String updatedById)
        OCID of the user who created the metric for this job.

        Usually the executor of the job instance.

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