Package com.oracle.bmc.batch.model

Class CreateBatchJobDetails

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20251031")
public final class CreateBatchJobDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    The data to create a batch job.

    If the value for a collection is absent or is explicitly provided as null, it will be converted to an empty value, i.e. “[]” or “{}” in json notation. This applies to nested collections as well.
    Note: Objects should always be created or deserialized using the CreateBatchJobDetails.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 CreateBatchJobDetails.Builder, which maintain a set of all explicitly set fields called CreateBatchJobDetails.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

      • getCompartmentId

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

      • getBatchJobPoolId

        public String getBatchJobPoolId()
        The OCID of the parent batch job pool.
        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 will 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: batchjob20250914115623.

        Returns:
        the value

      • getDescription

        public String getDescription()
        An optional description that provides additional context next to the displayName.
        Returns:
        the value

      • getEnvironmentVariables

        public List<EnvironmentVariable> getEnvironmentVariables()
        An environment variables to use for the job’s tasks (can be overridden by task’s environment variables).
        Returns:
        the value

      • getTasks

        public List<CreateBatchTaskDetails> getTasks()
        A list of tasks to be executed within this job.

        Maximum number of tasks a job can have in total, across all nested levels, is 1000.

        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

      • 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

      • 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