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

Class CreateJobTemplateRequest

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

  • Method Details

    • jobTemplateId

      public final String jobTemplateId()

      A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.

      Returns:
      A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.

    • jobArn

      public final String jobArn()

      The ARN of the job to use as the basis for the job template.

      Returns:
      The ARN of the job to use as the basis for the job template.

    • documentSource

      public final String documentSource()

      An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document.

      For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0

      For more information, see Methods for accessing a bucket.

      Returns:
      An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document.

      For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0

      For more information, see Methods for accessing a bucket.

    • document

      public final String document()

      The job document. Required if you don't specify a value for documentSource.

      Returns:
      The job document. Required if you don't specify a value for documentSource.

    • description

      public final String description()

      A description of the job document.

      Returns:
      A description of the job document.

    • presignedUrlConfig

      public final PresignedUrlConfig presignedUrlConfig()
      Returns the value of the PresignedUrlConfig property for this object.
      Returns:
      The value of the PresignedUrlConfig property for this object.

    • jobExecutionsRolloutConfig

      public final JobExecutionsRolloutConfig jobExecutionsRolloutConfig()
      Returns the value of the JobExecutionsRolloutConfig property for this object.
      Returns:
      The value of the JobExecutionsRolloutConfig property for this object.

    • abortConfig

      public final AbortConfig abortConfig()
      Returns the value of the AbortConfig property for this object.
      Returns:
      The value of the AbortConfig property for this object.

    • timeoutConfig

      public final TimeoutConfig timeoutConfig()
      Returns the value of the TimeoutConfig property for this object.
      Returns:
      The value of the TimeoutConfig property for this object.

    • 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 List<Tag> tags()

      Metadata that can be used to manage 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:
      Metadata that can be used to manage the job template.

    • jobExecutionsRetryConfig

      public final JobExecutionsRetryConfig jobExecutionsRetryConfig()

      Allows you to create the criteria to retry a job.

      Returns:
      Allows you to create the criteria to retry a job.

    • hasMaintenanceWindows

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

    • maintenanceWindows

      public final List<MaintenanceWindow> maintenanceWindows()

      Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.

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

      Returns:
      Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.

    • hasDestinationPackageVersions

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

    • destinationPackageVersions

      public final List<String> destinationPackageVersions()

      The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

      Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

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

      Returns:
      The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

      Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

    • toBuilder

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

    • builder

      public static CreateJobTemplateRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.