Package com.oracle.bmc.resourcemanager.model

Class Job

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20180917")
public final class Job
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    The properties of a job.

    A job performs the actions that are defined in your Terraform configuration. For instructions on managing jobs, see Managing Jobs. For more information about jobs, see Key Concepts.
    Note: Objects should always be created or deserialized using the Job.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 Job.Builder, which maintain a set of all explicitly set fields called Job.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

      • builder

        public static Job.Builder builder()
        Create a new builder.

      • getId

        public String getId()
        The OCID of the job.
        Returns:
        the value

      • getStackId

        public String getStackId()
        The OCID of the stack that is associated with the job.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment in which the job’s associated stack resides.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        A user-friendly name.

        Does not have to be unique, and it’s changeable. Avoid entering confidential information.

        Returns:
        the value

      • getOperation

        public Job.Operation getOperation()
        The type of job executing.
        Returns:
        the value

      • getIsThirdPartyProviderExperienceEnabled

        public Boolean getIsThirdPartyProviderExperienceEnabled()
        When true, the stack sources third-party Terraform providers from Terraform Registry and allows customTerraformProvider.

        For more information about stack sourcing of third-party Terraform providers, see Third-party Provider Configuration.

        Returns:
        the value

      • getIsProviderUpgradeRequired

        public Boolean getIsProviderUpgradeRequired()
        Specifies whether or not to upgrade provider versions.

        Within the version constraints of your Terraform configuration, use the latest versions available from the source of Terraform providers. For more information about this option, see Dependency Lock File (terraform.io).

        Returns:
        the value

      • getResolvedPlanJobId

        public String getResolvedPlanJobId()
        Deprecated.

        Use the property executionPlanJobId in jobOperationDetails instead. The plan job OCID that was used (if this was an apply job and was not auto-approved).

        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time when the job was created.

        Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

        Returns:
        the value

      • getTimeFinished

        public Date getTimeFinished()
        The date and time when the job stopped running, irrespective of whether the job ran successfully.

        Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z

        Returns:
        the value

      • getLifecycleState

        public Job.LifecycleState getLifecycleState()
        Current state of the specified job.

        For more information about job lifecycle states in Resource Manager, see Key Concepts.

        Returns:
        the value

      • getWorkingDirectory

        public String getWorkingDirectory()
        File path to the directory to use for running Terraform.

        If not specified, the root directory is used. Required when using a zip Terraform configuration (configSourceType value of ZIP_UPLOAD) that contains folders. Ignored for the configSourceType value of COMPARTMENT_CONFIG_SOURCE. For more information about required and recommended file structure, see File Structure (Terraform Configurations for Resource Manager).

        Returns:
        the value

      • getVariables

        public Map<String,​String> getVariables()
        Terraform variables associated with this resource.

        Maximum number of variables supported is 250. The maximum size of each variable, including both name and value, is 8192 bytes. Example: {“CompartmentId”: “compartment-id-value”}

        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        Free-form tags associated with the resource.

        Each tag is a 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

      • getSystemTags

        public Map<String,​Map<String,​Object>> getSystemTags()
        The system tags associated with this resource, if any.

        The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: 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