Class: OCI::Batch::Models::BatchJob

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/batch/models/batch_job.rb

Overview

A batch job represents the execution unit that is invoked on a batch's pools of compute resources. A job is composed of one or more tasks, which are the executable commands.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see Getting Started with Policies.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'.freeze,
  LIFECYCLE_STATE_WAITING = 'WAITING'.freeze,
  LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.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 = {}) ⇒ BatchJob

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :batch_job_pool_id (String) —

    The value to assign to the #batch_job_pool_id property

  • :batch_context_id (String) —

    The value to assign to the #batch_context_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :priority (Integer) —

    The value to assign to the #priority property

  • :progress_percentage (Integer) —

    The value to assign to the #progress_percentage property

  • :progress_details (String) —

    The value to assign to the #progress_details property

  • :environment_variables (Array<OCI::Batch::Models::EnvironmentVariable>) —

    The value to assign to the #environment_variables property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



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
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/oci/batch/models/batch_job.rb', line 191

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.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.batch_job_pool_id = attributes[:'batchJobPoolId'] if attributes[:'batchJobPoolId']

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

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

  self.batch_context_id = attributes[:'batchContextId'] if attributes[:'batchContextId']

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

  self.batch_context_id = attributes[:'batch_context_id'] if attributes[:'batch_context_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.description = attributes[:'description'] if attributes[:'description']

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

  self.progress_percentage = attributes[:'progressPercentage'] if attributes[:'progressPercentage']

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

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

  self.progress_details = attributes[:'progressDetails'] if attributes[:'progressDetails']

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

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

  self.environment_variables = attributes[:'environmentVariables'] if attributes[:'environmentVariables']

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

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

  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_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  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.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

  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']

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#batch_context_id ⇒ String

[Required] The OCID of the parent batch context of the parent job pool.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/batch/models/batch_job.rb', line 44

def batch_context_id
  @batch_context_id
end

#batch_job_pool_id ⇒ String

[Required] The OCID of the parent batch job pool.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/batch/models/batch_job.rb', line 40

def batch_job_pool_id
  @batch_job_pool_id
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/batch/models/batch_job.rb', line 36

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

[Required] 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>>) 


109
110
111
 
# File 'lib/oci/batch/models/batch_job.rb', line 109

def defined_tags
  @defined_tags
end

#description ⇒ String

An optional description that provides additional context next to the displayName.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/batch/models/batch_job.rb', line 52

def description
  @description
end

#display_name ⇒ String

[Required] A user-friendly name. Does not have to be unique, and it's changeable.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/batch/models/batch_job.rb', line 48

def display_name
  @display_name
end

#environment_variables ⇒ Array<OCI::Batch::Models::EnvironmentVariable>

An environment variables to use for the job's tasks (can be overridden by task's environment variables).

Returns:



68
69
70
 
# File 'lib/oci/batch/models/batch_job.rb', line 68

def environment_variables
  @environment_variables
end

#freeform_tags ⇒ Hash<String, String>

[Required] Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


101
102
103
 
# File 'lib/oci/batch/models/batch_job.rb', line 101

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the batch job.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/batch/models/batch_job.rb', line 32

def id
  @id
end

#lifecycle_details ⇒ String

A message that describes the current state of the batch job in more detail. For example, can be used to provide actionable information for a resource in the Failed state.

Returns:

  • (String) 


93
94
95
 
# File 'lib/oci/batch/models/batch_job.rb', line 93

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the batch job.

Returns:

  • (String) 


87
88
89
 
# File 'lib/oci/batch/models/batch_job.rb', line 87

def lifecycle_state
  @lifecycle_state
end

#priority ⇒ Integer

A value calculated by the system based on the priority tags.

Returns:

  • (Integer) 


56
57
58
 
# File 'lib/oci/batch/models/batch_job.rb', line 56

def priority
  @priority
end

#progress_details ⇒ String

A more detailed textual representation of the job completion.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/batch/models/batch_job.rb', line 64

def progress_details
  @progress_details
end

#progress_percentage ⇒ Integer

A percentage value (0..100) of the job completion.

Returns:

  • (Integer) 


60
61
62
 
# File 'lib/oci/batch/models/batch_job.rb', line 60

def progress_percentage
  @progress_percentage
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

[Required] System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


116
117
118
 
# File 'lib/oci/batch/models/batch_job.rb', line 116

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The date and time the batch job was created, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


75
76
77
 
# File 'lib/oci/batch/models/batch_job.rb', line 75

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time the batch job was updated, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


82
83
84
 
# File 'lib/oci/batch/models/batch_job.rb', line 82

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/oci/batch/models/batch_job.rb', line 119

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'batch_job_pool_id': :'batchJobPoolId',
    'batch_context_id': :'batchContextId',
    'display_name': :'displayName',
    'description': :'description',
    'priority': :'priority',
    'progress_percentage': :'progressPercentage',
    'progress_details': :'progressDetails',
    'environment_variables': :'environmentVariables',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/batch/models/batch_job.rb', line 144

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'batch_job_pool_id': :'String',
    'batch_context_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'priority': :'Integer',
    'progress_percentage': :'Integer',
    'progress_details': :'String',
    'environment_variables': :'Array<OCI::Batch::Models::EnvironmentVariable>',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_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
329
 
# File 'lib/oci/batch/models/batch_job.rb', line 308

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    batch_job_pool_id == other.batch_job_pool_id &&
    batch_context_id == other.batch_context_id &&
    display_name == other.display_name &&
    description == other.description &&
    priority == other.priority &&
    progress_percentage == other.progress_percentage &&
    progress_details == other.progress_details &&
    environment_variables == other.environment_variables &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_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



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

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


334
335
336
 
# File 'lib/oci/batch/models/batch_job.rb', line 334

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



343
344
345
 
# File 'lib/oci/batch/models/batch_job.rb', line 343

def hash
  [id, compartment_id, batch_job_pool_id, batch_context_id, display_name, description, priority, progress_percentage, progress_details, environment_variables, time_created, time_updated, lifecycle_state, lifecycle_details, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



387
388
389
390
391
392
393
394
395
396
 
# File 'lib/oci/batch/models/batch_job.rb', line 387

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



381
382
383
 
# File 'lib/oci/batch/models/batch_job.rb', line 381

def to_s
  to_hash.to_s
end