Class: OCI::ResourceManager::Models::JobSummary

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

Overview

Returns a listing of all of the specified job's properties and their values.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ JobSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
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
# File 'lib/oci/resource_manager/models/job_summary.rb', line 140

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



34
35
36
# File 'lib/oci/resource_manager/models/job_summary.rb', line 34

def apply_job_plan_resolution
  @apply_job_plan_resolution
end

#compartment_idString

The OCID of the compartment where the stack of the associated job resides.

Returns:

  • (String)


20
21
22
# File 'lib/oci/resource_manager/models/job_summary.rb', line 20

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


77
78
79
# File 'lib/oci/resource_manager/models/job_summary.rb', line 77

def defined_tags
  @defined_tags
end

#display_nameString

The job's display name.

Returns:

  • (String)


24
25
26
# File 'lib/oci/resource_manager/models/job_summary.rb', line 24

def display_name
  @display_name
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>)


70
71
72
# File 'lib/oci/resource_manager/models/job_summary.rb', line 70

def freeform_tags
  @freeform_tags
end

#idString

The OCID of the job.

Returns:

  • (String)


12
13
14
# File 'lib/oci/resource_manager/models/job_summary.rb', line 12

def id
  @id
end

#job_operation_detailsOCI::ResourceManager::Models::JobOperationDetailsSummary



31
32
33
# File 'lib/oci/resource_manager/models/job_summary.rb', line 31

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.

Allowable values: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED

Returns:

  • (String)


63
64
65
# File 'lib/oci/resource_manager/models/job_summary.rb', line 63

def lifecycle_state
  @lifecycle_state
end

#operationString

The type of job executing

Returns:

  • (String)


28
29
30
# File 'lib/oci/resource_manager/models/job_summary.rb', line 28

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)


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

def resolved_plan_job_id
  @resolved_plan_job_id
end

#stack_idString

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

Returns:

  • (String)


16
17
18
# File 'lib/oci/resource_manager/models/job_summary.rb', line 16

def stack_id
  @stack_id
end

#time_createdDateTime

The date and time the job was created.

Returns:

  • (DateTime)


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

def time_created
  @time_created
end

#time_finishedDateTime

The date and time the job succeeded or failed.

Returns:

  • (DateTime)


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

def time_finished
  @time_finished
end

Class Method Details

.attribute_mapObject

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
# File 'lib/oci/resource_manager/models/job_summary.rb', line 80

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',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'lib/oci/resource_manager/models/job_summary.rb', line 101

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::JobOperationDetailsSummary',
    'apply_job_plan_resolution': :'OCI::ResourceManager::Models::ApplyJobPlanResolution',
    'resolved_plan_job_id': :'String',
    'time_created': :'DateTime',
    'time_finished': :'DateTime',
    'lifecycle_state': :'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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
# File 'lib/oci/resource_manager/models/job_summary.rb', line 224

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 &&
    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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
# File 'lib/oci/resource_manager/models/job_summary.rb', line 266

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


246
247
248
# File 'lib/oci/resource_manager/models/job_summary.rb', line 246

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



255
256
257
# File 'lib/oci/resource_manager/models/job_summary.rb', line 255

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, 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



299
300
301
302
303
304
305
306
307
308
# File 'lib/oci/resource_manager/models/job_summary.rb', line 299

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



293
294
295
# File 'lib/oci/resource_manager/models/job_summary.rb', line 293

def to_s
  to_hash.to_s
end