Class: OCI::Batch::Models::BatchTask

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

Overview

A batch task contains common properties for all types of job tasks. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Direct Known Subclasses

ComputeTask, GroupTask

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_COMPUTE = 'COMPUTE'.freeze,
  TYPE_GROUP = 'GROUP'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
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_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 = {}) ⇒ BatchTask

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
 
# File 'lib/oci/batch/models/batch_task.rb', line 146

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

  self.hierarchical_name = attributes[:'hierarchicalName'] if attributes[:'hierarchicalName']

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

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

  self.group_task_name = attributes[:'groupTaskName'] if attributes[:'groupTaskName']

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#dependencies ⇒ Array<String>

[Required] A list of tasks on which this tasks depends, referenced by name. Dependencies must be within the same parent (job or group task). For tasks within a group task, all dependencies must also be within that same group task.

Returns:

  • (Array<String>) 


69
70
71
 
# File 'lib/oci/batch/models/batch_task.rb', line 69

def dependencies
  @dependencies
end

#description ⇒ String

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

Returns:

  • (String) 


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

def description
  @description
end

#entitlement_claims ⇒ Array<String>

[Required] A list of resources (for example licences) this task needs for its execution.

Returns:

  • (Array<String>) 


65
66
67
 
# File 'lib/oci/batch/models/batch_task.rb', line 65

def entitlement_claims
  @entitlement_claims
end

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

[Required] Environment variables to use for the task execution.

Returns:



73
74
75
 
# File 'lib/oci/batch/models/batch_task.rb', line 73

def environment_variables
  @environment_variables
end

#group_task_name ⇒ String

The hierarchical name of the group task. Null for top-level tasks.

Returns:

  • (String) 


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

def group_task_name
  @group_task_name
end

#hierarchical_name ⇒ String

The hierarchical name of the task, which incorporates names of all parent group tasks, separated by "." (dot symbol). Maximum nesting depth is 4 levels. Example: groupTaskA.nestedGroupTaskB.thisTaskName

Returns:

  • (String) 


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

def hierarchical_name
  @hierarchical_name
end

#id ⇒ String

[Required] The UUID of batch task.

Returns:

  • (String) 


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

def id
  @id
end

#lifecycle_details ⇒ String

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

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/batch/models/batch_task.rb', line 61

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

The current state of the batch task.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

[Required] The name of the batch task. It must be unique within its parent batch job.

Returns:

  • (String) 


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

def name
  @name
end

#type ⇒ String

[Required] Type of the batch task. Also serves as a discriminator for sub-entities.

Returns:

  • (String) 


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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/oci/batch/models/batch_task.rb', line 76

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'name': :'name',
    'hierarchical_name': :'hierarchicalName',
    'group_task_name': :'groupTaskName',
    'description': :'description',
    'type': :'type',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'entitlement_claims': :'entitlementClaims',
    'dependencies': :'dependencies',
    'environment_variables': :'environmentVariables'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



118
119
120
121
122
123
124
125
126
 
# File 'lib/oci/batch/models/batch_task.rb', line 118

def self.get_subtype(object_hash)
  type = object_hash[:'type'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::Batch::Models::ComputeTask' if type == 'COMPUTE'
  return 'OCI::Batch::Models::GroupTask' if type == 'GROUP'

  # TODO: Log a warning when the subtype is not found.
  'OCI::Batch::Models::BatchTask'
end

.swagger_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/oci/batch/models/batch_task.rb', line 95

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'name': :'String',
    'hierarchical_name': :'String',
    'group_task_name': :'String',
    'description': :'String',
    'type': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'entitlement_claims': :'Array<String>',
    'dependencies': :'Array<String>',
    'environment_variables': :'Array<OCI::Batch::Models::EnvironmentVariable>'
    # 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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/oci/batch/models/batch_task.rb', line 232

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

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    hierarchical_name == other.hierarchical_name &&
    group_task_name == other.group_task_name &&
    description == other.description &&
    type == other.type &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    entitlement_claims == other.entitlement_claims &&
    dependencies == other.dependencies &&
    environment_variables == other.environment_variables
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



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/oci/batch/models/batch_task.rb', line 272

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


252
253
254
 
# File 'lib/oci/batch/models/batch_task.rb', line 252

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



261
262
263
 
# File 'lib/oci/batch/models/batch_task.rb', line 261

def hash
  [id, name, hierarchical_name, group_task_name, description, type, lifecycle_state, lifecycle_details, entitlement_claims, dependencies, environment_variables].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



305
306
307
308
309
310
311
312
313
314
 
# File 'lib/oci/batch/models/batch_task.rb', line 305

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



299
300
301
 
# File 'lib/oci/batch/models/batch_task.rb', line 299

def to_s
  to_hash.to_s
end