Class ContainerDatasetAction

java.lang.Object
software.amazon.awssdk.services.iotanalytics.model.ContainerDatasetAction
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ContainerDatasetAction.Builder,ContainerDatasetAction>
@Generated("software.amazon.awssdk:codegen") public final class ContainerDatasetAction extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ContainerDatasetAction.Builder,ContainerDatasetAction>

Information required to run the containerAction to produce dataset contents.

See Also:

  • Method Details

    • image

      public final String image()

      The ARN of the Docker container stored in your account. The Docker container contains an application and required support libraries and is used to generate dataset contents.

      Returns:
      The ARN of the Docker container stored in your account. The Docker container contains an application and required support libraries and is used to generate dataset contents.

    • executionRoleArn

      public final String executionRoleArn()

      The ARN of the role that gives permission to the system to access required resources to run the containerAction. This includes, at minimum, permission to retrieve the dataset contents that are the input to the containerized application.

      Returns:
      The ARN of the role that gives permission to the system to access required resources to run the containerAction. This includes, at minimum, permission to retrieve the dataset contents that are the input to the containerized application.

    • resourceConfiguration

      public final ResourceConfiguration resourceConfiguration()

      Configuration of the resource that executes the containerAction.

      Returns:
      Configuration of the resource that executes the containerAction.

    • hasVariables

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

    • variables

      public final List<Variable> variables()

      The values of variables used in the context of the execution of the containerized application (basically, parameters passed to the application). Each variable must have a name and a value given by one of stringValue, datasetContentVersionValue, or outputFileUriValue.

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

      Returns:
      The values of variables used in the context of the execution of the containerized application (basically, parameters passed to the application). Each variable must have a name and a value given by one of stringValue, datasetContentVersionValue, or outputFileUriValue.

    • toBuilder

      public ContainerDatasetAction.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<ContainerDatasetAction.Builder,ContainerDatasetAction>
      Returns:
      a builder for type T

    • builder

      public static ContainerDatasetAction.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ContainerDatasetAction.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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