Class: OCI::Opensearch::Models::CreateOpensearchClusterDetails

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

Overview

The configuration details for a new OpenSearch cluster.

Constant Summary collapse

MASTER_NODE_HOST_TYPE_ENUM = 
[
  MASTER_NODE_HOST_TYPE_FLEX = 'FLEX'.freeze,
  MASTER_NODE_HOST_TYPE_BM = 'BM'.freeze
].freeze
DATA_NODE_HOST_TYPE_ENUM = 
[
  DATA_NODE_HOST_TYPE_FLEX = 'FLEX'.freeze,
  DATA_NODE_HOST_TYPE_BM = 'BM'.freeze
].freeze
SEARCH_NODE_HOST_TYPE_ENUM = 
[
  SEARCH_NODE_HOST_TYPE_FLEX = 'FLEX'.freeze
].freeze
SECURITY_MODE_ENUM = 
[
  SECURITY_MODE_DISABLED = 'DISABLED'.freeze,
  SECURITY_MODE_PERMISSIVE = 'PERMISSIVE'.freeze,
  SECURITY_MODE_ENFORCING = 'ENFORCING'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateOpensearchClusterDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



349
350
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
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_details.rb', line 349

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

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

  self.master_node_host_shape = attributes[:'master_node_host_shape'] if attributes[:'master_node_host_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_shape = attributes[:'dataNodeHostShape'] if attributes[:'dataNodeHostShape']

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

  self.data_node_host_shape = attributes[:'data_node_host_shape'] if attributes[:'data_node_host_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_host_shape = attributes[:'opendashboardNodeHostShape'] if attributes[:'opendashboardNodeHostShape']

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

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

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

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

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

  self.search_node_host_type = attributes[:'searchNodeHostType'] if attributes[:'searchNodeHostType']

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

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

  self.search_node_host_shape = attributes[:'searchNodeHostShape'] if attributes[:'searchNodeHostShape']

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

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

  self.search_node_host_ocpu_count = attributes[:'searchNodeHostOcpuCount'] if attributes[:'searchNodeHostOcpuCount']

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

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

  self.search_node_host_memory_gb = attributes[:'searchNodeHostMemoryGB'] if attributes[:'searchNodeHostMemoryGB']

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

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

  self.search_node_storage_gb = attributes[:'searchNodeStorageGB'] if attributes[:'searchNodeStorageGB']

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

  self.search_node_storage_gb = attributes[:'search_node_storage_gb'] if attributes[:'search_node_storage_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.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']

  self.security_saml_config = attributes[:'securitySamlConfig'] if attributes[:'securitySamlConfig']

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

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

  self.backup_policy = attributes[:'backupPolicy'] if attributes[:'backupPolicy']

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

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

  self.reverse_connection_endpoint_customer_ips = attributes[:'reverseConnectionEndpointCustomerIps'] if attributes[:'reverseConnectionEndpointCustomerIps']

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

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

  self.inbound_cluster_ids = attributes[:'inboundClusterIds'] if attributes[:'inboundClusterIds']

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

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

  self.outbound_cluster_config = attributes[:'outboundClusterConfig'] if attributes[:'outboundClusterConfig']

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

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

  self.maintenance_details = attributes[:'maintenanceDetails'] if attributes[:'maintenanceDetails']

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

  self.maintenance_details = attributes[:'maintenance_details'] if attributes[:'maintenance_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']
end

Instance Attribute Details

#backup_policy ⇒ OCI::Opensearch::Models::BackupPolicy

Returns:



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

def backup_policy
  @backup_policy
end

#compartment_id ⇒ String

[Required] The OCID of the compartment to create the cluster in.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_details.rb', line 37

def compartment_id
  @compartment_id
end

#data_node_count ⇒ Integer

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

Returns:

  • (Integer) 


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

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) 


77
78
79
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_details.rb', line 77

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, to configure per node for the cluster's data nodes.

Returns:

  • (Integer) 


89
90
91
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_details.rb', line 89

def data_node_host_memory_gb
  @data_node_host_memory_gb
end

#data_node_host_ocpu_count ⇒ Integer

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

Returns:

  • (Integer) 


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

def data_node_host_ocpu_count
  @data_node_host_ocpu_count
end

#data_node_host_shape ⇒ String

The node shape for the cluster's data nodes.

Returns:

  • (String) 


81
82
83
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_details.rb', line 81

def data_node_host_shape
  @data_node_host_shape
end

#data_node_host_type ⇒ String

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

Returns:

  • (String) 


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

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) 


93
94
95
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_details.rb', line 93

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


193
194
195
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_details.rb', line 193

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_details.rb', line 33

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. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


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

def freeform_tags
  @freeform_tags
end

#inbound_cluster_ids ⇒ Array<String>

List of inbound clusters that will be queried using cross cluster search

Returns:

  • (Array<String>) 


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

def inbound_cluster_ids
  @inbound_cluster_ids
end

#maintenance_details ⇒ OCI::Opensearch::Models::CreateMaintenanceDetails

Returns:



181
182
183
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_details.rb', line 181

def maintenance_details
  @maintenance_details
end

#master_node_count ⇒ Integer

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

Returns:

  • (Integer) 


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

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) 


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

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, to configure per node for the cluster's master nodes.

Returns:

  • (Integer) 


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

def master_node_host_memory_gb
  @master_node_host_memory_gb
end

#master_node_host_ocpu_count ⇒ Integer

[Required] The number of OCPUs to configure for the cluser's master nodes.

Returns:

  • (Integer) 


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

def master_node_host_ocpu_count
  @master_node_host_ocpu_count
end

#master_node_host_shape ⇒ String

The node shape for the cluster's master nodes.

Returns:

  • (String) 


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

def master_node_host_shape
  @master_node_host_shape
end

#master_node_host_type ⇒ String

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

Returns:

  • (String) 


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

def master_node_host_type
  @master_node_host_type
end

#opendashboard_node_count ⇒ Integer

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

Returns:

  • (Integer) 


101
102
103
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_details.rb', line 101

def opendashboard_node_count
  @opendashboard_node_count
end

#opendashboard_node_host_memory_gb ⇒ Integer

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

Returns:

  • (Integer) 


109
110
111
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_details.rb', line 109

def opendashboard_node_host_memory_gb
  @opendashboard_node_host_memory_gb
end

#opendashboard_node_host_ocpu_count ⇒ Integer

[Required] The number of OCPUs to configure for the cluster's OpenSearch Dashboard nodes.

Returns:

  • (Integer) 


105
106
107
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_details.rb', line 105

def opendashboard_node_host_ocpu_count
  @opendashboard_node_host_ocpu_count
end

#opendashboard_node_host_shape ⇒ String

The node shape for the cluster's OpenSearch Dashboard nodes.

Returns:

  • (String) 


97
98
99
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_details.rb', line 97

def opendashboard_node_host_shape
  @opendashboard_node_host_shape
end

#outbound_cluster_config ⇒ OCI::Opensearch::Models::OutboundClusterConfig

Returns:



178
179
180
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_details.rb', line 178

def outbound_cluster_config
  @outbound_cluster_config
end

#reverse_connection_endpoint_customer_ips ⇒ Array<String>

The customer IP addresses of the endpoint in customer VCN

Returns:

  • (Array<String>) 


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

def reverse_connection_endpoint_customer_ips
  @reverse_connection_endpoint_customer_ips
end

#search_node_count ⇒ Integer

The number of search nodes configured for the cluster.

Returns:

  • (Integer) 


113
114
115
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_details.rb', line 113

def search_node_count
  @search_node_count
end

#search_node_host_memory_gb ⇒ Integer

The amount of memory in GB, for the cluster's search nodes.

Returns:

  • (Integer) 


129
130
131
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_details.rb', line 129

def search_node_host_memory_gb
  @search_node_host_memory_gb
end

#search_node_host_ocpu_count ⇒ Integer

The number of OCPUs configured for the cluster's search nodes.

Returns:

  • (Integer) 


125
126
127
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_details.rb', line 125

def search_node_host_ocpu_count
  @search_node_host_ocpu_count
end

#search_node_host_shape ⇒ String

The node shape for the cluster's search nodes.

Returns:

  • (String) 


121
122
123
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_details.rb', line 121

def search_node_host_shape
  @search_node_host_shape
end

#search_node_host_type ⇒ String

The instance type for the cluster's search nodes.

Returns:

  • (String) 


117
118
119
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_details.rb', line 117

def search_node_host_type
  @search_node_host_type
end

#search_node_storage_gb ⇒ Integer

The amount of storage in GB, to configure per node for the cluster's search nodes.

Returns:

  • (Integer) 


133
134
135
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_details.rb', line 133

def search_node_storage_gb
  @search_node_storage_gb
end

#security_master_user_name ⇒ String

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

Returns:

  • (String) 


157
158
159
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_details.rb', line 157

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) 


161
162
163
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_details.rb', line 161

def security_master_user_password_hash
  @security_master_user_password_hash
end

#security_mode ⇒ String

The security mode of the cluster.

Returns:

  • (String) 


153
154
155
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_details.rb', line 153

def security_mode
  @security_mode
end

#security_saml_config ⇒ OCI::Opensearch::Models::SecuritySamlConfig

Returns:



164
165
166
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_details.rb', line 164

def security_saml_config
  @security_saml_config
end

#software_version ⇒ String

[Required] The version of the software the cluster is running.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_details.rb', line 41

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) 


149
150
151
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_details.rb', line 149

def subnet_compartment_id
  @subnet_compartment_id
end

#subnet_id ⇒ String

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

Returns:

  • (String) 


141
142
143
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_details.rb', line 141

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


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

def system_tags
  @system_tags
end

#vcn_compartment_id ⇒ String

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

Returns:

  • (String) 


145
146
147
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_details.rb', line 145

def vcn_compartment_id
  @vcn_compartment_id
end

#vcn_id ⇒ String

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

Returns:

  • (String) 


137
138
139
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_details.rb', line 137

def vcn_id
  @vcn_id
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'software_version': :'softwareVersion',
    'master_node_count': :'masterNodeCount',
    'master_node_host_type': :'masterNodeHostType',
    'master_node_host_bare_metal_shape': :'masterNodeHostBareMetalShape',
    'master_node_host_shape': :'masterNodeHostShape',
    '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_shape': :'dataNodeHostShape',
    'data_node_host_ocpu_count': :'dataNodeHostOcpuCount',
    'data_node_host_memory_gb': :'dataNodeHostMemoryGB',
    'data_node_storage_gb': :'dataNodeStorageGB',
    'opendashboard_node_host_shape': :'opendashboardNodeHostShape',
    'opendashboard_node_count': :'opendashboardNodeCount',
    'opendashboard_node_host_ocpu_count': :'opendashboardNodeHostOcpuCount',
    'opendashboard_node_host_memory_gb': :'opendashboardNodeHostMemoryGB',
    'search_node_count': :'searchNodeCount',
    'search_node_host_type': :'searchNodeHostType',
    'search_node_host_shape': :'searchNodeHostShape',
    'search_node_host_ocpu_count': :'searchNodeHostOcpuCount',
    'search_node_host_memory_gb': :'searchNodeHostMemoryGB',
    'search_node_storage_gb': :'searchNodeStorageGB',
    'vcn_id': :'vcnId',
    'subnet_id': :'subnetId',
    'vcn_compartment_id': :'vcnCompartmentId',
    'subnet_compartment_id': :'subnetCompartmentId',
    'security_mode': :'securityMode',
    'security_master_user_name': :'securityMasterUserName',
    'security_master_user_password_hash': :'securityMasterUserPasswordHash',
    'security_saml_config': :'securitySamlConfig',
    'backup_policy': :'backupPolicy',
    'reverse_connection_endpoint_customer_ips': :'reverseConnectionEndpointCustomerIps',
    'inbound_cluster_ids': :'inboundClusterIds',
    'outbound_cluster_config': :'outboundClusterConfig',
    'maintenance_details': :'maintenanceDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/oci/opensearch/models/create_opensearch_cluster_details.rb', line 252

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'compartment_id': :'String',
    'software_version': :'String',
    'master_node_count': :'Integer',
    'master_node_host_type': :'String',
    'master_node_host_bare_metal_shape': :'String',
    'master_node_host_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_shape': :'String',
    'data_node_host_ocpu_count': :'Integer',
    'data_node_host_memory_gb': :'Integer',
    'data_node_storage_gb': :'Integer',
    'opendashboard_node_host_shape': :'String',
    'opendashboard_node_count': :'Integer',
    'opendashboard_node_host_ocpu_count': :'Integer',
    'opendashboard_node_host_memory_gb': :'Integer',
    'search_node_count': :'Integer',
    'search_node_host_type': :'String',
    'search_node_host_shape': :'String',
    'search_node_host_ocpu_count': :'Integer',
    'search_node_host_memory_gb': :'Integer',
    'search_node_storage_gb': :'Integer',
    'vcn_id': :'String',
    'subnet_id': :'String',
    'vcn_compartment_id': :'String',
    'subnet_compartment_id': :'String',
    'security_mode': :'String',
    'security_master_user_name': :'String',
    'security_master_user_password_hash': :'String',
    'security_saml_config': :'OCI::Opensearch::Models::SecuritySamlConfig',
    'backup_policy': :'OCI::Opensearch::Models::BackupPolicy',
    'reverse_connection_endpoint_customer_ips': :'Array<String>',
    'inbound_cluster_ids': :'Array<String>',
    'outbound_cluster_config': :'OCI::Opensearch::Models::OutboundClusterConfig',
    'maintenance_details': :'OCI::Opensearch::Models::CreateMaintenanceDetails',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'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



647
648
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/create_opensearch_cluster_details.rb', line 647

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

  self.class == other.class &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    software_version == other.software_version &&
    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_shape == other.master_node_host_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_shape == other.data_node_host_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_host_shape == other.opendashboard_node_host_shape &&
    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 &&
    search_node_count == other.search_node_count &&
    search_node_host_type == other.search_node_host_type &&
    search_node_host_shape == other.search_node_host_shape &&
    search_node_host_ocpu_count == other.search_node_host_ocpu_count &&
    search_node_host_memory_gb == other.search_node_host_memory_gb &&
    search_node_storage_gb == other.search_node_storage_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 &&
    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 &&
    security_saml_config == other.security_saml_config &&
    backup_policy == other.backup_policy &&
    reverse_connection_endpoint_customer_ips == other.reverse_connection_endpoint_customer_ips &&
    inbound_cluster_ids == other.inbound_cluster_ids &&
    outbound_cluster_config == other.outbound_cluster_config &&
    maintenance_details == other.maintenance_details &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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/create_opensearch_cluster_details.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/create_opensearch_cluster_details.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/create_opensearch_cluster_details.rb', line 707

def hash
  [display_name, compartment_id, software_version, master_node_count, master_node_host_type, master_node_host_bare_metal_shape, master_node_host_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_shape, data_node_host_ocpu_count, data_node_host_memory_gb, data_node_storage_gb, opendashboard_node_host_shape, opendashboard_node_count, opendashboard_node_host_ocpu_count, opendashboard_node_host_memory_gb, search_node_count, search_node_host_type, search_node_host_shape, search_node_host_ocpu_count, search_node_host_memory_gb, search_node_storage_gb, vcn_id, subnet_id, vcn_compartment_id, subnet_compartment_id, security_mode, security_master_user_name, security_master_user_password_hash, security_saml_config, backup_policy, reverse_connection_endpoint_customer_ips, inbound_cluster_ids, outbound_cluster_config, maintenance_details, freeform_tags, defined_tags, system_tags].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/create_opensearch_cluster_details.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/create_opensearch_cluster_details.rb', line 745

def to_s
  to_hash.to_s
end