Class: OCI::Batch::Models::BatchContext

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

Overview

Representation of a batch context and its configurations.

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_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.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 = {}) ⇒ BatchContext

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



181
182
183
184
185
186
187
188
189
190
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
 
# File 'lib/oci/batch/models/batch_context.rb', line 181

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

  self.job_priority_configurations = attributes[:'jobPriorityConfigurations'] if attributes[:'jobPriorityConfigurations']

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

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

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

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

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

  self.logging_configuration = attributes[:'loggingConfiguration'] if attributes[:'loggingConfiguration']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


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

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


83
84
85
 
# File 'lib/oci/batch/models/batch_context.rb', line 83

def defined_tags
  @defined_tags
end

#description ⇒ String

Summarized information about the batch context.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/batch/models/batch_context.rb', line 43

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

def display_name
  @display_name
end

#entitlements ⇒ Hash<String, Integer>

[Required] Mapping of concurrent/shared resources used in job tasks to their limits.

Returns:

  • (Hash<String, Integer>) 


106
107
108
 
# File 'lib/oci/batch/models/batch_context.rb', line 106

def entitlements
  @entitlements
end

#fleets ⇒ Array<OCI::Batch::Models::Fleet>

[Required] List of fleet configurations related to the batch context.

Returns:



102
103
104
 
# File 'lib/oci/batch/models/batch_context.rb', line 102

def fleets
  @fleets
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>) 


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the batch context.

Returns:

  • (String) 


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

def id
  @id
end

#job_priority_configurations ⇒ Array<OCI::Batch::Models::JobPriorityConfiguration>

[Required] List of job priority configurations related to the batch context.

Returns:



94
95
96
 
# File 'lib/oci/batch/models/batch_context.rb', line 94

def job_priority_configurations
  @job_priority_configurations
end

#lifecycle_details ⇒ String

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

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/batch/models/batch_context.rb', line 67

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the batch context.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/batch/models/batch_context.rb', line 62

def lifecycle_state
  @lifecycle_state
end

#logging_configuration ⇒ OCI::Batch::Models::LoggingConfiguration

Returns:



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

def logging_configuration
  @logging_configuration
end

#network ⇒ OCI::Batch::Models::Network

This attribute is required.

Returns:



98
99
100
 
# File 'lib/oci/batch/models/batch_context.rb', line 98

def network
  @network
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>>) 


90
91
92
 
# File 'lib/oci/batch/models/batch_context.rb', line 90

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

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

Returns:

  • (DateTime) 


50
51
52
 
# File 'lib/oci/batch/models/batch_context.rb', line 50

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

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

Returns:

  • (DateTime) 


57
58
59
 
# File 'lib/oci/batch/models/batch_context.rb', line 57

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/oci/batch/models/batch_context.rb', line 112

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'job_priority_configurations': :'jobPriorityConfigurations',
    'network': :'network',
    'fleets': :'fleets',
    'entitlements': :'entitlements',
    'logging_configuration': :'loggingConfiguration'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/oci/batch/models/batch_context.rb', line 136

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    '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>>',
    'job_priority_configurations': :'Array<OCI::Batch::Models::JobPriorityConfiguration>',
    'network': :'OCI::Batch::Models::Network',
    'fleets': :'Array<OCI::Batch::Models::Fleet>',
    'entitlements': :'Hash<String, Integer>',
    'logging_configuration': :'OCI::Batch::Models::LoggingConfiguration'
    # 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



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/oci/batch/models/batch_context.rb', line 284

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    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 &&
    job_priority_configurations == other.job_priority_configurations &&
    network == other.network &&
    fleets == other.fleets &&
    entitlements == other.entitlements &&
    logging_configuration == other.logging_configuration
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



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/oci/batch/models/batch_context.rb', line 329

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


309
310
311
 
# File 'lib/oci/batch/models/batch_context.rb', line 309

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



318
319
320
 
# File 'lib/oci/batch/models/batch_context.rb', line 318

def hash
  [id, compartment_id, display_name, description, time_created, time_updated, lifecycle_state, lifecycle_details, freeform_tags, defined_tags, system_tags, job_priority_configurations, network, fleets, entitlements, logging_configuration].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



362
363
364
365
366
367
368
369
370
371
 
# File 'lib/oci/batch/models/batch_context.rb', line 362

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



356
357
358
 
# File 'lib/oci/batch/models/batch_context.rb', line 356

def to_s
  to_hash.to_s
end