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.
`AwsJobExecutionsRolloutConfig`	`awsJobExecutionsRolloutConfig()` Configuration for the rollout of OTA updates.
`AwsJobPresignedUrlConfig`	`awsJobPresignedUrlConfig()` Configuration information for pre-signed URLs.
`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()` 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 allows access to the AWS IoT Jobs service.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateOtaUpdateRequest.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()` Metadata which can be used to manage updates.
`List<String>`	`targets()` The targeted devices 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 String otaUpdateId()
```
    The ID of the OTA update to be created.
    
    Returns:
    
    The ID of the OTA update to be created.
  - description
```
public String description()
```
    The description of the OTA update.
    
    Returns:
    
    The description of the OTA update.
  - hasTargets
```
public 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). For responses returned by the SDK, the sender is the AWS service.
  - targets
```
public List<String> targets()
```
    The targeted devices 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.
    
    Returns:
    
    The targeted devices to receive OTA updates.
  - protocols
```
public 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.
    
    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 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). For responses returned by the SDK, the sender is the AWS service.
  - protocolsAsStrings
```
public 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.
    
    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 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 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 AwsJobExecutionsRolloutConfig awsJobExecutionsRolloutConfig()
```
    Configuration for the rollout of OTA updates.
    
    Returns:
    
    Configuration for the rollout of OTA updates.
  - awsJobPresignedUrlConfig
```
public AwsJobPresignedUrlConfig awsJobPresignedUrlConfig()
```
    Configuration information for pre-signed URLs.
    
    Returns:
    
    Configuration information for pre-signed URLs.
  - hasFiles
```
public 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). For responses returned by the SDK, the sender is the AWS service.
  - files
```
public 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.
    
    Returns:
    
    The files to be streamed by the OTA update.
  - roleArn
```
public String roleArn()
```
    The IAM role that allows access to the AWS IoT Jobs service.
    
    Returns:
    
    The IAM role that allows access to the AWS IoT Jobs service.
  - hasAdditionalParameters
```
public 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). For responses returned by the SDK, the sender is the AWS service.
  - additionalParameters
```
public 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.
    
    Returns:
    
    A list of additional OTA update parameters which are name-value pairs.
  - hasTags
```
public 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 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.
    
    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 int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public 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

hasFiles

files

roleArn

hasAdditionalParameters

additionalParameters

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields