Package software.amazon.awssdk.services.batch.model

Interface TaskContainerOverrides.Builder

    • Method Detail

      • command

        TaskContainerOverrides.Builder command​(Collection<String> command)

        The command to send to the container that overrides the default command from the Docker image or the job definition.

        This parameter can't contain an empty string.

        Parameters:
        command - The command to send to the container that overrides the default command from the Docker image or the job definition.

        This parameter can't contain an empty string.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • command

        TaskContainerOverrides.Builder command​(String... command)

        The command to send to the container that overrides the default command from the Docker image or the job definition.

        This parameter can't contain an empty string.

        Parameters:
        command - The command to send to the container that overrides the default command from the Docker image or the job definition.

        This parameter can't contain an empty string.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • environment

        TaskContainerOverrides.Builder environment​(Collection<KeyValuePair> 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 job definition.

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

        Parameters:
        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 job definition.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • environment

        TaskContainerOverrides.Builder environment​(KeyValuePair... 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 job definition.

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

        Parameters:
        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 job definition.

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

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • environment

        TaskContainerOverrides.Builder environment​(Consumer<KeyValuePair.Builder>... 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 job definition.

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

        This is a convenience method that creates an instance of the KeyValuePair.Builder avoiding the need to create one manually via KeyValuePair.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #environment(List).

        Parameters:
        environment - a consumer that will call methods on KeyValuePair.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #environment(java.util.Collection)

      • name

        TaskContainerOverrides.Builder name​(String name)

        A pointer to the container that you want to override. The container's name provides a unique identifier for the container being used.

        Parameters:
        name - A pointer to the container that you want to override. The container's name provides a unique identifier for the container being used.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • resourceRequirements

        TaskContainerOverrides.Builder resourceRequirements​(Collection<ResourceRequirement> resourceRequirements)

        The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include GPU, MEMORY, and VCPU.

        Parameters:
        resourceRequirements - The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include GPU, MEMORY, and VCPU.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • resourceRequirements

        TaskContainerOverrides.Builder resourceRequirements​(ResourceRequirement... resourceRequirements)

        The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include GPU, MEMORY, and VCPU.

        Parameters:
        resourceRequirements - The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include GPU, MEMORY, and VCPU.
        Returns:
        Returns a reference to this object so that method calls can be chained together.