Class: OCI::Opensearch::Models::OpensearchCluster

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

Overview

An OpenSearch cluster resource. An OpenSearch cluster is set of instances that provide OpenSearch functionality in OCI Search Service with OpenSearch. For more information, see About Search Service with OpenSearch.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
MASTER_NODE_HOST_TYPE_ENUM = 
[
  MASTER_NODE_HOST_TYPE_FLEX = 'FLEX'.freeze,
  MASTER_NODE_HOST_TYPE_BM = 'BM'.freeze,
  MASTER_NODE_HOST_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
DATA_NODE_HOST_TYPE_ENUM = 
[
  DATA_NODE_HOST_TYPE_FLEX = 'FLEX'.freeze,
  DATA_NODE_HOST_TYPE_BM = 'BM'.freeze,
  DATA_NODE_HOST_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
SECURITY_MODE_ENUM = 
[
  SECURITY_MODE_DISABLED = 'DISABLED'.freeze,
  SECURITY_MODE_PERMISSIVE = 'PERMISSIVE'.freeze,
  SECURITY_MODE_ENFORCING = 'ENFORCING'.freeze,
  SECURITY_MODE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OpensearchCluster

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 351

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.id = attributes[:'id'] if attributes[:'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.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.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.time_deleted = attributes[:'timeDeleted'] if attributes[:'timeDeleted']

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

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

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

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

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

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

  self.total_storage_gb = attributes[:'totalStorageGB'] if attributes[:'totalStorageGB']

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

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

  self.opensearch_fqdn = attributes[:'opensearchFqdn'] if attributes[:'opensearchFqdn']

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

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

  self.opensearch_private_ip = attributes[:'opensearchPrivateIp'] if attributes[:'opensearchPrivateIp']

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

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

  self.opendashboard_fqdn = attributes[:'opendashboardFqdn'] if attributes[:'opendashboardFqdn']

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

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

  self.opendashboard_private_ip = attributes[:'opendashboardPrivateIp'] if attributes[:'opendashboardPrivateIp']

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

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

  self.master_node_count = attributes[:'masterNodeCount'] if attributes[:'masterNodeCount']

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

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

  self.master_node_host_type = attributes[:'masterNodeHostType'] if attributes[:'masterNodeHostType']

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

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

  self.master_node_host_bare_metal_shape = attributes[:'masterNodeHostBareMetalShape'] if attributes[:'masterNodeHostBareMetalShape']

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

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

  self.master_node_host_ocpu_count = attributes[:'masterNodeHostOcpuCount'] if attributes[:'masterNodeHostOcpuCount']

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

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

  self.master_node_host_memory_gb = attributes[:'masterNodeHostMemoryGB'] if attributes[:'masterNodeHostMemoryGB']

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

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

  self.data_node_count = attributes[:'dataNodeCount'] if attributes[:'dataNodeCount']

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

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

  self.data_node_host_type = attributes[:'dataNodeHostType'] if attributes[:'dataNodeHostType']

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

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

  self.data_node_host_bare_metal_shape = attributes[:'dataNodeHostBareMetalShape'] if attributes[:'dataNodeHostBareMetalShape']

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

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

  self.data_node_host_ocpu_count = attributes[:'dataNodeHostOcpuCount'] if attributes[:'dataNodeHostOcpuCount']

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

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

  self.data_node_host_memory_gb = attributes[:'dataNodeHostMemoryGB'] if attributes[:'dataNodeHostMemoryGB']

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

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

  self.data_node_storage_gb = attributes[:'dataNodeStorageGB'] if attributes[:'dataNodeStorageGB']

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

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

  self.opendashboard_node_count = attributes[:'opendashboardNodeCount'] if attributes[:'opendashboardNodeCount']

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

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

  self.opendashboard_node_host_ocpu_count = attributes[:'opendashboardNodeHostOcpuCount'] if attributes[:'opendashboardNodeHostOcpuCount']

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

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

  self.opendashboard_node_host_memory_gb = attributes[:'opendashboardNodeHostMemoryGB'] if attributes[:'opendashboardNodeHostMemoryGB']

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

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

  self.vcn_id = attributes[:'vcnId'] if attributes[:'vcnId']

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

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

  self.subnet_id = attributes[:'subnetId'] if attributes[:'subnetId']

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

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

  self.vcn_compartment_id = attributes[:'vcnCompartmentId'] if attributes[:'vcnCompartmentId']

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

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

  self.subnet_compartment_id = attributes[:'subnetCompartmentId'] if attributes[:'subnetCompartmentId']

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

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

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

  self.availability_domains = attributes[:'availabilityDomains'] if attributes[:'availabilityDomains']

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

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

  self.security_mode = attributes[:'securityMode'] if attributes[:'securityMode']

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

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

  self.security_master_user_name = attributes[:'securityMasterUserName'] if attributes[:'securityMasterUserName']

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

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

  self.security_master_user_password_hash = attributes[:'securityMasterUserPasswordHash'] if attributes[:'securityMasterUserPasswordHash']

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

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

Instance Attribute Details

#availability_domains ⇒ Array<String>

[Required] The availability domains to distribute the cluser nodes across.

Returns:

  • (Array<String>) 


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

def availability_domains
  @availability_domains
end

#compartment_id ⇒ String

[Required] The OCID of the compartment where the cluster is located.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 53

def compartment_id
  @compartment_id
end

#data_node_count ⇒ Integer

[Required] The number of data nodes configured for the cluster.

Returns:

  • (Integer) 


139
140
141
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 139

def data_node_count
  @data_node_count
end

#data_node_host_bare_metal_shape ⇒ String

The bare metal shape for the cluster's data nodes.

Returns:

  • (String) 


147
148
149
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 147

def data_node_host_bare_metal_shape
  @data_node_host_bare_metal_shape
end

#data_node_host_memory_gb ⇒ Integer

[Required] The amount of memory in GB, for the cluster's data nodes.

Returns:

  • (Integer) 


155
156
157
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 155

def data_node_host_memory_gb
  @data_node_host_memory_gb
end

#data_node_host_ocpu_count ⇒ Integer

[Required] The number of OCPUs configured for the cluster's data nodes.

Returns:

  • (Integer) 


151
152
153
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 151

def data_node_host_ocpu_count
  @data_node_host_ocpu_count
end

#data_node_host_type ⇒ String

[Required] The instance type for the cluster's data nodes.

Returns:

  • (String) 


143
144
145
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 143

def data_node_host_type
  @data_node_host_type
end

#data_node_storage_gb ⇒ Integer

[Required] The amount of storage in GB, to configure per node for the cluster's data nodes.

Returns:

  • (Integer) 


159
160
161
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 159

def data_node_storage_gb
  @data_node_storage_gb
end

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


85
86
87
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 85

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] The name of the cluster. Avoid entering confidential information.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 49

def display_name
  @display_name
end

#fqdn ⇒ String

The fully qualified domain name (FQDN) for the cluster's API endpoint.

Returns:

  • (String) 


191
192
193
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 191

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


79
80
81
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 79

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the cluster.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 45

def id
  @id
end

#lifecycle_details ⇒ String

Additional information about the current lifecycle state of the cluster.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 73

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the cluster.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 57

def lifecycle_state
  @lifecycle_state
end

#master_node_count ⇒ Integer

[Required] The number of master nodes configured for the cluster.

Returns:

  • (Integer) 


119
120
121
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 119

def master_node_count
  @master_node_count
end

#master_node_host_bare_metal_shape ⇒ String

The bare metal shape for the cluster's master nodes.

Returns:

  • (String) 


127
128
129
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 127

def master_node_host_bare_metal_shape
  @master_node_host_bare_metal_shape
end

#master_node_host_memory_gb ⇒ Integer

[Required] The amount of memory in GB, for the cluster's master nodes.

Returns:

  • (Integer) 


135
136
137
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 135

def master_node_host_memory_gb
  @master_node_host_memory_gb
end

#master_node_host_ocpu_count ⇒ Integer

[Required] The number of OCPUs configured for cluster's master nodes.

Returns:

  • (Integer) 


131
132
133
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 131

def master_node_host_ocpu_count
  @master_node_host_ocpu_count
end

#master_node_host_type ⇒ String

[Required] The instance type for the cluster's master nodes.

Returns:

  • (String) 


123
124
125
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 123

def master_node_host_type
  @master_node_host_type
end

#opendashboard_fqdn ⇒ String

[Required] The fully qualified domain name (FQDN) for the cluster's OpenSearch Dashboard API endpoint.

Returns:

  • (String) 


111
112
113
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 111

def opendashboard_fqdn
  @opendashboard_fqdn
end

#opendashboard_node_count ⇒ Integer

[Required] The number of OpenSearch Dashboard nodes configured for the cluster.

Returns:

  • (Integer) 


163
164
165
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 163

def opendashboard_node_count
  @opendashboard_node_count
end

#opendashboard_node_host_memory_gb ⇒ Integer

[Required] The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.

Returns:

  • (Integer) 


171
172
173
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 171

def opendashboard_node_host_memory_gb
  @opendashboard_node_host_memory_gb
end

#opendashboard_node_host_ocpu_count ⇒ Integer

[Required] The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.

Returns:

  • (Integer) 


167
168
169
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 167

def opendashboard_node_host_ocpu_count
  @opendashboard_node_host_ocpu_count
end

#opendashboard_private_ip ⇒ String

[Required] The private IP address for the cluster's OpenSearch Dashboard.

Returns:

  • (String) 


115
116
117
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 115

def opendashboard_private_ip
  @opendashboard_private_ip
end

#opensearch_fqdn ⇒ String

[Required] The fully qualified domain name (FQDN) for the cluster's API endpoint.

Returns:

  • (String) 


103
104
105
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 103

def opensearch_fqdn
  @opensearch_fqdn
end

#opensearch_private_ip ⇒ String

[Required] The cluster's private IP address.

Returns:

  • (String) 


107
108
109
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 107

def opensearch_private_ip
  @opensearch_private_ip
end

#security_master_user_name ⇒ String

The name of the master user that are used to manage security config

Returns:

  • (String) 


203
204
205
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 203

def security_master_user_name
  @security_master_user_name
end

#security_master_user_password_hash ⇒ String

The password hash of the master user that are used to manage security config

Returns:

  • (String) 


207
208
209
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 207

def security_master_user_password_hash
  @security_master_user_password_hash
end

#security_mode ⇒ String

The security mode of the cluster.

Returns:

  • (String) 


199
200
201
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 199

def security_mode
  @security_mode
end

#software_version ⇒ String

[Required] The software version the cluster is running.

Returns:

  • (String) 


95
96
97
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 95

def software_version
  @software_version
end

#subnet_compartment_id ⇒ String

[Required] The OCID for the compartment where the cluster's subnet is located.

Returns:

  • (String) 


187
188
189
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 187

def subnet_compartment_id
  @subnet_compartment_id
end

#subnet_id ⇒ String

[Required] The OCID of the cluster's subnet.

Returns:

  • (String) 


179
180
181
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 179

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


91
92
93
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 91

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The amount of time in milliseconds since the cluster was created.

Returns:

  • (DateTime) 


61
62
63
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 61

def time_created
  @time_created
end

#time_deleted ⇒ DateTime

The amount of time in milliseconds since the cluster was updated.

Returns:

  • (DateTime) 


69
70
71
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 69

def time_deleted
  @time_deleted
end

#time_updated ⇒ DateTime

The amount of time in milliseconds since the cluster was updated.

Returns:

  • (DateTime) 


65
66
67
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 65

def time_updated
  @time_updated
end

#total_storage_gb ⇒ Integer

[Required] The size in GB of the cluster's total storage.

Returns:

  • (Integer) 


99
100
101
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 99

def total_storage_gb
  @total_storage_gb
end

#vcn_compartment_id ⇒ String

[Required] The OCID for the compartment where the cluster's VCN is located.

Returns:

  • (String) 


183
184
185
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 183

def vcn_compartment_id
  @vcn_compartment_id
end

#vcn_id ⇒ String

[Required] The OCID of the cluster's VCN.

Returns:

  • (String) 


175
176
177
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 175

def vcn_id
  @vcn_id
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 210

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'time_deleted': :'timeDeleted',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'software_version': :'softwareVersion',
    'total_storage_gb': :'totalStorageGB',
    'opensearch_fqdn': :'opensearchFqdn',
    'opensearch_private_ip': :'opensearchPrivateIp',
    'opendashboard_fqdn': :'opendashboardFqdn',
    'opendashboard_private_ip': :'opendashboardPrivateIp',
    'master_node_count': :'masterNodeCount',
    'master_node_host_type': :'masterNodeHostType',
    'master_node_host_bare_metal_shape': :'masterNodeHostBareMetalShape',
    'master_node_host_ocpu_count': :'masterNodeHostOcpuCount',
    'master_node_host_memory_gb': :'masterNodeHostMemoryGB',
    'data_node_count': :'dataNodeCount',
    'data_node_host_type': :'dataNodeHostType',
    'data_node_host_bare_metal_shape': :'dataNodeHostBareMetalShape',
    'data_node_host_ocpu_count': :'dataNodeHostOcpuCount',
    'data_node_host_memory_gb': :'dataNodeHostMemoryGB',
    'data_node_storage_gb': :'dataNodeStorageGB',
    'opendashboard_node_count': :'opendashboardNodeCount',
    'opendashboard_node_host_ocpu_count': :'opendashboardNodeHostOcpuCount',
    'opendashboard_node_host_memory_gb': :'opendashboardNodeHostMemoryGB',
    'vcn_id': :'vcnId',
    'subnet_id': :'subnetId',
    'vcn_compartment_id': :'vcnCompartmentId',
    'subnet_compartment_id': :'subnetCompartmentId',
    'fqdn': :'fqdn',
    'availability_domains': :'availabilityDomains',
    'security_mode': :'securityMode',
    'security_master_user_name': :'securityMasterUserName',
    'security_master_user_password_hash': :'securityMasterUserPasswordHash'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 258

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'time_deleted': :'DateTime',
    'lifecycle_details': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'software_version': :'String',
    'total_storage_gb': :'Integer',
    'opensearch_fqdn': :'String',
    'opensearch_private_ip': :'String',
    'opendashboard_fqdn': :'String',
    'opendashboard_private_ip': :'String',
    'master_node_count': :'Integer',
    'master_node_host_type': :'String',
    'master_node_host_bare_metal_shape': :'String',
    'master_node_host_ocpu_count': :'Integer',
    'master_node_host_memory_gb': :'Integer',
    'data_node_count': :'Integer',
    'data_node_host_type': :'String',
    'data_node_host_bare_metal_shape': :'String',
    'data_node_host_ocpu_count': :'Integer',
    'data_node_host_memory_gb': :'Integer',
    'data_node_storage_gb': :'Integer',
    'opendashboard_node_count': :'Integer',
    'opendashboard_node_host_ocpu_count': :'Integer',
    'opendashboard_node_host_memory_gb': :'Integer',
    'vcn_id': :'String',
    'subnet_id': :'String',
    'vcn_compartment_id': :'String',
    'subnet_compartment_id': :'String',
    'fqdn': :'String',
    'availability_domains': :'Array<String>',
    'security_mode': :'String',
    'security_master_user_name': :'String',
    'security_master_user_password_hash': :'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



649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 649

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    time_deleted == other.time_deleted &&
    lifecycle_details == other.lifecycle_details &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    software_version == other.software_version &&
    total_storage_gb == other.total_storage_gb &&
    opensearch_fqdn == other.opensearch_fqdn &&
    opensearch_private_ip == other.opensearch_private_ip &&
    opendashboard_fqdn == other.opendashboard_fqdn &&
    opendashboard_private_ip == other.opendashboard_private_ip &&
    master_node_count == other.master_node_count &&
    master_node_host_type == other.master_node_host_type &&
    master_node_host_bare_metal_shape == other.master_node_host_bare_metal_shape &&
    master_node_host_ocpu_count == other.master_node_host_ocpu_count &&
    master_node_host_memory_gb == other.master_node_host_memory_gb &&
    data_node_count == other.data_node_count &&
    data_node_host_type == other.data_node_host_type &&
    data_node_host_bare_metal_shape == other.data_node_host_bare_metal_shape &&
    data_node_host_ocpu_count == other.data_node_host_ocpu_count &&
    data_node_host_memory_gb == other.data_node_host_memory_gb &&
    data_node_storage_gb == other.data_node_storage_gb &&
    opendashboard_node_count == other.opendashboard_node_count &&
    opendashboard_node_host_ocpu_count == other.opendashboard_node_host_ocpu_count &&
    opendashboard_node_host_memory_gb == other.opendashboard_node_host_memory_gb &&
    vcn_id == other.vcn_id &&
    subnet_id == other.subnet_id &&
    vcn_compartment_id == other.vcn_compartment_id &&
    subnet_compartment_id == other.subnet_compartment_id &&
    fqdn == other.fqdn &&
    availability_domains == other.availability_domains &&
    security_mode == other.security_mode &&
    security_master_user_name == other.security_master_user_name &&
    security_master_user_password_hash == other.security_master_user_password_hash
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



718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 718

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


698
699
700
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 698

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



707
708
709
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 707

def hash
  [id, display_name, compartment_id, lifecycle_state, time_created, time_updated, time_deleted, lifecycle_details, freeform_tags, defined_tags, system_tags, software_version, total_storage_gb, opensearch_fqdn, opensearch_private_ip, opendashboard_fqdn, opendashboard_private_ip, master_node_count, master_node_host_type, master_node_host_bare_metal_shape, master_node_host_ocpu_count, master_node_host_memory_gb, data_node_count, data_node_host_type, data_node_host_bare_metal_shape, data_node_host_ocpu_count, data_node_host_memory_gb, data_node_storage_gb, opendashboard_node_count, opendashboard_node_host_ocpu_count, opendashboard_node_host_memory_gb, vcn_id, subnet_id, vcn_compartment_id, subnet_compartment_id, fqdn, availability_domains, security_mode, security_master_user_name, security_master_user_password_hash].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



751
752
753
754
755
756
757
758
759
760
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 751

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



745
746
747
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 745

def to_s
  to_hash.to_s
end