Package software.amazon.awssdk.services.iot.model

Class DescribeManagedJobTemplateResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.iot.model.IotResponse
software.amazon.awssdk.services.iot.model.DescribeManagedJobTemplateResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeManagedJobTemplateResponse.Builder,DescribeManagedJobTemplateResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeManagedJobTemplateResponse extends IotResponse implements ToCopyableBuilder<DescribeManagedJobTemplateResponse.Builder,DescribeManagedJobTemplateResponse>

  • Method Details

    • templateName

      public final String templateName()

      The unique name of a managed template, such as AWS-Reboot.

      Returns:
      The unique name of a managed template, such as AWS-Reboot.

    • templateArn

      public final String templateArn()

      The unique Amazon Resource Name (ARN) of the managed template.

      Returns:
      The unique Amazon Resource Name (ARN) of the managed template.

    • description

      public final String description()

      The unique description of a managed template.

      Returns:
      The unique description of a managed template.

    • templateVersion

      public final String templateVersion()

      The version for a managed template.

      Returns:
      The version for a managed template.

    • hasEnvironments

      public final boolean hasEnvironments()
      For responses, this returns true if the service returned a value for the Environments 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.

    • environments

      public final List<String> environments()

      A list of environments that are supported with the managed 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 hasEnvironments() method.

      Returns:
      A list of environments that are supported with the managed job template.

    • hasDocumentParameters

      public final boolean hasDocumentParameters()
      For responses, this returns true if the service returned a value for the DocumentParameters 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.

    • documentParameters

      public final List<DocumentParameter> documentParameters()

      A map of key-value pairs that you can use as guidance to specify the inputs for creating a job from a managed template.

      documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.

      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 hasDocumentParameters() method.

      Returns:
      A map of key-value pairs that you can use as guidance to specify the inputs for creating a job from a managed template.

      documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.

    • document

      public final String document()

      The document schema for a managed job template.

      Returns:
      The document schema for a managed job template.

    • toBuilder

      public DescribeManagedJobTemplateResponse.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<DescribeManagedJobTemplateResponse.Builder,DescribeManagedJobTemplateResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeManagedJobTemplateResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.