Class 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.
Assembly: OCI.DotNetSDK.Resourcemanager.dll
Syntax
Properties
ApplyJobPlanResolution
Declaration
[JsonProperty(PropertyName = "applyJobPlanResolution")]
public ApplyJobPlanResolution ApplyJobPlanResolution { get; set; }
Property Value
CancellationDetails
Declaration
[JsonProperty(PropertyName = "cancellationDetails")]
public CancellationDetails CancellationDetails { get; set; }
Property Value
CompartmentId
Declaration
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type |
Description |
string |
The OCID of the compartment in which the job's associated stack resides.
|
ConfigSource
Declaration
[JsonProperty(PropertyName = "configSource")]
public ConfigSourceRecord ConfigSource { get; set; }
Property Value
Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
DisplayName
Declaration
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type |
Description |
string |
The job's display name.
|
FailureDetails
Declaration
[JsonProperty(PropertyName = "failureDetails")]
public FailureDetails FailureDetails { get; set; }
Property Value
Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type |
Description |
Dictionary<string, string> |
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: {"Department": "Finance"}
|
Id
Declaration
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
IsProviderUpgradeRequired
Declaration
[JsonProperty(PropertyName = "isProviderUpgradeRequired")]
public bool? IsProviderUpgradeRequired { get; set; }
Property Value
Type |
Description |
bool? |
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).
|
IsThirdPartyProviderExperienceEnabled
Declaration
[JsonProperty(PropertyName = "isThirdPartyProviderExperienceEnabled")]
public bool? IsThirdPartyProviderExperienceEnabled { get; set; }
Property Value
Type |
Description |
bool? |
When 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.
|
JobOperationDetails
Declaration
[JsonProperty(PropertyName = "jobOperationDetails")]
public JobOperationDetails JobOperationDetails { get; set; }
Property Value
LifecycleState
Declaration
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Job.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Operation
Declaration
[JsonProperty(PropertyName = "operation")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Job.OperationEnum? Operation { get; set; }
Property Value
ResolvedPlanJobId
Declaration
[JsonProperty(PropertyName = "resolvedPlanJobId")]
public string ResolvedPlanJobId { get; set; }
Property Value
Type |
Description |
string |
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).
|
StackId
Declaration
[JsonProperty(PropertyName = "stackId")]
public string StackId { get; set; }
Property Value
Type |
Description |
string |
The OCID of the stack that is associated with the job.
|
TimeCreated
Declaration
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type |
Description |
DateTime? |
The date and time when the job was created.
Format is defined by RFC3339.
Example: 2020-01-25T21:10:29.600Z
|
TimeFinished
Declaration
[JsonProperty(PropertyName = "timeFinished")]
public DateTime? TimeFinished { get; set; }
Property Value
Type |
Description |
DateTime? |
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
|
Variables
Declaration
[JsonProperty(PropertyName = "variables")]
public Dictionary<string, string> Variables { get; set; }
Property Value
Type |
Description |
Dictionary<string, string> |
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"}
|
WorkingDirectory
Declaration
[JsonProperty(PropertyName = "workingDirectory")]
public string WorkingDirectory { get; set; }
Property Value
Type |
Description |
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 (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).
|