Class: OCI::Batch::Models::CreateBatchContextDetails

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

Overview

The data to create a batch context. 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 = {}) ⇒ CreateBatchContextDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/oci/batch/models/create_batch_context_details.rb', line 114

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


15
16
17
 
# File 'lib/oci/batch/models/create_batch_context_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>>) 


41
42
43
 
# File 'lib/oci/batch/models/create_batch_context_details.rb', line 41

def defined_tags
  @defined_tags
end

#description ⇒ String

Summarized information about the batch context.

Returns:

  • (String) 


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

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: batchcontext20250914115623.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/batch/models/create_batch_context_details.rb', line 21

def display_name
  @display_name
end

#entitlements ⇒ Hash<String, Integer>

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

Returns:

  • (Hash<String, Integer>) 


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

def entitlements
  @entitlements
end

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

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

Returns:



53
54
55
 
# File 'lib/oci/batch/models/create_batch_context_details.rb', line 53

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


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

def freeform_tags
  @freeform_tags
end

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

List of job priority configurations related to the batch context.

Returns:



45
46
47
 
# File 'lib/oci/batch/models/create_batch_context_details.rb', line 45

def job_priority_configurations
  @job_priority_configurations
end

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

Returns:



60
61
62
 
# File 'lib/oci/batch/models/create_batch_context_details.rb', line 60

def logging_configuration
  @logging_configuration
end

#network ⇒ OCI::Batch::Models::CreateNetworkDetails

This attribute is required.

Returns:



49
50
51
 
# File 'lib/oci/batch/models/create_batch_context_details.rb', line 49

def network
  @network
end

Class Method Details

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/batch/models/create_batch_context_details.rb', line 63

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'job_priority_configurations': :'jobPriorityConfigurations',
    'network': :'network',
    'fleets': :'fleets',
    'entitlements': :'entitlements',
    'logging_configuration': :'loggingConfiguration'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/oci/batch/models/create_batch_context_details.rb', line 81

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'job_priority_configurations': :'Array<OCI::Batch::Models::JobPriorityConfiguration>',
    'network': :'OCI::Batch::Models::CreateNetworkDetails',
    'fleets': :'Array<OCI::Batch::Models::CreateFleetDetails>',
    '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



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/oci/batch/models/create_batch_context_details.rb', line 172

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/oci/batch/models/create_batch_context_details.rb', line 211

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


191
192
193
 
# File 'lib/oci/batch/models/create_batch_context_details.rb', line 191

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



200
201
202
 
# File 'lib/oci/batch/models/create_batch_context_details.rb', line 200

def hash
  [compartment_id, display_name, description, freeform_tags, defined_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



244
245
246
247
248
249
250
251
252
253
 
# File 'lib/oci/batch/models/create_batch_context_details.rb', line 244

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



238
239
240
 
# File 'lib/oci/batch/models/create_batch_context_details.rb', line 238

def to_s
  to_hash.to_s
end