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
SEARCH_NODE_HOST_TYPE_ENUM = 
[
  SEARCH_NODE_HOST_TYPE_FLEX = 'FLEX'.freeze,
  SEARCH_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):



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
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
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
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 464

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_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.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.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.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']

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

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

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

  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.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.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']
end

Instance Attribute Details

#availability_domains ⇒ Array<String>

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

Returns:

  • (Array<String>) 


236
237
238
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 236

def availability_domains
  @availability_domains
end

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

Returns:



254
255
256
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 254

def backup_policy
  @backup_policy
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#data_node_count ⇒ Integer

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

Returns:

  • (Integer) 


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

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) 


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

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) 


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

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) 


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

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) 


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

def data_node_host_shape
  @data_node_host_shape
end

#data_node_host_type ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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


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

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

def display_name
  @display_name
end

#fqdn ⇒ String

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

Returns:

  • (String) 


232
233
234
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 232

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


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the cluster.

Returns:

  • (String) 


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

def id
  @id
end

#inbound_cluster_ids ⇒ Array<String>

List of inbound clusters for which this cluster is an outbound cluster

Returns:

  • (Array<String>) 


269
270
271
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 269

def inbound_cluster_ids
  @inbound_cluster_ids
end

#lifecycle_details ⇒ String

Additional information about the current lifecycle state of the cluster.

Returns:

  • (String) 


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the cluster.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#maintenance_details ⇒ OCI::Opensearch::Models::MaintenanceDetails

Returns:



272
273
274
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 272

def maintenance_details
  @maintenance_details
end

#master_node_count ⇒ Integer

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

Returns:

  • (Integer) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

def opendashboard_fqdn
  @opendashboard_fqdn
end

#opendashboard_node_count ⇒ Integer

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

Returns:

  • (Integer) 


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

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) 


212
213
214
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 212

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) 


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

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) 


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

def opendashboard_node_host_shape
  @opendashboard_node_host_shape
end

#opendashboard_private_ip ⇒ String

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

Returns:

  • (String) 


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

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) 


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

def opensearch_fqdn
  @opensearch_fqdn
end

#opensearch_private_ip ⇒ String

[Required] The cluster's private IP address.

Returns:

  • (String) 


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

def opensearch_private_ip
  @opensearch_private_ip
end

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

Returns:



265
266
267
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 265

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


258
259
260
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 258

def reverse_connection_endpoint_customer_ips
  @reverse_connection_endpoint_customer_ips
end

#reverse_connection_endpoints ⇒ Array<OCI::Opensearch::Models::ReverseConnectionEndpoint>

The list of reverse connection endpoints.

Returns:



262
263
264
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 262

def reverse_connection_endpoints
  @reverse_connection_endpoints
end

#search_node_count ⇒ Integer

The number of search nodes configured for the cluster.

Returns:

  • (Integer) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


244
245
246
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 244

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) 


248
249
250
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 248

def security_master_user_password_hash
  @security_master_user_password_hash
end

#security_mode ⇒ String

The security mode of the cluster.

Returns:

  • (String) 


240
241
242
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 240

def security_mode
  @security_mode
end

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

Returns:



251
252
253
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 251

def security_saml_config
  @security_saml_config
end

#software_version ⇒ String

[Required] The software version the cluster is running.

Returns:

  • (String) 


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

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) 


228
229
230
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 228

def subnet_compartment_id
  @subnet_compartment_id
end

#subnet_id ⇒ String

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

Returns:

  • (String) 


220
221
222
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 220

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


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

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_deleted ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_deleted
  @time_deleted
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

#total_storage_gb ⇒ Integer

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

Returns:

  • (Integer) 


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

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) 


224
225
226
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 224

def vcn_compartment_id
  @vcn_compartment_id
end

#vcn_id ⇒ String

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

Returns:

  • (String) 


216
217
218
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 216

def vcn_id
  @vcn_id
end

Class Method Details

.attribute_map ⇒ Object

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



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
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 275

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_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',
    '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',
    'opendashboard_node_host_shape': :'opendashboardNodeHostShape',
    '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',
    'security_saml_config': :'securitySamlConfig',
    'backup_policy': :'backupPolicy',
    'reverse_connection_endpoint_customer_ips': :'reverseConnectionEndpointCustomerIps',
    'reverse_connection_endpoints': :'reverseConnectionEndpoints',
    'outbound_cluster_config': :'outboundClusterConfig',
    'inbound_cluster_ids': :'inboundClusterIds',
    'maintenance_details': :'maintenanceDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



339
340
341
342
343
344
345
346
347
348
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
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 339

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_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',
    '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',
    'opendashboard_node_host_shape': :'String',
    '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',
    'security_saml_config': :'OCI::Opensearch::Models::SecuritySamlConfig',
    'backup_policy': :'OCI::Opensearch::Models::BackupPolicy',
    'reverse_connection_endpoint_customer_ips': :'Array<String>',
    'reverse_connection_endpoints': :'Array<OCI::Opensearch::Models::ReverseConnectionEndpoint>',
    'outbound_cluster_config': :'OCI::Opensearch::Models::OutboundClusterConfig',
    'inbound_cluster_ids': :'Array<String>',
    'maintenance_details': :'OCI::Opensearch::Models::MaintenanceDetails'
    # 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



871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 871

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_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 &&
    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 &&
    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 &&
    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 &&
    security_saml_config == other.security_saml_config &&
    backup_policy == other.backup_policy &&
    reverse_connection_endpoint_customer_ips == other.reverse_connection_endpoint_customer_ips &&
    reverse_connection_endpoints == other.reverse_connection_endpoints &&
    outbound_cluster_config == other.outbound_cluster_config &&
    inbound_cluster_ids == other.inbound_cluster_ids &&
    maintenance_details == other.maintenance_details
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



956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 956

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


936
937
938
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 936

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



945
946
947
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 945

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_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, 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, opendashboard_node_host_shape, 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, security_saml_config, backup_policy, reverse_connection_endpoint_customer_ips, reverse_connection_endpoints, outbound_cluster_config, inbound_cluster_ids, maintenance_details].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



989
990
991
992
993
994
995
996
997
998
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 989

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



983
984
985
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 983

def to_s
  to_hash.to_s
end