@Generated(value="software.amazon.awssdk:codegen") public final class CreateOtaUpdateRequest extends IotRequest implements ToCopyableBuilder<CreateOtaUpdateRequest.Builder,CreateOtaUpdateRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateOtaUpdateRequest.Builder |
Modifier and Type | Method and Description |
---|---|
Map<String,String> |
additionalParameters()
A list of additional OTA update parameters which are name-value pairs.
|
AwsJobAbortConfig |
awsJobAbortConfig()
The criteria that determine when and how a job abort takes place.
|
AwsJobExecutionsRolloutConfig |
awsJobExecutionsRolloutConfig()
Configuration for the rollout of OTA updates.
|
AwsJobPresignedUrlConfig |
awsJobPresignedUrlConfig()
Configuration information for pre-signed URLs.
|
AwsJobTimeoutConfig |
awsJobTimeoutConfig()
Specifies the amount of time each device has to finish its execution of the job.
|
static CreateOtaUpdateRequest.Builder |
builder() |
String |
description()
The description of the OTA update.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
List<OTAUpdateFile> |
files()
The files to be streamed by the OTA update.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
boolean |
hasAdditionalParameters()
Returns true if the AdditionalParameters property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasFiles()
Returns true if the Files property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
int |
hashCode() |
boolean |
hasProtocols()
Returns true if the Protocols property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
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).
|
boolean |
hasTargets()
Returns true if the Targets 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 |
otaUpdateId()
The ID of the OTA update to be created.
|
List<Protocol> |
protocols()
The protocol used to transfer the OTA update image.
|
List<String> |
protocolsAsStrings()
The protocol used to transfer the OTA update image.
|
String |
roleArn()
The IAM role that grants AWS IoT access to the Amazon S3, AWS IoT jobs and AWS Code Signing resources to create
an OTA update job.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateOtaUpdateRequest.Builder> |
serializableBuilderClass() |
List<Tag> |
tags()
Metadata which can be used to manage updates.
|
List<String> |
targets()
The devices targeted to receive OTA updates.
|
TargetSelection |
targetSelection()
Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things
specified as targets have completed the update (SNAPSHOT).
|
String |
targetSelectionAsString()
Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things
specified as targets have completed the update (SNAPSHOT).
|
CreateOtaUpdateRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
copy
public final String otaUpdateId()
The ID of the OTA update to be created.
public final String description()
The description of the OTA update.
public final boolean hasTargets()
public final List<String> targets()
The devices targeted to receive OTA updates.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasTargets()
to see if a value was sent in this field.
public final List<Protocol> protocols()
The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasProtocols()
to see if a value was sent in this field.
public final boolean hasProtocols()
public final List<String> protocolsAsStrings()
The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasProtocols()
to see if a value was sent in this field.
public final TargetSelection targetSelection()
Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.
If the service returns an enum value that is not available in the current SDK version, targetSelection
will return TargetSelection.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from targetSelectionAsString()
.
TargetSelection
public final String targetSelectionAsString()
Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.
If the service returns an enum value that is not available in the current SDK version, targetSelection
will return TargetSelection.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from targetSelectionAsString()
.
TargetSelection
public final AwsJobExecutionsRolloutConfig awsJobExecutionsRolloutConfig()
Configuration for the rollout of OTA updates.
public final AwsJobPresignedUrlConfig awsJobPresignedUrlConfig()
Configuration information for pre-signed URLs.
public final AwsJobAbortConfig awsJobAbortConfig()
The criteria that determine when and how a job abort takes place.
public final AwsJobTimeoutConfig awsJobTimeoutConfig()
Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job
execution status is set to IN_PROGRESS
. If the job execution status is not set to another terminal
state before the timer expires, it will be automatically set to TIMED_OUT
.
IN_PROGRESS
. If the job execution status is not set to
another terminal state before the timer expires, it will be automatically set to TIMED_OUT
.public final boolean hasFiles()
public final List<OTAUpdateFile> files()
The files to be streamed by the OTA update.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasFiles()
to see if a value was sent in this field.
public final String roleArn()
The IAM role that grants AWS IoT access to the Amazon S3, AWS IoT jobs and AWS Code Signing resources to create an OTA update job.
public final boolean hasAdditionalParameters()
public final Map<String,String> additionalParameters()
A list of additional OTA update parameters which are name-value pairs.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasAdditionalParameters()
to see if a value was sent in this field.
public final boolean hasTags()
public final List<Tag> tags()
Metadata which can be used to manage updates.
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.
public CreateOtaUpdateRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateOtaUpdateRequest.Builder,CreateOtaUpdateRequest>
toBuilder
in class IotRequest
public static CreateOtaUpdateRequest.Builder builder()
public static Class<? extends CreateOtaUpdateRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.