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>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateJobTemplateRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AbortConfig`	`abortConfig()`	Returns the value of the AbortConfig property for this object.
`static CreateJobTemplateRequest.Builder`	`builder()`
`String`	`description()`	A description of the job document.
`List<String>`	`destinationPackageVersions()`	The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes.
`String`	`document()`	The job document.
`String`	`documentSource()`	An S3 link, or S3 object URL, to the job document.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasDestinationPackageVersions()`	For responses, this returns true if the service returned a value for the DestinationPackageVersions property.
`int`	`hashCode()`
`boolean`	`hasMaintenanceWindows()`	For responses, this returns true if the service returned a value for the MaintenanceWindows property.
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`String`	`jobArn()`	The ARN of the job to use as the basis for the job template.
`JobExecutionsRetryConfig`	`jobExecutionsRetryConfig()`	Allows you to create the criteria to retry a job.
`JobExecutionsRolloutConfig`	`jobExecutionsRolloutConfig()`	Returns the value of the JobExecutionsRolloutConfig property for this object.
`String`	`jobTemplateId()`	A unique identifier for the job template.
`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.
`PresignedUrlConfig`	`presignedUrlConfig()`	Returns the value of the PresignedUrlConfig property for this object.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateJobTemplateRequest.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()`	Metadata that can be used to manage the job template.
`TimeoutConfig`	`timeoutConfig()`	Returns the value of the TimeoutConfig property for this object.
`CreateJobTemplateRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - 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.
    
    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.
    
    Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.
  - toBuilder
```
public CreateJobTemplateRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateJobTemplateRequest.Builder,CreateJobTemplateRequest>
    
    Specified by:
    
    toBuilder in class IotRequest
  - 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)
```
    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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateJobTemplateRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

jobTemplateId

jobArn

documentSource

document

description

presignedUrlConfig

jobExecutionsRolloutConfig

abortConfig

timeoutConfig

hasTags

tags

jobExecutionsRetryConfig

hasMaintenanceWindows

maintenanceWindows

hasDestinationPackageVersions

destinationPackageVersions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields