Class: OCI::Bds::Models::CreateBdsInstanceDetails

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

Overview

The information about the new cluster.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateBdsInstanceDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/oci/bds/models/create_bds_instance_details.rb', line 161

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

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

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

  self.cluster_public_key = attributes[:'clusterPublicKey'] if attributes[:'clusterPublicKey']

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

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

  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.is_secret_reused = attributes[:'isSecretReused'] unless attributes[:'isSecretReused'].nil?
  self.is_secret_reused = false if is_secret_reused.nil? && !attributes.key?(:'isSecretReused') # rubocop:disable Style/StringLiterals

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

  self.is_secret_reused = attributes[:'is_secret_reused'] unless attributes[:'is_secret_reused'].nil?
  self.is_secret_reused = false if is_secret_reused.nil? && !attributes.key?(:'isSecretReused') && !attributes.key?(:'is_secret_reused') # rubocop:disable Style/StringLiterals

  self.is_high_availability = attributes[:'isHighAvailability'] unless attributes[:'isHighAvailability'].nil?
  self.is_high_availability = false if is_high_availability.nil? && !attributes.key?(:'isHighAvailability') # rubocop:disable Style/StringLiterals

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

  self.is_high_availability = attributes[:'is_high_availability'] unless attributes[:'is_high_availability'].nil?
  self.is_high_availability = false if is_high_availability.nil? && !attributes.key?(:'isHighAvailability') && !attributes.key?(:'is_high_availability') # rubocop:disable Style/StringLiterals

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

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

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

  self.network_config = attributes[:'networkConfig'] if attributes[:'networkConfig']

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

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

  self.bootstrap_script_url = attributes[:'bootstrapScriptUrl'] if attributes[:'bootstrapScriptUrl']

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

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

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

  self.kerberos_realm_name = attributes[:'kerberosRealmName'] if attributes[:'kerberosRealmName']

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

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

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

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

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

  self.cluster_profile = attributes[:'clusterProfile'] if attributes[:'clusterProfile']
  self.cluster_profile = "HADOOP_EXTENDED" if cluster_profile.nil? && !attributes.key?(:'clusterProfile') # rubocop:disable Style/StringLiterals

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

  self.cluster_profile = attributes[:'cluster_profile'] if attributes[:'cluster_profile']
  self.cluster_profile = "HADOOP_EXTENDED" if cluster_profile.nil? && !attributes.key?(:'clusterProfile') && !attributes.key?(:'cluster_profile') # rubocop:disable Style/StringLiterals

  self.bds_cluster_version_summary = attributes[:'bdsClusterVersionSummary'] if attributes[:'bdsClusterVersionSummary']

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

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

Instance Attribute Details

#bds_cluster_version_summary ⇒ OCI::Bds::Models::BdsClusterVersionSummary

Returns:



83
84
85
 
# File 'lib/oci/bds/models/create_bds_instance_details.rb', line 83

def bds_cluster_version_summary
  @bds_cluster_version_summary
end

#bootstrap_script_url ⇒ String

Pre-authenticated URL of the script in Object Store that is downloaded and executed.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/bds/models/create_bds_instance_details.rb', line 52

def bootstrap_script_url
  @bootstrap_script_url
end

#cluster_admin_password ⇒ String

Base-64 encoded password for the cluster (and Cloudera Manager) admin user. Not required if the secretId is specified.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/bds/models/create_bds_instance_details.rb', line 29

def cluster_admin_password
  @cluster_admin_password
end

#cluster_profile ⇒ String

Profile of the Big Data Service cluster.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/bds/models/create_bds_instance_details.rb', line 80

def cluster_profile
  @cluster_profile
end

#cluster_public_key ⇒ String

[Required] The SSH public key used to authenticate the cluster connection.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/bds/models/create_bds_instance_details.rb', line 25

def cluster_public_key
  @cluster_public_key
end

#cluster_version ⇒ String

[Required] Version of the Hadoop distribution.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/bds/models/create_bds_instance_details.rb', line 21

def cluster_version
  @cluster_version
end

#compartment_id ⇒ String

[Required] The OCID of the compartment.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/bds/models/create_bds_instance_details.rb', line 13

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 example, {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


72
73
74
 
# File 'lib/oci/bds/models/create_bds_instance_details.rb', line 72

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] Name of the Big Data Service cluster.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/bds/models/create_bds_instance_details.rb', line 17

def display_name
  @display_name
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. For example, {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


66
67
68
 
# File 'lib/oci/bds/models/create_bds_instance_details.rb', line 66

def freeform_tags
  @freeform_tags
end

#is_high_availability ⇒ BOOLEAN

[Required] Boolean flag specifying whether or not the cluster is highly available (HA).

Returns:

  • (BOOLEAN) 


41
42
43
 
# File 'lib/oci/bds/models/create_bds_instance_details.rb', line 41

def is_high_availability
  @is_high_availability
end

#is_secret_reused ⇒ BOOLEAN

Boolean flag specifying whether or not to persist the provided secret OCID and reuse it for future operations.

Returns:

  • (BOOLEAN) 


37
38
39
 
# File 'lib/oci/bds/models/create_bds_instance_details.rb', line 37

def is_secret_reused
  @is_secret_reused
end

#is_secure ⇒ BOOLEAN

[Required] Boolean flag specifying whether or not the cluster should be set up as secure.

Returns:

  • (BOOLEAN) 


45
46
47
 
# File 'lib/oci/bds/models/create_bds_instance_details.rb', line 45

def is_secure
  @is_secure
end

#kerberos_realm_name ⇒ String

The user-defined kerberos realm name.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/bds/models/create_bds_instance_details.rb', line 60

def kerberos_realm_name
  @kerberos_realm_name
end

#kms_key_id ⇒ String

The OCID of the Key Management master encryption key.

Returns:

  • (String) 


76
77
78
 
# File 'lib/oci/bds/models/create_bds_instance_details.rb', line 76

def kms_key_id
  @kms_key_id
end

#network_config ⇒ OCI::Bds::Models::NetworkConfig

Returns:



48
49
50
 
# File 'lib/oci/bds/models/create_bds_instance_details.rb', line 48

def network_config
  @network_config
end

#nodes ⇒ Array<OCI::Bds::Models::CreateNodeDetails>

[Required] The list of nodes in the Big Data Service cluster.

Returns:



56
57
58
 
# File 'lib/oci/bds/models/create_bds_instance_details.rb', line 56

def nodes
  @nodes
end

#secret_id ⇒ String

The secretId for the clusterAdminPassword.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/bds/models/create_bds_instance_details.rb', line 33

def secret_id
  @secret_id
end

Class Method Details

.attribute_map ⇒ Object

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/oci/bds/models/create_bds_instance_details.rb', line 86

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'cluster_version': :'clusterVersion',
    'cluster_public_key': :'clusterPublicKey',
    'cluster_admin_password': :'clusterAdminPassword',
    'secret_id': :'secretId',
    'is_secret_reused': :'isSecretReused',
    'is_high_availability': :'isHighAvailability',
    'is_secure': :'isSecure',
    'network_config': :'networkConfig',
    'bootstrap_script_url': :'bootstrapScriptUrl',
    'nodes': :'nodes',
    'kerberos_realm_name': :'kerberosRealmName',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'kms_key_id': :'kmsKeyId',
    'cluster_profile': :'clusterProfile',
    'bds_cluster_version_summary': :'bdsClusterVersionSummary'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'display_name': :'String',
    'cluster_version': :'String',
    'cluster_public_key': :'String',
    'cluster_admin_password': :'String',
    'secret_id': :'String',
    'is_secret_reused': :'BOOLEAN',
    'is_high_availability': :'BOOLEAN',
    'is_secure': :'BOOLEAN',
    'network_config': :'OCI::Bds::Models::NetworkConfig',
    'bootstrap_script_url': :'String',
    'nodes': :'Array<OCI::Bds::Models::CreateNodeDetails>',
    'kerberos_realm_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'kms_key_id': :'String',
    'cluster_profile': :'String',
    'bds_cluster_version_summary': :'OCI::Bds::Models::BdsClusterVersionSummary'
    # 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



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/oci/bds/models/create_bds_instance_details.rb', line 287

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    cluster_version == other.cluster_version &&
    cluster_public_key == other.cluster_public_key &&
    cluster_admin_password == other.cluster_admin_password &&
    secret_id == other.secret_id &&
    is_secret_reused == other.is_secret_reused &&
    is_high_availability == other.is_high_availability &&
    is_secure == other.is_secure &&
    network_config == other.network_config &&
    bootstrap_script_url == other.bootstrap_script_url &&
    nodes == other.nodes &&
    kerberos_realm_name == other.kerberos_realm_name &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    kms_key_id == other.kms_key_id &&
    cluster_profile == other.cluster_profile &&
    bds_cluster_version_summary == other.bds_cluster_version_summary
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



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/oci/bds/models/create_bds_instance_details.rb', line 334

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


314
315
316
 
# File 'lib/oci/bds/models/create_bds_instance_details.rb', line 314

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



323
324
325
 
# File 'lib/oci/bds/models/create_bds_instance_details.rb', line 323

def hash
  [compartment_id, display_name, cluster_version, cluster_public_key, cluster_admin_password, secret_id, is_secret_reused, is_high_availability, is_secure, network_config, bootstrap_script_url, nodes, kerberos_realm_name, freeform_tags, defined_tags, kms_key_id, cluster_profile, bds_cluster_version_summary].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



367
368
369
370
371
372
373
374
375
376
 
# File 'lib/oci/bds/models/create_bds_instance_details.rb', line 367

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



361
362
363
 
# File 'lib/oci/bds/models/create_bds_instance_details.rb', line 361

def to_s
  to_hash.to_s
end