Class: OCI::Batch::Models::UpdateBatchContextDetails

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

Overview

The data to update a batch context. If the value of a collection 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 = {}) ⇒ UpdateBatchContextDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



93
94
95
96
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
123
124
125
126
127
128
129
130
131
132
# File 'lib/oci/batch/models/update_batch_context_details.rb', line 93

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

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


37
38
39
# File 'lib/oci/batch/models/update_batch_context_details.rb', line 37

def defined_tags
  @defined_tags
end

#descriptionString

Summarized information about the batch context.

Returns:

  • (String)


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

def description
  @description
end

#display_nameString

A user-friendly name. Does not have to be unique, and it's changeable. Can't be set to null.

Returns:

  • (String)


17
18
19
# File 'lib/oci/batch/models/update_batch_context_details.rb', line 17

def display_name
  @display_name
end

#entitlementsHash<String, Integer>

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

Returns:

  • (Hash<String, Integer>)


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

def entitlements
  @entitlements
end

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


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

def freeform_tags
  @freeform_tags
end

#job_priority_configurationsArray<OCI::Batch::Models::JobPriorityConfiguration>

List of job priority configurations related to the batch context.



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

def job_priority_configurations
  @job_priority_configurations
end

#logging_configurationOCI::Batch::Models::UpdateLoggingConfigurationDetails



48
49
50
# File 'lib/oci/batch/models/update_batch_context_details.rb', line 48

def logging_configuration
  @logging_configuration
end

Class Method Details

.attribute_mapObject

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



51
52
53
54
55
56
57
58
59
60
61
62
63
# File 'lib/oci/batch/models/update_batch_context_details.rb', line 51

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

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    '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>',
    'entitlements': :'Hash<String, Integer>',
    'logging_configuration': :'OCI::Batch::Models::UpdateLoggingConfigurationDetails'
    # 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



141
142
143
144
145
146
147
148
149
150
151
152
# File 'lib/oci/batch/models/update_batch_context_details.rb', line 141

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

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



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

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


157
158
159
# File 'lib/oci/batch/models/update_batch_context_details.rb', line 157

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



166
167
168
# File 'lib/oci/batch/models/update_batch_context_details.rb', line 166

def hash
  [display_name, description, freeform_tags, defined_tags, job_priority_configurations, entitlements, logging_configuration].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



210
211
212
213
214
215
216
217
218
219
# File 'lib/oci/batch/models/update_batch_context_details.rb', line 210

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



204
205
206
# File 'lib/oci/batch/models/update_batch_context_details.rb', line 204

def to_s
  to_hash.to_s
end