CreateOtaUpdateRequest (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.CreateOtaUpdateRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateOtaUpdateRequest.Builder,CreateOtaUpdateRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateOtaUpdateRequest
extends IotRequest
implements ToCopyableBuilder<CreateOtaUpdateRequest.Builder,CreateOtaUpdateRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateOtaUpdateRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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)`
`List<OTAUpdateFile>`	`files()` The files to be streamed by the OTA update.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAdditionalParameters()` For responses, this returns true if the service returned a value for the AdditionalParameters property.
`boolean`	`hasFiles()` For responses, this returns true if the service returned a value for the Files property.
`int`	`hashCode()`
`boolean`	`hasProtocols()` For responses, this returns true if the service returned a value for the Protocols property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`boolean`	`hasTargets()` For responses, this returns true if the service returned a value for the Targets property.
`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 Amazon Web Services IoT Core access to the Amazon S3, IoT jobs and Amazon Web Services 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()`
`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
  - otaUpdateId
```
public final String otaUpdateId()
```
    The ID of the OTA update to be created.
    
    Returns:
    
    The ID of the OTA update to be created.
  - description
```
public final String description()
```
    The description of the OTA update.
    
    Returns:
    
    The description of the OTA update.
  - hasTargets
```
public final boolean hasTargets()
```
    For responses, this returns true if the service returned a value for the Targets 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.
  - targets
```
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.
    
    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 hasTargets() method.
    
    Returns:
    
    The devices targeted to receive OTA updates.
  - protocols
```
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.
    
    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 hasProtocols() method.
    
    Returns:
    
    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.
  - hasProtocols
```
public final boolean hasProtocols()
```
    For responses, this returns true if the service returned a value for the Protocols 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.
  - protocolsAsStrings
```
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.
    
    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 hasProtocols() method.
    
    Returns:
    
    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.
  - targetSelection
```
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().
    
    Returns:
    
    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.
    
    See Also:
    
    TargetSelection
  - targetSelectionAsString
```
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().
    
    Returns:
    
    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.
    
    See Also:
    
    TargetSelection
  - awsJobExecutionsRolloutConfig
```
public final AwsJobExecutionsRolloutConfig awsJobExecutionsRolloutConfig()
```
    Configuration for the rollout of OTA updates.
    
    Returns:
    
    Configuration for the rollout of OTA updates.
  - awsJobPresignedUrlConfig
```
public final AwsJobPresignedUrlConfig awsJobPresignedUrlConfig()
```
    Configuration information for pre-signed URLs.
    
    Returns:
    
    Configuration information for pre-signed URLs.
  - awsJobAbortConfig
```
public final AwsJobAbortConfig awsJobAbortConfig()
```
    The criteria that determine when and how a job abort takes place.
    
    Returns:
    
    The criteria that determine when and how a job abort takes place.
  - awsJobTimeoutConfig
```
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.
    
    Returns:
    
    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.
  - hasFiles
```
public final boolean hasFiles()
```
    For responses, this returns true if the service returned a value for the Files 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.
  - files
```
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.
    
    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 hasFiles() method.
    
    Returns:
    
    The files to be streamed by the OTA update.
  - roleArn
```
public final String roleArn()
```
    The IAM role that grants Amazon Web Services IoT Core access to the Amazon S3, IoT jobs and Amazon Web Services Code Signing resources to create an OTA update job.
    
    Returns:
    
    The IAM role that grants Amazon Web Services IoT Core access to the Amazon S3, IoT jobs and Amazon Web Services Code Signing resources to create an OTA update job.
  - hasAdditionalParameters
```
public final boolean hasAdditionalParameters()
```
    For responses, this returns true if the service returned a value for the AdditionalParameters 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.
  - additionalParameters
```
public final Map<String,String> additionalParameters()
```
    A list of additional OTA update parameters, which are name-value pairs. They won't be sent to devices as a part of the Job document.
    
    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 hasAdditionalParameters() method.
    
    Returns:
    
    A list of additional OTA update parameters, which are name-value pairs. They won't be sent to devices as a part of the Job document.
  - 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 which can be used to manage updates.
    
    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 which can be used to manage updates.
  - toBuilder
```
public CreateOtaUpdateRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateOtaUpdateRequest.Builder,CreateOtaUpdateRequest>
    
    Specified by:
    
    toBuilder in class IotRequest
  - builder
```
public static CreateOtaUpdateRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateOtaUpdateRequest.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 CreateOtaUpdateRequest

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

otaUpdateId

description

hasTargets

targets

protocols

hasProtocols

protocolsAsStrings

targetSelection

targetSelectionAsString

awsJobExecutionsRolloutConfig

awsJobPresignedUrlConfig

awsJobAbortConfig

awsJobTimeoutConfig

hasFiles

files

roleArn

hasAdditionalParameters

additionalParameters

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields