Class: OCI::Batch::Models::CreateBatchJobDetails

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

Overview

The data to create a batch job. If the value for a collection is absent or is explicitly provided as null, it will be converted to an empty value, i.e. "[]" or "{}" in json notation. This applies to nested collections as well.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateBatchJobDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



103
104
105
106
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
145
146
147
148
 
# File 'lib/oci/batch/models/create_batch_job_details.rb', line 103

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

  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

#batch_job_pool_id ⇒ String

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

Returns:

  • (String) 


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

def batch_job_pool_id
  @batch_job_pool_id
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/batch/models/create_batch_job_details.rb', line 15

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<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>>) 


55
56
57
 
# File 'lib/oci/batch/models/create_batch_job_details.rb', line 55

def defined_tags
  @defined_tags
end

#description ⇒ String

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

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique, and it's changeable. If not specified or provided as null or empty string, it will be generated as "<resourceType><timeCreated>", where timeCreated corresponds with the resource creation time in ISO 8601 basic format, i.e. omitting separating punctuation, at second-level precision and no UTC offset. Example: batchjob20250914115623.

Returns:

  • (String) 


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

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:



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

def environment_variables
  @environment_variables
end

#freeform_tags ⇒ Hash<String, String>

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


47
48
49
 
# File 'lib/oci/batch/models/create_batch_job_details.rb', line 47

def freeform_tags
  @freeform_tags
end

#tasks ⇒ Array<OCI::Batch::Models::CreateBatchTaskDetails>

[Required] A list of tasks to be executed within this job. Maximum number of tasks a job can have in total, across all nested levels, is 1000.

Returns:



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

def tasks
  @tasks
end

Class Method Details

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/oci/batch/models/create_batch_job_details.rb', line 58

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'batch_job_pool_id': :'batchJobPoolId',
    'display_name': :'displayName',
    'description': :'description',
    'environment_variables': :'environmentVariables',
    'tasks': :'tasks',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/oci/batch/models/create_batch_job_details.rb', line 74

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'batch_job_pool_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'environment_variables': :'Array<OCI::Batch::Models::EnvironmentVariable>',
    'tasks': :'Array<OCI::Batch::Models::CreateBatchTaskDetails>',
    '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



157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/oci/batch/models/create_batch_job_details.rb', line 157

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    batch_job_pool_id == other.batch_job_pool_id &&
    display_name == other.display_name &&
    description == other.description &&
    environment_variables == other.environment_variables &&
    tasks == other.tasks &&
    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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/oci/batch/models/create_batch_job_details.rb', line 194

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


174
175
176
 
# File 'lib/oci/batch/models/create_batch_job_details.rb', line 174

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



183
184
185
 
# File 'lib/oci/batch/models/create_batch_job_details.rb', line 183

def hash
  [compartment_id, batch_job_pool_id, display_name, description, environment_variables, tasks, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



227
228
229
230
231
232
233
234
235
236
 
# File 'lib/oci/batch/models/create_batch_job_details.rb', line 227

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



221
222
223
 
# File 'lib/oci/batch/models/create_batch_job_details.rb', line 221

def to_s
  to_hash.to_s
end