@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).
| 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.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
Job(String id,
String stackId,
String compartmentId,
String displayName,
Job.Operation operation,
Boolean isThirdPartyProviderExperienceEnabled,
Boolean isProviderUpgradeRequired,
JobOperationDetails jobOperationDetails,
ApplyJobPlanResolution applyJobPlanResolution,
String resolvedPlanJobId,
Date timeCreated,
Date timeFinished,
Job.LifecycleState lifecycleState,
FailureDetails failureDetails,
CancellationDetails cancellationDetails,
String workingDirectory,
Map<String,String> variables,
ConfigSourceRecord configSource,
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) |
ApplyJobPlanResolution |
getApplyJobPlanResolution() |
CancellationDetails |
getCancellationDetails() |
String |
getCompartmentId()
The OCID of
the compartment in which the job’s associated stack resides.
|
ConfigSourceRecord |
getConfigSource() |
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.
|
Boolean |
getIsProviderUpgradeRequired()
Specifies whether or not to upgrade provider versions.
|
Boolean |
getIsThirdPartyProviderExperienceEnabled()
When
true, the stack sources third-party Terraform providers from Terraform
Registry and allows customTerraformProvider. |
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 when the job was created.
|
Date |
getTimeFinished()
The date and time when the job stopped running, irrespective of whether the job ran
successfully.
|
Map<String,String> |
getVariables()
Terraform variables associated with this resource.
|
String |
getWorkingDirectory()
File path to the directory to use for running Terraform.
|
int |
hashCode() |
Job.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","stackId","compartmentId","displayName","operation","isThirdPartyProviderExperienceEnabled","isProviderUpgradeRequired","jobOperationDetails","applyJobPlanResolution","resolvedPlanJobId","timeCreated","timeFinished","lifecycleState","failureDetails","cancellationDetails","workingDirectory","variables","configSource","freeformTags","definedTags"}) public Job(String id, String stackId, String compartmentId, String displayName, Job.Operation operation, Boolean isThirdPartyProviderExperienceEnabled, Boolean isProviderUpgradeRequired, JobOperationDetails jobOperationDetails, ApplyJobPlanResolution applyJobPlanResolution, String resolvedPlanJobId, Date timeCreated, Date timeFinished, Job.LifecycleState lifecycleState, FailureDetails failureDetails, CancellationDetails cancellationDetails, String workingDirectory, Map<String,String> variables, ConfigSourceRecord configSource, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)
public static Job.Builder builder()
Create a new builder.
public Job.Builder toBuilder()
public String getStackId()
The OCID of the stack that is associated with the job.
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 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.
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).
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 when the job was created. Format is defined by RFC3339. Example: 2020-01-25T21:10:29.600Z
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
public Job.LifecycleState getLifecycleState()
Current state of the specified job. For more information about job lifecycle states in Resource Manager, see Key Concepts.
public FailureDetails getFailureDetails()
public CancellationDetails getCancellationDetails()
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).
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"}
public ConfigSourceRecord getConfigSource()
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"}}
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.