com.netflix.genie.common.external.dtos.v4

Class JobMetadata.Builder

java.lang.Object

com.netflix.genie.common.external.dtos.v4.CommonMetadata.Builder<JobMetadata.Builder>

com.netflix.genie.common.external.dtos.v4.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 Summary

Constructors

Constructor and Description
Builder(java.lang.String name, java.lang.String user) Constructor which will set a default version of 0.1.
Builder(java.lang.String name, java.lang.String user, java.lang.String version) Constructor which has required fields.

Method Summary

Modifier and Type	Method and Description
JobMetadata	build() Build the job user metadata instance.
JobMetadata.Builder	withEmail(java.lang.String email) Set the email to use for alerting of job completion.
JobMetadata.Builder	withGroup(java.lang.String group) Set the group for the job.
JobMetadata.Builder	withGrouping(java.lang.String grouping) Set the grouping to use for this job.
JobMetadata.Builder	withGroupingInstance(java.lang.String groupingInstance) Set the grouping instance to use for this job.

Methods inherited from class com.netflix.genie.common.external.dtos.v4.CommonMetadata.Builder

withDescription, withMetadata, withMetadata, withTags

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder(java.lang.String name,
               java.lang.String user,
               java.lang.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(java.lang.String name,
               java.lang.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 Detail

withGroup

public JobMetadata.Builder withGroup(@Nullable
                                     java.lang.String group)

Set the group for the job.

Parameters:

group - The group

Returns:

The builder

withEmail

public JobMetadata.Builder withEmail(@Nullable
                                     java.lang.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
                                        java.lang.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
                                                java.lang.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