Class: OCI::Bds::Models::AddBlockStorageDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/bds/models/add_block_storage_details.rb

Overview

The information about added block volumes.

Constant Summary collapse

NODE_TYPE_ENUM = 
[
  NODE_TYPE_WORKER = 'WORKER'.freeze,
  NODE_TYPE_COMPUTE_ONLY_WORKER = 'COMPUTE_ONLY_WORKER'.freeze,
  NODE_TYPE_KAFKA_BROKER = 'KAFKA_BROKER'.freeze,
  NODE_TYPE_EDGE = 'EDGE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AddBlockStorageDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :cluster_admin_password (String) —

    The value to assign to the #cluster_admin_password property

  • :secret_id (String) —

    The value to assign to the #secret_id property

  • :block_volume_size_in_gbs (Integer) —

    The value to assign to the #block_volume_size_in_gbs property

  • :node_type (String) —

    The value to assign to the #node_type property

  • :node_ids (Array<String>) —

    The value to assign to the #node_ids property



82
83
84
85
86
87
88
89
90
91
92
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
 
# File 'lib/oci/bds/models/add_block_storage_details.rb', line 82

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

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

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

  self.secret_id = attributes[:'secretId'] if attributes[:'secretId']

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

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

  self.block_volume_size_in_gbs = attributes[:'blockVolumeSizeInGBs'] if attributes[:'blockVolumeSizeInGBs']

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

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

  self.node_type = attributes[:'nodeType'] if attributes[:'nodeType']

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

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

  self.node_ids = attributes[:'nodeIds'] if attributes[:'nodeIds']

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

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

Instance Attribute Details

#block_volume_size_in_gbs ⇒ Integer

[Required] The size of block volume in GB to be added. For WORKER, COMPUTE_ONLY_WORKER, and KAFKA_BROKER nodes, the same size will be added to all nodes of that type. For EDGE nodes, this size can be different per node when nodeId is specified. All the details needed for attaching the block volume are managed by service itself.

Returns:

  • (Integer) 


32
33
34
 
# File 'lib/oci/bds/models/add_block_storage_details.rb', line 32

def block_volume_size_in_gbs
  @block_volume_size_in_gbs
end

#cluster_admin_password ⇒ String

Base-64 encoded password for the cluster (and Cloudera Manager) admin user.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/bds/models/add_block_storage_details.rb', line 20

def cluster_admin_password
  @cluster_admin_password
end

#node_ids ⇒ Array<String>

Optional. List of OCIDs of specific nodes to add storage to. Only supported for EDGE nodes. When omitted, storage is added to all nodes of the specified type.

Returns:

  • (Array<String>) 


43
44
45
 
# File 'lib/oci/bds/models/add_block_storage_details.rb', line 43

def node_ids
  @node_ids
end

#node_type ⇒ String

[Required] Worker node types.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/bds/models/add_block_storage_details.rb', line 36

def node_type
  @node_type
end

#secret_id ⇒ String

The secretId for the clusterAdminPassword.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/bds/models/add_block_storage_details.rb', line 24

def secret_id
  @secret_id
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/oci/bds/models/add_block_storage_details.rb', line 46

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'cluster_admin_password': :'clusterAdminPassword',
    'secret_id': :'secretId',
    'block_volume_size_in_gbs': :'blockVolumeSizeInGBs',
    'node_type': :'nodeType',
    'node_ids': :'nodeIds'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/oci/bds/models/add_block_storage_details.rb', line 59

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'cluster_admin_password': :'String',
    'secret_id': :'String',
    'block_volume_size_in_gbs': :'Integer',
    'node_type': :'String',
    'node_ids': :'Array<String>'
    # 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



134
135
136
137
138
139
140
141
142
143
 
# File 'lib/oci/bds/models/add_block_storage_details.rb', line 134

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

  self.class == other.class &&
    cluster_admin_password == other.cluster_admin_password &&
    secret_id == other.secret_id &&
    block_volume_size_in_gbs == other.block_volume_size_in_gbs &&
    node_type == other.node_type &&
    node_ids == other.node_ids
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



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/oci/bds/models/add_block_storage_details.rb', line 168

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


148
149
150
 
# File 'lib/oci/bds/models/add_block_storage_details.rb', line 148

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



157
158
159
 
# File 'lib/oci/bds/models/add_block_storage_details.rb', line 157

def hash
  [cluster_admin_password, secret_id, block_volume_size_in_gbs, node_type, node_ids].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



201
202
203
204
205
206
207
208
209
210
 
# File 'lib/oci/bds/models/add_block_storage_details.rb', line 201

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



195
196
197
 
# File 'lib/oci/bds/models/add_block_storage_details.rb', line 195

def to_s
  to_hash.to_s
end