Class: OCI::Batch::Models::ComputeTask

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

Overview

compute task represents a single executable command together with its dependencies and resources.

Constant Summary

Constants inherited from BatchTask

BatchTask::LIFECYCLE_STATE_ENUM, BatchTask::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from BatchTask

#dependencies, #description, #entitlement_claims, #environment_variables, #group_task_name, #hierarchical_name, #id, #lifecycle_details, #lifecycle_state, #name, #type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BatchTask

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ ComputeTask

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/oci/batch/models/compute_task.rb', line 107

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

  attributes['type'] = 'COMPUTE'

  super(attributes)

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

  self.batch_task_profile_id = attributes[:'batchTaskProfileId'] if attributes[:'batchTaskProfileId']

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

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

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

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

  self.fleet_assignment_policy = attributes[:'fleetAssignmentPolicy'] if attributes[:'fleetAssignmentPolicy']

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

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

  self.batch_task_environment_id = attributes[:'batchTaskEnvironmentId'] if attributes[:'batchTaskEnvironmentId']

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

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

  self.most_recent_execution_history = attributes[:'mostRecentExecutionHistory'] if attributes[:'mostRecentExecutionHistory']

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

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

Instance Attribute Details

#arguments ⇒ Array<String>

Task arguments.

Returns:

  • (Array<String>) 


22
23
24
 
# File 'lib/oci/batch/models/compute_task.rb', line 22

def arguments
  @arguments
end

#batch_task_environment_id ⇒ String

[Required] The OCID of the BatchTaskEnvironment.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/batch/models/compute_task.rb', line 29

def batch_task_environment_id
  @batch_task_environment_id
end

#batch_task_profile_id ⇒ String

The OCID of the batch task profile used for this task.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/batch/models/compute_task.rb', line 14

def batch_task_profile_id
  @batch_task_profile_id
end

#command ⇒ Array<String>

An executable command to start the processing of this task.

Returns:

  • (Array<String>) 


18
19
20
 
# File 'lib/oci/batch/models/compute_task.rb', line 18

def command
  @command
end

#fleet_assignment_policy ⇒ OCI::Batch::Models::FleetAssignmentPolicy

Returns:



25
26
27
 
# File 'lib/oci/batch/models/compute_task.rb', line 25

def fleet_assignment_policy
  @fleet_assignment_policy
end

#most_recent_execution_history ⇒ Array<OCI::Batch::Models::BatchTaskExecutionDetails>

List of up to 30 most recent execution history entries, from newest to oldest. Be aware that the maximum number of items returned may change in the future.

Returns:



33
34
35
 
# File 'lib/oci/batch/models/compute_task.rb', line 33

def most_recent_execution_history
  @most_recent_execution_history
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/oci/batch/models/compute_task.rb', line 36

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',
    'batch_task_profile_id': :'batchTaskProfileId',
    'command': :'command',
    'arguments': :'arguments',
    'fleet_assignment_policy': :'fleetAssignmentPolicy',
    'batch_task_environment_id': :'batchTaskEnvironmentId',
    'most_recent_execution_history': :'mostRecentExecutionHistory'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/oci/batch/models/compute_task.rb', line 61

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>',
    'batch_task_profile_id': :'String',
    'command': :'Array<String>',
    'arguments': :'Array<String>',
    'fleet_assignment_policy': :'OCI::Batch::Models::FleetAssignmentPolicy',
    'batch_task_environment_id': :'String',
    'most_recent_execution_history': :'Array<OCI::Batch::Models::BatchTaskExecutionDetails>'
    # 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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/oci/batch/models/compute_task.rb', line 153

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 &&
    batch_task_profile_id == other.batch_task_profile_id &&
    command == other.command &&
    arguments == other.arguments &&
    fleet_assignment_policy == other.fleet_assignment_policy &&
    batch_task_environment_id == other.batch_task_environment_id &&
    most_recent_execution_history == other.most_recent_execution_history
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



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/oci/batch/models/compute_task.rb', line 199

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


179
180
181
 
# File 'lib/oci/batch/models/compute_task.rb', line 179

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



188
189
190
 
# File 'lib/oci/batch/models/compute_task.rb', line 188

def hash
  [id, name, hierarchical_name, group_task_name, description, type, lifecycle_state, lifecycle_details, entitlement_claims, dependencies, environment_variables, batch_task_profile_id, command, arguments, fleet_assignment_policy, batch_task_environment_id, most_recent_execution_history].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



232
233
234
235
236
237
238
239
240
241
 
# File 'lib/oci/batch/models/compute_task.rb', line 232

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



226
227
228
 
# File 'lib/oci/batch/models/compute_task.rb', line 226

def to_s
  to_hash.to_s
end