Class CreateOtaTaskRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.iotmanagedintegrations.model.IotManagedIntegrationsRequest
software.amazon.awssdk.services.iotmanagedintegrations.model.CreateOtaTaskRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateOtaTaskRequest.Builder,CreateOtaTaskRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateOtaTaskRequest extends IotManagedIntegrationsRequest implements ToCopyableBuilder<CreateOtaTaskRequest.Builder,CreateOtaTaskRequest>

  • Method Details

    • description

      public final String description()

      The description of the over-the-air (OTA) task.

      Returns:
      The description of the over-the-air (OTA) task.

    • s3Url

      public final String s3Url()

      The URL to the Amazon S3 bucket where the over-the-air (OTA) task is stored.

      Returns:
      The URL to the Amazon S3 bucket where the over-the-air (OTA) task is stored.

    • protocol

      public final OtaProtocol protocol()

      The connection protocol the over-the-air (OTA) task uses to update the device.

      If the service returns an enum value that is not available in the current SDK version, protocol will return OtaProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().

      Returns:
      The connection protocol the over-the-air (OTA) task uses to update the device.
      See Also:

    • protocolAsString

      public final String protocolAsString()

      The connection protocol the over-the-air (OTA) task uses to update the device.

      If the service returns an enum value that is not available in the current SDK version, protocol will return OtaProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().

      Returns:
      The connection protocol the over-the-air (OTA) task uses to update the device.
      See Also:

    • hasTarget

      public final boolean hasTarget()
      For responses, this returns true if the service returned a value for the Target 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.

    • target

      public final List<String> target()

      The device targeted for the over-the-air (OTA) task.

      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 hasTarget() method.

      Returns:
      The device targeted for the over-the-air (OTA) task.

    • taskConfigurationId

      public final String taskConfigurationId()

      The identifier for the over-the-air (OTA) task configuration.

      Returns:
      The identifier for the over-the-air (OTA) task configuration.

    • otaMechanism

      public final OtaMechanism otaMechanism()

      The deployment mechanism for the over-the-air (OTA) task.

      If the service returns an enum value that is not available in the current SDK version, otaMechanism will return OtaMechanism.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from otaMechanismAsString().

      Returns:
      The deployment mechanism for the over-the-air (OTA) task.
      See Also:

    • otaMechanismAsString

      public final String otaMechanismAsString()

      The deployment mechanism for the over-the-air (OTA) task.

      If the service returns an enum value that is not available in the current SDK version, otaMechanism will return OtaMechanism.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from otaMechanismAsString().

      Returns:
      The deployment mechanism for the over-the-air (OTA) task.
      See Also:

    • otaType

      public final OtaType otaType()

      The frequency type for the over-the-air (OTA) task.

      If the service returns an enum value that is not available in the current SDK version, otaType will return OtaType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from otaTypeAsString().

      Returns:
      The frequency type for the over-the-air (OTA) task.
      See Also:

    • otaTypeAsString

      public final String otaTypeAsString()

      The frequency type for the over-the-air (OTA) task.

      If the service returns an enum value that is not available in the current SDK version, otaType will return OtaType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from otaTypeAsString().

      Returns:
      The frequency type for the over-the-air (OTA) task.
      See Also:

    • otaTargetQueryString

      public final String otaTargetQueryString()

      The query string to add things to the thing group.

      Returns:
      The query string to add things to the thing group.

    • clientToken

      public final String clientToken()

      An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

      Returns:
      An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

    • otaSchedulingConfig

      public final OtaTaskSchedulingConfig otaSchedulingConfig()
      Returns the value of the OtaSchedulingConfig property for this object.
      Returns:
      The value of the OtaSchedulingConfig property for this object.

    • otaTaskExecutionRetryConfig

      public final OtaTaskExecutionRetryConfig otaTaskExecutionRetryConfig()
      Returns the value of the OtaTaskExecutionRetryConfig property for this object.
      Returns:
      The value of the OtaTaskExecutionRetryConfig property for this object.

    • 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 Map<String,String> tags()

      A set of key/value pairs that are used to manage the over-the-air (OTA) task.

      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:
      A set of key/value pairs that are used to manage the over-the-air (OTA) task.

    • toBuilder

      public CreateOtaTaskRequest.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<CreateOtaTaskRequest.Builder,CreateOtaTaskRequest>
      Specified by:
      toBuilder in class IotManagedIntegrationsRequest
      Returns:
      a builder for type T

    • builder

      public static CreateOtaTaskRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateOtaTaskRequest.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an 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.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      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 final 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.