Class: OCI::Batch::Models::CreateBatchTaskDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/batch/models/create_batch_task_details.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

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_COMPUTE = 'COMPUTE'.freeze,
  TYPE_GROUP = 'GROUP'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateBatchTaskDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/oci/batch/models/create_batch_task_details.rb', line 97

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

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

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

  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>

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


35
36
37
 
# File 'lib/oci/batch/models/create_batch_task_details.rb', line 35

def dependencies
  @dependencies
end

#description ⇒ String

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

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/batch/models/create_batch_task_details.rb', line 23

def description
  @description
end

#entitlement_claims ⇒ Array<String>

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

Returns:

  • (Array<String>) 


31
32
33
 
# File 'lib/oci/batch/models/create_batch_task_details.rb', line 31

def entitlement_claims
  @entitlement_claims
end

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

Environment variables to use for the task execution.

Returns:



39
40
41
 
# File 'lib/oci/batch/models/create_batch_task_details.rb', line 39

def environment_variables
  @environment_variables
end

#name ⇒ String

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

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/batch/models/create_batch_task_details.rb', line 19

def name
  @name
end

#type ⇒ String

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

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/batch/models/create_batch_task_details.rb', line 27

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/oci/batch/models/create_batch_task_details.rb', line 42

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'description': :'description',
    'type': :'type',
    '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.



74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/batch/models/create_batch_task_details.rb', line 74

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

  return 'OCI::Batch::Models::CreateComputeTaskDetails' if type == 'COMPUTE'
  return 'OCI::Batch::Models::CreateGroupTaskDetails' if type == 'GROUP'

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

.swagger_types ⇒ Object

Attribute type mapping.



56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/oci/batch/models/create_batch_task_details.rb', line 56

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'description': :'String',
    'type': :'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



139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/oci/batch/models/create_batch_task_details.rb', line 139

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

  self.class == other.class &&
    name == other.name &&
    description == other.description &&
    type == other.type &&
    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



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/oci/batch/models/create_batch_task_details.rb', line 174

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


154
155
156
 
# File 'lib/oci/batch/models/create_batch_task_details.rb', line 154

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



163
164
165
 
# File 'lib/oci/batch/models/create_batch_task_details.rb', line 163

def hash
  [name, description, type, 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



207
208
209
210
211
212
213
214
215
216
 
# File 'lib/oci/batch/models/create_batch_task_details.rb', line 207

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



201
202
203
 
# File 'lib/oci/batch/models/create_batch_task_details.rb', line 201

def to_s
  to_hash.to_s
end