Class ContainerTaskConfiguration

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

Configuration for a container task, including the container image, IAM role, and compute settings.

See Also:

  • Method Details

    • ecrUri

      public final String ecrUri()

      The Amazon ECR image URI for the task container.

      Returns:
      The Amazon ECR image URI for the task container.

    • taskExecutionRole

      public final String taskExecutionRole()

      The ARN of the IAM role that grants the containerized workload permissions to access AWS resources.

      Returns:
      The ARN of the IAM role that grants the containerized workload permissions to access AWS resources.

    • processingType

      public final ProcessingType processingType()

      The processing type for compute resources.

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

      Returns:
      The processing type for compute resources.
      See Also:

    • processingTypeAsString

      public final String processingTypeAsString()

      The processing type for compute resources.

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

      Returns:
      The processing type for compute resources.
      See Also:

    • processingUnit

      public final ProcessingUnit processingUnit()

      The processing unit allocation that determines the vCPU, memory, and GPU resources.

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

      Returns:
      The processing unit allocation that determines the vCPU, memory, and GPU resources.
      See Also:

    • processingUnitAsString

      public final String processingUnitAsString()

      The processing unit allocation that determines the vCPU, memory, and GPU resources.

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

      Returns:
      The processing unit allocation that determines the vCPU, memory, and GPU resources.
      See Also:

    • hasCommand

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

    • command

      public final List<String> command()

      The command to execute in the container.

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

      Returns:
      The command to execute in the container.

    • timeoutSeconds

      public final Long timeoutSeconds()

      The timeout in seconds for task execution. Default: 3600 (1 hour).

      Returns:
      The timeout in seconds for task execution. Default: 3600 (1 hour).

    • hasEnvironmentVariables

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

    • environmentVariables

      public final Map<String,String> environmentVariables()

      Environment variables passed to the container at runtime.

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

      Returns:
      Environment variables passed to the container at runtime.

    • toBuilder

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

    • builder

      public static ContainerTaskConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ContainerTaskConfiguration.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.