CreateOtaUpdateRequest (AWS SDK for Java

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.
`static CreateOtaUpdateRequest.Builder`	`builder()`
`String`	`description()` The description of the OTA update.
`boolean`	`equals(Object obj)`
`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`.
`int`	`hashCode()`
`String`	`otaUpdateId()` The ID of the OTA update to be created.
`String`	`roleArn()` The IAM role that allows access to the AWS IoT Jobs service.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateOtaUpdateRequest.Builder>`	`serializableBuilderClass()`
`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()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
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.
  - 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.
    
    Returns:
    
    The targeted devices to receive OTA updates.
  - 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.
  - 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.
    
    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.
  - 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.
    
    Returns:
    
    A list of additional OTA update parameters which are name-value pairs.
  - toBuilder
```
public CreateOtaUpdateRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateOtaUpdateRequest.Builder,CreateOtaUpdateRequest>
    
    Specified by:
    
    toBuilder in class IotRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static CreateOtaUpdateRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateOtaUpdateRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends 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.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

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

targets

targetSelection

targetSelectionAsString

awsJobExecutionsRolloutConfig

files

roleArn

additionalParameters

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields