Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Job

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.

Properties

Optional applyJobPlanResolution

applyJobPlanResolution: model.ApplyJobPlanResolution

Optional cancellationDetails

cancellationDetails: model.CancellationDetails

Optional compartmentId

compartmentId: undefined | string

The OCID of the compartment in which the job's associated stack resides.

Optional configSource

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {@code {"Operations": {"CostCenter": "42"}}}

Optional displayName

displayName: undefined | string

The job's display name.

Optional failureDetails

failureDetails: model.FailureDetails

Optional freeformTags

freeformTags: undefined | object

Free-form tags associated with this resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {@code {"Department": "Finance"}}

Optional id

id: undefined | string

The OCID of the job.

Optional isProviderUpgradeRequired

isProviderUpgradeRequired: undefined | false | true

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).

Optional isThirdPartyProviderExperienceEnabled

isThirdPartyProviderExperienceEnabled: undefined | false | true

When {@code true}, the stack sources third-party Terraform providers from Terraform Registry and allows {@link #customTerraformProvider(CustomTerraformProviderRequest) customTerraformProvider}. For more information about stack sourcing of third-party Terraform providers, see Third-party Provider Configuration.

Optional jobOperationDetails

Optional lifecycleState

lifecycleState: LifecycleState

Current state of the specified job. For more information about job lifecycle states in Resource Manager, see Key Concepts.

Optional operation

operation: Operation

The type of job executing.

Optional resolvedPlanJobId

resolvedPlanJobId: undefined | string

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

Optional stackId

stackId: undefined | string

The OCID of the stack that is associated with the job.

Optional timeCreated

timeCreated: Date

The date and time when the job was created. Format is defined by RFC3339. Example: {@code 2020-01-25T21:10:29.600Z}

Optional timeFinished

timeFinished: Date

The date and time when the job stopped running, irrespective of whether the job ran successfully. Format is defined by RFC3339. Example: {@code 2020-01-25T21:10:29.600Z}

Optional variables

variables: undefined | object

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: {@code {"CompartmentId": "compartment-id-value"}}

Optional workingDirectory

workingDirectory: undefined | string

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 ({@code configSourceType} value of {@code ZIP_UPLOAD}) that contains folders. Ignored for the {@code configSourceType} value of {@code COMPARTMENT_CONFIG_SOURCE}. For more information about required and recommended file structure, see File Structure (Terraform Configurations for Resource Manager).

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Job): object

getJsonObj

  • getJsonObj(obj: Job): object