@Generated(value="software.amazon.awssdk:codegen") public final class CreateJobTemplateRequest extends IotRequest implements ToCopyableBuilder<CreateJobTemplateRequest.Builder,CreateJobTemplateRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateJobTemplateRequest.Builder |
| 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()
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.
|
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.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String jobTemplateId()
A unique identifier for the job template. We recommend using a UUID. Alpha-numeric characters, "-", and "_" are valid for use here.
public final String jobArn()
The ARN of the job to use as the basis for the job template.
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.
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.
public final String document()
The job document. Required if you don't specify a value for documentSource.
documentSource.public final String description()
A description of the job document.
public final PresignedUrlConfig presignedUrlConfig()
public final JobExecutionsRolloutConfig jobExecutionsRolloutConfig()
public final AbortConfig abortConfig()
public final TimeoutConfig timeoutConfig()
public final boolean hasTags()
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.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.
public final JobExecutionsRetryConfig jobExecutionsRetryConfig()
Allows you to create the criteria to retry a job.
public CreateJobTemplateRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateJobTemplateRequest.Builder,CreateJobTemplateRequest>toBuilder in class IotRequestpublic static CreateJobTemplateRequest.Builder builder()
public static Class<? extends CreateJobTemplateRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2022. All rights reserved.