Class: OCI::Opensearch::Models::UpgradeOpenSearchClusterDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/opensearch/models/upgrade_open_search_cluster_details.rb

Overview

Minor or major version upgrade of a cluster.

Constant Summary collapse

UPGRADE_TYPE_ENUM = 
[
  UPGRADE_TYPE_MINOR = 'MINOR'.freeze,
  UPGRADE_TYPE_MAJOR = 'MAJOR'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpgradeOpenSearchClusterDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :original_cluster_display_name (String) —

    The value to assign to the #original_cluster_display_name property

  • :desired_software_version (String) —

    The value to assign to the #desired_software_version property

  • :upgrade_type (String) —

    The value to assign to the #upgrade_type property

  • :is_clone (BOOLEAN) —

    The value to assign to the #is_clone property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property

  • :security_attributes (Hash<String, Hash<String, Object>>) —

    The value to assign to the #security_attributes property



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

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

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

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

  self.desired_software_version = attributes[:'desiredSoftwareVersion'] if attributes[:'desiredSoftwareVersion']

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

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

  self.upgrade_type = attributes[:'upgradeType'] if attributes[:'upgradeType']

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

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

  self.is_clone = attributes[:'isClone'] unless attributes[:'isClone'].nil?
  self.is_clone = true if is_clone.nil? && !attributes.key?(:'isClone') # rubocop:disable Style/StringLiterals

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

  self.is_clone = attributes[:'is_clone'] unless attributes[:'is_clone'].nil?
  self.is_clone = true if is_clone.nil? && !attributes.key?(:'isClone') && !attributes.key?(:'is_clone') # rubocop:disable Style/StringLiterals

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

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

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

Instance Attribute Details

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


44
45
46
 
# File 'lib/oci/opensearch/models/upgrade_open_search_cluster_details.rb', line 44

def defined_tags
  @defined_tags
end

#desired_software_version ⇒ String

[Required] The software version the cluster is desired.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/opensearch/models/upgrade_open_search_cluster_details.rb', line 24

def desired_software_version
  @desired_software_version
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


38
39
40
 
# File 'lib/oci/opensearch/models/upgrade_open_search_cluster_details.rb', line 38

def freeform_tags
  @freeform_tags
end

#is_clone ⇒ BOOLEAN

The cluster would be cloned for true and updated for false with the provided version.

Returns:

  • (BOOLEAN) 


32
33
34
 
# File 'lib/oci/opensearch/models/upgrade_open_search_cluster_details.rb', line 32

def is_clone
  @is_clone
end

#original_cluster_display_name ⇒ String

[Required] The display name of the original cluster. This is required to validate that the cluster ID has the same display name.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/opensearch/models/upgrade_open_search_cluster_details.rb', line 20

def original_cluster_display_name
  @original_cluster_display_name
end

#security_attributes ⇒ Hash<String, Hash<String, Object>>

Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Oracle-ZPR\": {\"MaxEgressCount\": {\"value\": \"42\", \"mode\": \"enforce\"}}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


58
59
60
 
# File 'lib/oci/opensearch/models/upgrade_open_search_cluster_details.rb', line 58

def security_attributes
  @security_attributes
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


50
51
52
 
# File 'lib/oci/opensearch/models/upgrade_open_search_cluster_details.rb', line 50

def system_tags
  @system_tags
end

#upgrade_type ⇒ String

[Required] The upgrade type of cluster (major or minor).

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/opensearch/models/upgrade_open_search_cluster_details.rb', line 28

def upgrade_type
  @upgrade_type
end

Class Method Details

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/oci/opensearch/models/upgrade_open_search_cluster_details.rb', line 61

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'original_cluster_display_name': :'originalClusterDisplayName',
    'desired_software_version': :'desiredSoftwareVersion',
    'upgrade_type': :'upgradeType',
    'is_clone': :'isClone',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'security_attributes': :'securityAttributes'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/oci/opensearch/models/upgrade_open_search_cluster_details.rb', line 77

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'original_cluster_display_name': :'String',
    'desired_software_version': :'String',
    'upgrade_type': :'String',
    'is_clone': :'BOOLEAN',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'security_attributes': :'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



178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/oci/opensearch/models/upgrade_open_search_cluster_details.rb', line 178

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

  self.class == other.class &&
    original_cluster_display_name == other.original_cluster_display_name &&
    desired_software_version == other.desired_software_version &&
    upgrade_type == other.upgrade_type &&
    is_clone == other.is_clone &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    security_attributes == other.security_attributes
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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/oci/opensearch/models/upgrade_open_search_cluster_details.rb', line 215

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


195
196
197
 
# File 'lib/oci/opensearch/models/upgrade_open_search_cluster_details.rb', line 195

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



204
205
206
 
# File 'lib/oci/opensearch/models/upgrade_open_search_cluster_details.rb', line 204

def hash
  [original_cluster_display_name, desired_software_version, upgrade_type, is_clone, freeform_tags, defined_tags, system_tags, security_attributes].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



248
249
250
251
252
253
254
255
256
257
 
# File 'lib/oci/opensearch/models/upgrade_open_search_cluster_details.rb', line 248

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



242
243
244
 
# File 'lib/oci/opensearch/models/upgrade_open_search_cluster_details.rb', line 242

def to_s
  to_hash.to_s
end