Class JobMetadata.Builder

Enclosing class:
JobMetadata

public static class JobMetadata.Builder extends CommonMetadata.Builder<JobMetadata.Builder>
A builder to create job user metadata instances.
Since:
4.0.0
  • Constructor Details

    • Builder

      public Builder(String name, String user, String version)
      Constructor which has required fields.
      Parameters:
      name - The name to use for the job
      user - The user to use for the Job
      version - The version of the job
    • Builder

      public Builder(String name, String user)
      Constructor which will set a default version of 0.1.
      Parameters:
      name - The name to use for the job
      user - The user to use for the job
  • Method Details

    • withGroup

      public JobMetadata.Builder withGroup(@Nullable String group)
      Set the group for the job.
      Parameters:
      group - The group
      Returns:
      The builder
    • withEmail

      public JobMetadata.Builder withEmail(@Nullable String email)
      Set the email to use for alerting of job completion. If no alert desired leave blank.
      Parameters:
      email - the email address to use
      Returns:
      The builder
    • withGrouping

      public JobMetadata.Builder withGrouping(@Nullable String grouping)
      Set the grouping to use for this job.
      Parameters:
      grouping - The grouping
      Returns:
      The builder
      Since:
      3.3.0
    • withGroupingInstance

      public JobMetadata.Builder withGroupingInstance(@Nullable String groupingInstance)
      Set the grouping instance to use for this job.
      Parameters:
      groupingInstance - The grouping instance
      Returns:
      The builder
      Since:
      3.3.0
    • build

      public JobMetadata build()
      Build the job user metadata instance.
      Returns:
      Create the final read-only JobMetadata instance