Class: OCI::ResourceManager::Models::Job

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/resource_manager/models/job.rb

Overview

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.

Constant Summary collapse

OPERATION_ENUM =
[
  OPERATION_PLAN = 'PLAN'.freeze,
  OPERATION_APPLY = 'APPLY'.freeze,
  OPERATION_DESTROY = 'DESTROY'.freeze,
  OPERATION_IMPORT_TF_STATE = 'IMPORT_TF_STATE'.freeze,
  OPERATION_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'.freeze,
  LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'.freeze,
  LIFECYCLE_STATE_CANCELING = 'CANCELING'.freeze,
  LIFECYCLE_STATE_CANCELED = 'CANCELED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Job

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash

Options Hash (attributes):



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
# File 'lib/oci/resource_manager/models/job.rb', line 184

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.id = attributes[:'id'] if attributes[:'id']

  self.stack_id = attributes[:'stackId'] if attributes[:'stackId']

  raise 'You cannot provide both :stackId and :stack_id' if attributes.key?(:'stackId') && attributes.key?(:'stack_id')

  self.stack_id = attributes[:'stack_id'] if attributes[:'stack_id']

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

  raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')

  self.display_name = attributes[:'display_name'] if attributes[:'display_name']

  self.operation = attributes[:'operation'] if attributes[:'operation']

  self.job_operation_details = attributes[:'jobOperationDetails'] if attributes[:'jobOperationDetails']

  raise 'You cannot provide both :jobOperationDetails and :job_operation_details' if attributes.key?(:'jobOperationDetails') && attributes.key?(:'job_operation_details')

  self.job_operation_details = attributes[:'job_operation_details'] if attributes[:'job_operation_details']

  self.apply_job_plan_resolution = attributes[:'applyJobPlanResolution'] if attributes[:'applyJobPlanResolution']

  raise 'You cannot provide both :applyJobPlanResolution and :apply_job_plan_resolution' if attributes.key?(:'applyJobPlanResolution') && attributes.key?(:'apply_job_plan_resolution')

  self.apply_job_plan_resolution = attributes[:'apply_job_plan_resolution'] if attributes[:'apply_job_plan_resolution']

  self.resolved_plan_job_id = attributes[:'resolvedPlanJobId'] if attributes[:'resolvedPlanJobId']

  raise 'You cannot provide both :resolvedPlanJobId and :resolved_plan_job_id' if attributes.key?(:'resolvedPlanJobId') && attributes.key?(:'resolved_plan_job_id')

  self.resolved_plan_job_id = attributes[:'resolved_plan_job_id'] if attributes[:'resolved_plan_job_id']

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

  raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')

  self.time_created = attributes[:'time_created'] if attributes[:'time_created']

  self.time_finished = attributes[:'timeFinished'] if attributes[:'timeFinished']

  raise 'You cannot provide both :timeFinished and :time_finished' if attributes.key?(:'timeFinished') && attributes.key?(:'time_finished')

  self.time_finished = attributes[:'time_finished'] if attributes[:'time_finished']

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

  raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')

  self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state']

  self.failure_details = attributes[:'failureDetails'] if attributes[:'failureDetails']

  raise 'You cannot provide both :failureDetails and :failure_details' if attributes.key?(:'failureDetails') && attributes.key?(:'failure_details')

  self.failure_details = attributes[:'failure_details'] if attributes[:'failure_details']

  self.working_directory = attributes[:'workingDirectory'] if attributes[:'workingDirectory']

  raise 'You cannot provide both :workingDirectory and :working_directory' if attributes.key?(:'workingDirectory') && attributes.key?(:'working_directory')

  self.working_directory = attributes[:'working_directory'] if attributes[:'working_directory']

  self.variables = attributes[:'variables'] if attributes[:'variables']

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']
end

Instance Attribute Details

#apply_job_plan_resolutionOCI::ResourceManager::Models::ApplyJobPlanResolution



62
63
64
# File 'lib/oci/resource_manager/models/job.rb', line 62

def apply_job_plan_resolution
  @apply_job_plan_resolution
end

#compartment_idString

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

Returns:

  • (String)


48
49
50
# File 'lib/oci/resource_manager/models/job.rb', line 48

def compartment_id
  @compartment_id
end

#defined_tagsHash<String, Hash<String, Object>>

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:

  • (Hash<String, Hash<String, Object>>)


112
113
114
# File 'lib/oci/resource_manager/models/job.rb', line 112

def defined_tags
  @defined_tags
end

#display_nameString

The job's display name.

Returns:

  • (String)


52
53
54
# File 'lib/oci/resource_manager/models/job.rb', line 52

def display_name
  @display_name
end

#failure_detailsOCI::ResourceManager::Models::FailureDetails



86
87
88
# File 'lib/oci/resource_manager/models/job.rb', line 86

def failure_details
  @failure_details
end

#freeform_tagsHash<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\"}

Returns:

  • (Hash<String, String>)


105
106
107
# File 'lib/oci/resource_manager/models/job.rb', line 105

def freeform_tags
  @freeform_tags
end

#idString

The OCID of the job.

Returns:

  • (String)


40
41
42
# File 'lib/oci/resource_manager/models/job.rb', line 40

def id
  @id
end

#job_operation_detailsOCI::ResourceManager::Models::JobOperationDetails



59
60
61
# File 'lib/oci/resource_manager/models/job.rb', line 59

def job_operation_details
  @job_operation_details
end

#lifecycle_stateString

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

Returns:

  • (String)


83
84
85
# File 'lib/oci/resource_manager/models/job.rb', line 83

def lifecycle_state
  @lifecycle_state
end

#operationString

The type of job executing.

Returns:

  • (String)


56
57
58
# File 'lib/oci/resource_manager/models/job.rb', line 56

def operation
  @operation
end

#resolved_plan_job_idString

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:

  • (String)


68
69
70
# File 'lib/oci/resource_manager/models/job.rb', line 68

def resolved_plan_job_id
  @resolved_plan_job_id
end

#stack_idString

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

Returns:

  • (String)


44
45
46
# File 'lib/oci/resource_manager/models/job.rb', line 44

def stack_id
  @stack_id
end

#time_createdDateTime

The date and time at which the job was created.

Returns:

  • (DateTime)


72
73
74
# File 'lib/oci/resource_manager/models/job.rb', line 72

def time_created
  @time_created
end

#time_finishedDateTime

The date and time at which the job stopped running, irrespective of whether the job ran successfully.

Returns:

  • (DateTime)


76
77
78
# File 'lib/oci/resource_manager/models/job.rb', line 76

def time_finished
  @time_finished
end

#variablesHash<String, String>

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\"}

Returns:

  • (Hash<String, String>)


98
99
100
# File 'lib/oci/resource_manager/models/job.rb', line 98

def variables
  @variables
end

#working_directoryString

The file path to the directory within the configuration from which the job runs.

Returns:

  • (String)


90
91
92
# File 'lib/oci/resource_manager/models/job.rb', line 90

def working_directory
  @working_directory
end

Class Method Details

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
# File 'lib/oci/resource_manager/models/job.rb', line 115

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'stack_id': :'stackId',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'operation': :'operation',
    'job_operation_details': :'jobOperationDetails',
    'apply_job_plan_resolution': :'applyJobPlanResolution',
    'resolved_plan_job_id': :'resolvedPlanJobId',
    'time_created': :'timeCreated',
    'time_finished': :'timeFinished',
    'lifecycle_state': :'lifecycleState',
    'failure_details': :'failureDetails',
    'working_directory': :'workingDirectory',
    'variables': :'variables',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
# File 'lib/oci/resource_manager/models/job.rb', line 139

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'stack_id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'operation': :'String',
    'job_operation_details': :'OCI::ResourceManager::Models::JobOperationDetails',
    'apply_job_plan_resolution': :'OCI::ResourceManager::Models::ApplyJobPlanResolution',
    'resolved_plan_job_id': :'String',
    'time_created': :'DateTime',
    'time_finished': :'DateTime',
    'lifecycle_state': :'String',
    'failure_details': :'OCI::ResourceManager::Models::FailureDetails',
    'working_directory': :'String',
    'variables': :'Hash<String, String>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object)

    the other object to be compared



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
# File 'lib/oci/resource_manager/models/job.rb', line 308

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    stack_id == other.stack_id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    operation == other.operation &&
    job_operation_details == other.job_operation_details &&
    apply_job_plan_resolution == other.apply_job_plan_resolution &&
    resolved_plan_job_id == other.resolved_plan_job_id &&
    time_created == other.time_created &&
    time_finished == other.time_finished &&
    lifecycle_state == other.lifecycle_state &&
    failure_details == other.failure_details &&
    working_directory == other.working_directory &&
    variables == other.variables &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
# File 'lib/oci/resource_manager/models/job.rb', line 353

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object)

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


333
334
335
# File 'lib/oci/resource_manager/models/job.rb', line 333

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



342
343
344
# File 'lib/oci/resource_manager/models/job.rb', line 342

def hash
  [id, stack_id, compartment_id, display_name, operation, job_operation_details, apply_job_plan_resolution, resolved_plan_job_id, time_created, time_finished, lifecycle_state, failure_details, working_directory, variables, freeform_tags, defined_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



386
387
388
389
390
391
392
393
394
395
# File 'lib/oci/resource_manager/models/job.rb', line 386

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



380
381
382
# File 'lib/oci/resource_manager/models/job.rb', line 380

def to_s
  to_hash.to_s
end