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:

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<JobTemplate.Builder,JobTemplate>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.