Class BatchEnvironmentVariable

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

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the task definition.

Environment variables cannot start with "Batch". This naming convention is reserved for variables that Batch sets.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the key-value pair. For environment variables, this is the name of the environment variable.

      Returns:
      The name of the key-value pair. For environment variables, this is the name of the environment variable.

    • value

      public final String value()

      The value of the key-value pair. For environment variables, this is the value of the environment variable.

      Returns:
      The value of the key-value pair. For environment variables, this is the value of the environment variable.

    • toBuilder

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

    • builder

      public static BatchEnvironmentVariable.Builder builder()

    • serializableBuilderClass

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