CommonDTO.Builder (genie 4.2.2-SNAPSHOT API)

java.lang.Object
- com.netflix.genie.common.dto.BaseDTO.Builder<T>
- - com.netflix.genie.common.dto.CommonDTO.Builder<T>

Type Parameters:

T - Type of builder that extends this

Direct Known Subclasses:

ExecutionEnvironmentDTO.Builder, Job.Builder

Enclosing class:

CommonDTO
```
public abstract static class CommonDTO.Builder<T extends CommonDTO.Builder>
extends BaseDTO.Builder<T>
```
Builder pattern to save constructor arguments.

Since:

3.0.0

Constructor Summary

Constructors
Modifier Constructor Description

protected Builder(java.lang.String name, java.lang.String user, java.lang.String version)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`T`	`withDescription(java.lang.String description)`	Set the description for the resource.
`T`	`withMetadata(com.fasterxml.jackson.databind.JsonNode metadata)`	With the metadata to set for the job as a JsonNode.
`T`	`withMetadata(java.lang.String metadata)`	With the metadata to set for the job as a string of valid JSON.
`T`	`withTags(java.util.Set<java.lang.String> tags)`	Set the tags to use for the resource.

Methods inherited from class com.netflix.genie.common.dto.BaseDTO.Builder
withCreated, withId, withUpdated

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

protected Builder(java.lang.String name,
                  java.lang.String user,
                  java.lang.String version)

Method Detail
- withDescription
```
public T withDescription(@Nullable
                         java.lang.String description)
```
  Set the description for the resource.
  
  Parameters:
  
  description - The description to use
  
  Returns:
  
  The builder
- withTags
```
public T withTags(@Nullable
                  java.util.Set<java.lang.String> tags)
```
  Set the tags to use for the resource.
  
  Parameters:
  
  tags - The tags to use
  
  Returns:
  
  The builder
- withMetadata
```
public T withMetadata(@Nullable
                      com.fasterxml.jackson.databind.JsonNode metadata)
```
  With the metadata to set for the job as a JsonNode.
  
  Parameters:
  
  metadata - The metadata to set
  
  Returns:
  
  The builder
- withMetadata
```
public T withMetadata(@Nullable
                      java.lang.String metadata)
               throws GeniePreconditionException
```
  With the metadata to set for the job as a string of valid JSON.
  
  Parameters:
  
  metadata - The metadata to set. Must be valid JSON
  
  Returns:
  
  The builder
  
  Throws:
  
  GeniePreconditionException - On invalid JSON