@Generated(value="OracleSDKGenerator", comments="API Version: 20180917") public final class Job extends Object
The properties that define a job. Jobs perform the actions that are defined in your configuration. - Plan job. A plan job takes your Terraform configuration, parses it, and creates an execution plan. - Apply job. The apply job takes your execution plan, applies it to the associated stack, then executes the configuration’s instructions. - Destroy job. To clean up the infrastructure controlled by the stack, you run a destroy job. A destroy job does not delete the stack or associated job resources, but instead releases the resources managed by the stack. - Import_TF_State job. An import Terraform state job takes a Terraform state file and sets it as the current state of the stack. This is used to migrate local Terraform environments to Resource Manager.
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 __explicitlySet__. The hashCode() and equals(Object) methods are implemented to take __explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
Job.Builder |
static class |
Job.LifecycleState
Current state of the specified job.
|
static class |
Job.Operation
The type of job executing.
|
| Constructor and Description |
|---|
Job(String id,
String stackId,
String compartmentId,
String displayName,
Job.Operation operation,
JobOperationDetails jobOperationDetails,
ApplyJobPlanResolution applyJobPlanResolution,
String resolvedPlanJobId,
Date timeCreated,
Date timeFinished,
Job.LifecycleState lifecycleState,
FailureDetails failureDetails,
String workingDirectory,
Map<String,String> variables,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Job.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
ApplyJobPlanResolution |
getApplyJobPlanResolution() |
String |
getCompartmentId()
The OCID of the compartment in which the job’s associated stack resides.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDisplayName()
The job’s display name.
|
FailureDetails |
getFailureDetails() |
Map<String,String> |
getFreeformTags()
Free-form tags associated with this resource.
|
String |
getId()
The OCID of the job.
|
JobOperationDetails |
getJobOperationDetails() |
Job.LifecycleState |
getLifecycleState()
Current state of the specified job.
|
Job.Operation |
getOperation()
The type of job executing.
|
String |
getResolvedPlanJobId()
Deprecated.
|
String |
getStackId()
The OCID of the stack that is associated with the job.
|
Date |
getTimeCreated()
The date and time at which the job was created.
|
Date |
getTimeFinished()
The date and time at which the job stopped running, irrespective of whether the job ran successfully.
|
Map<String,String> |
getVariables()
Terraform variables associated with this resource.
|
String |
getWorkingDirectory()
The file path to the directory within the configuration from which the job runs.
|
int |
hashCode() |
String |
toString() |
@ConstructorProperties(value={"id","stackId","compartmentId","displayName","operation","jobOperationDetails","applyJobPlanResolution","resolvedPlanJobId","timeCreated","timeFinished","lifecycleState","failureDetails","workingDirectory","variables","freeformTags","definedTags"}) @Deprecated public Job(String id, String stackId, String compartmentId, String displayName, Job.Operation operation, JobOperationDetails jobOperationDetails, ApplyJobPlanResolution applyJobPlanResolution, String resolvedPlanJobId, Date timeCreated, Date timeFinished, Job.LifecycleState lifecycleState, FailureDetails failureDetails, String workingDirectory, Map<String,String> variables, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)
public static Job.Builder builder()
Create a new builder.
public String getCompartmentId()
The OCID of the compartment in which the job’s associated stack resides.
public String getDisplayName()
The job’s display name.
public Job.Operation getOperation()
The type of job executing.
public JobOperationDetails getJobOperationDetails()
public ApplyJobPlanResolution getApplyJobPlanResolution()
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).
public Date getTimeCreated()
The date and time at which the job was created.
public Date getTimeFinished()
The date and time at which the job stopped running, irrespective of whether the job ran successfully.
public Job.LifecycleState getLifecycleState()
Current state of the specified job. For more information about resource states in Resource Manager, see Key Concepts.
public FailureDetails getFailureDetails()
public String getWorkingDirectory()
The file path to the directory within the configuration from which the job runs.
public Map<String,String> getVariables()
Terraform variables associated with this resource. Maximum number of variables supported is 100. The maximum size of each variable, including both name and value, is 4096 bytes. Example: {\"CompartmentId\": \"compartment-id-value\"}
public Map<String,String> getFreeformTags()
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\"}
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\"}}
Copyright © 2016–2020. All rights reserved.