Package com.oracle.bmc.batch.model

Class BatchTaskEnvironment

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20251031")
public final class BatchTaskEnvironment
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A batch task environment resource defines the software that is used to execute tasks.

    It mainly contains a URL to a container image along with other configurations that are needed by the image.

    To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).
    Note: Objects should always be created or deserialized using the BatchTaskEnvironment.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the BatchTaskEnvironment.Builder, which maintain a set of all explicitly set fields called BatchTaskEnvironment.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getId

        public String getId()
        The OCID of the batch task environment.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        A user-friendly name.

        Does not have to be unique, and it’s changeable. If not specified or provided as null or empty string, it be generated as “”, where timeCreated corresponds with the resource creation time in ISO 8601 basic format, i.e. omitting separating punctuation, at second-level precision and no UTC offset. Example: batchtaskenvironment20250914115623.

        Returns:
        the value

      • getDescription

        public String getDescription()
        The batch task environment description.
        Returns:
        the value

      • getImageUrl

        public String getImageUrl()
        The URL of the ocir image.
        Returns:
        the value

      • getWorkingDirectory

        public String getWorkingDirectory()
        Container’s working directory.
        Returns:
        the value

      • getVolumes

        public List<BatchTaskEnvironmentVolume> getVolumes()
        List of volumes attached to the image.

        The use cases of the volumes are but not limited to: read the input of the task and write the output.

        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the batch task environment was created, in the format defined by RFC 3339.

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The date and time the batch task environment was updated, in the format defined by RFC 3339.

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

        Example: {"Operations": {"CostCenter": "42"}}

        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        Free-form tags for this resource.

        Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

        Example: {"Department": "Finance"}

        Returns:
        the value

      • getSystemTags

        public Map<String,​Map<String,​Object>> getSystemTags()
        System tags for this resource.

        Each key is predefined and scoped to a namespace.

        Example: {"orcl-cloud": {"free-tier-retained": "true"}}

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel