Package software.amazon.awssdk.services.emrcontainers.model

Class JobTemplate

java.lang.Object

software.amazon.awssdk.services.emrcontainers.model.JobTemplate

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<JobTemplate.Builder,JobTemplate>

@Generated("software.amazon.awssdk:codegen")
public final class JobTemplate
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<JobTemplate.Builder,JobTemplate>

This entity describes a job template. Job template stores values of StartJobRun API request in a template and can be used to start a job run. Job template allows two use cases: avoid repeating recurring StartJobRun API request values, enforcing certain values in StartJobRun API request.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	JobTemplate.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The ARN of the job template.
static JobTemplate.Builder	builder()
Instant	createdAt()	The date and time when the job template was created.
String	createdBy()	The user who created the job template.
String	decryptionError()	The error message in case the decryption of job template fails.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	id()	The ID of the job template.
JobTemplateData	jobTemplateData()	The job template data which holds values of StartJobRun API request.
String	kmsKeyArn()	The KMS key ARN used to encrypt the job template.
String	name()	The name of the job template.
List<SdkField<?>>	sdkFields()
static Class<? extends JobTemplate.Builder>	serializableBuilderClass()
Map<String,String>	tags()	The tags assigned to the job template.
JobTemplate.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final String name()

The name of the job template.

Returns:

The name of the job template.

id

public final String id()

The ID of the job template.

Returns:

The ID of the job template.

arn

public final String arn()

The ARN of the job template.

Returns:

The ARN of the job template.

createdAt

public final Instant createdAt()

The date and time when the job template was created.

Returns:

The date and time when the job template was created.

createdBy

public final String createdBy()

The user who created the job template.

Returns:

The user who created the job template.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final Map<String,String> tags()

The tags assigned to the job template.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

The tags assigned to the job template.

jobTemplateData

public final JobTemplateData jobTemplateData()

The job template data which holds values of StartJobRun API request.

Returns:

The job template data which holds values of StartJobRun API request.

kmsKeyArn

public final String kmsKeyArn()

The KMS key ARN used to encrypt the job template.

Returns:

The KMS key ARN used to encrypt the job template.

decryptionError

public final String decryptionError()

The error message in case the decryption of job template fails.

Returns:

The error message in case the decryption of job template fails.

toBuilder

public JobTemplate.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<JobTemplate.Builder,JobTemplate>

builder

public static JobTemplate.Builder builder()

serializableBuilderClass

public static Class<? extends JobTemplate.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo