Package software.amazon.awssdk.services.pipes.model

Class EcsContainerOverride

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

The overrides that are sent to a container. An empty container override can be passed in. An example of an empty container override is {"containerOverrides": [ ] }. If a non-empty container override is specified, the name parameter must be included.

See Also:

  • Method Details

    • 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 send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.

      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 send to the container that overrides the default command from the Docker image or the task definition. You must also specify a container name.

    • cpu

      public final Integer cpu()

      The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.

      Returns:
      The number of cpu units reserved for the container, instead of the default value from the task definition. You must also specify a container name.

    • hasEnvironment

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

    • environment

      public final List<EcsEnvironmentVariable> environment()

      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. You must also specify a container name.

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

      Returns:
      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. You must also specify a container name.

    • hasEnvironmentFiles

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

    • environmentFiles

      public final List<EcsEnvironmentFile> environmentFiles()

      A list of files containing the environment variables to pass to a container, instead of the value from the container definition.

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

      Returns:
      A list of files containing the environment variables to pass to a container, instead of the value from the container definition.

    • memory

      public final Integer memory()

      The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.

      Returns:
      The hard limit (in MiB) of memory to present to the container, instead of the default value from the task definition. If your container attempts to exceed the memory specified here, the container is killed. You must also specify a container name.

    • memoryReservation

      public final Integer memoryReservation()

      The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.

      Returns:
      The soft limit (in MiB) of memory to reserve for the container, instead of the default value from the task definition. You must also specify a container name.

    • name

      public final String name()

      The name of the container that receives the override. This parameter is required if any override is specified.

      Returns:
      The name of the container that receives the override. This parameter is required if any override is specified.

    • hasResourceRequirements

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

    • resourceRequirements

      public final List<EcsResourceRequirement> resourceRequirements()

      The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.

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

      Returns:
      The type and amount of a resource to assign to a container, instead of the default value from the task definition. The only supported resource is a GPU.

    • toBuilder

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

    • builder

      public static EcsContainerOverride.Builder builder()

    • serializableBuilderClass

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