CreateJobTemplateRequest (AWS Java SDK :: Services

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(value="software.amazon.awssdk:codegen")
public final class CreateJobTemplateRequest
extends IotRequest
implements ToCopyableBuilder<CreateJobTemplateRequest.Builder,CreateJobTemplateRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateJobTemplateRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateJobTemplateRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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.
`String`	`document()` The job document.
`String`	`documentSource()` An S3 link to the job document to use in the template.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`jobArn()` The ARN of the job to use as the basis for the job template.
`JobExecutionsRolloutConfig`	`jobExecutionsRolloutConfig()` Returns the value of the JobExecutionsRolloutConfig property for this object.
`String`	`jobTemplateId()` A unique identifier for the job template.
`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 to the job document to use in the template. Required if you don't specify a value for document.
    
    If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.
    
    The placeholder link is of the following form:
    
    ${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}
    
    where bucket is your bucket name and key is the object in the bucket to which you are linking.
    
    Returns:
    
    An S3 link to the job document to use in the template. Required if you don't specify a value for document.
    
    If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document.
    
    The placeholder link is of the following form:
    
    ${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key}
    
    where bucket is your bucket name and key is the object in the bucket to which you are linking.
  - 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()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    Metadata that can be used to manage the job template.
  - 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

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields