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
COORDINATOR_NODE_HOST_TYPE_ENUM = 
[
  COORDINATOR_NODE_HOST_TYPE_FLEX = 'FLEX'.freeze,
  COORDINATOR_NODE_HOST_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
ML_NODE_HOST_TYPE_ENUM = 
[
  ML_NODE_HOST_TYPE_FLEX = 'FLEX'.freeze,
  ML_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):



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
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
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
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 581

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

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

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

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

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

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

  self.coordinator_node_host_type = attributes[:'coordinatorNodeHostType'] if attributes[:'coordinatorNodeHostType']

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

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

  self.coordinator_node_host_shape = attributes[:'coordinatorNodeHostShape'] if attributes[:'coordinatorNodeHostShape']

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

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

  self.coordinator_node_host_ocpu_count = attributes[:'coordinatorNodeHostOcpuCount'] if attributes[:'coordinatorNodeHostOcpuCount']

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

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

  self.coordinator_node_host_memory_gb = attributes[:'coordinatorNodeHostMemoryGB'] if attributes[:'coordinatorNodeHostMemoryGB']

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

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

  self.ml_node_count = attributes[:'mlNodeCount'] if attributes[:'mlNodeCount']

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

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

  self.ml_node_host_type = attributes[:'mlNodeHostType'] if attributes[:'mlNodeHostType']

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

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

  self.ml_node_host_shape = attributes[:'mlNodeHostShape'] if attributes[:'mlNodeHostShape']

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

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

  self.ml_node_host_ocpu_count = attributes[:'mlNodeHostOcpuCount'] if attributes[:'mlNodeHostOcpuCount']

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

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

  self.ml_node_host_memory_gb = attributes[:'mlNodeHostMemoryGB'] if attributes[:'mlNodeHostMemoryGB']

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

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

  self.ml_node_storage_gb = attributes[:'mlNodeStorageGB'] if attributes[:'mlNodeStorageGB']

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

  self.ml_node_storage_gb = attributes[:'ml_node_storage_gb'] if attributes[:'ml_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.nsg_id = attributes[:'nsgId'] if attributes[:'nsgId']

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

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

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

  self.load_balancer_config = attributes[:'loadBalancerConfig'] if attributes[:'loadBalancerConfig']

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

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

  self.certificate_config = attributes[:'certificateConfig'] if attributes[:'certificateConfig']

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

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

Instance Attribute Details

#availability_domains ⇒ Array<String>

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

Returns:

  • (Array<String>) 


298
299
300
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 298

def availability_domains
  @availability_domains
end

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

Returns:



316
317
318
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 316

def backup_policy
  @backup_policy
end

#certificate_config ⇒ OCI::Opensearch::Models::CertificateConfig

Returns:



344
345
346
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 344

def certificate_config
  @certificate_config
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#coordinator_node_count ⇒ Integer

The number of coordinator nodes configured for the cluster.

Returns:

  • (Integer) 


218
219
220
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 218

def coordinator_node_count
  @coordinator_node_count
end

#coordinator_node_host_memory_gb ⇒ Integer

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

Returns:

  • (Integer) 


234
235
236
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 234

def coordinator_node_host_memory_gb
  @coordinator_node_host_memory_gb
end

#coordinator_node_host_ocpu_count ⇒ Integer

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

Returns:

  • (Integer) 


230
231
232
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 230

def coordinator_node_host_ocpu_count
  @coordinator_node_host_ocpu_count
end

#coordinator_node_host_shape ⇒ String

The node shape for the cluster's coordinator nodes.

Returns:

  • (String) 


226
227
228
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 226

def coordinator_node_host_shape
  @coordinator_node_host_shape
end

#coordinator_node_host_type ⇒ String

The instance type for the cluster's coordinator nodes.

Returns:

  • (String) 


222
223
224
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 222

def coordinator_node_host_type
  @coordinator_node_host_type
end

#data_node_count ⇒ Integer

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

Returns:

  • (Integer) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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


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

def defined_tags
  @defined_tags
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

def display_name
  @display_name
end

#fqdn ⇒ String

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

Returns:

  • (String) 


294
295
296
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 294

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


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the cluster.

Returns:

  • (String) 


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

def id
  @id
end

#inbound_cluster_ids ⇒ Array<String>

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

Returns:

  • (Array<String>) 


335
336
337
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 335

def inbound_cluster_ids
  @inbound_cluster_ids
end

#lifecycle_details ⇒ String

Additional information about the current lifecycle state of the cluster.

Returns:

  • (String) 


88
89
90
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 88

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the cluster.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#load_balancer_config ⇒ OCI::Opensearch::Models::LoadBalancerConfig

Returns:



341
342
343
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 341

def load_balancer_config
  @load_balancer_config
end

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

Returns:



338
339
340
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 338

def maintenance_details
  @maintenance_details
end

#master_node_count ⇒ Integer

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

Returns:

  • (Integer) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

def master_node_host_type
  @master_node_host_type
end

#ml_node_count ⇒ Integer

The number of ML nodes configured for the cluster.

Returns:

  • (Integer) 


238
239
240
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 238

def ml_node_count
  @ml_node_count
end

#ml_node_host_memory_gb ⇒ Integer

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

Returns:

  • (Integer) 


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

def ml_node_host_memory_gb
  @ml_node_host_memory_gb
end

#ml_node_host_ocpu_count ⇒ Integer

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

Returns:

  • (Integer) 


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

def ml_node_host_ocpu_count
  @ml_node_host_ocpu_count
end

#ml_node_host_shape ⇒ String

The node shape for the cluster's ML nodes.

Returns:

  • (String) 


246
247
248
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 246

def ml_node_host_shape
  @ml_node_host_shape
end

#ml_node_host_type ⇒ String

The instance type for the cluster's ML nodes.

Returns:

  • (String) 


242
243
244
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 242

def ml_node_host_type
  @ml_node_host_type
end

#ml_node_storage_gb ⇒ Integer

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

Returns:

  • (Integer) 


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

def ml_node_storage_gb
  @ml_node_storage_gb
end

#nsg_id ⇒ String

The OCID of the NSG where the private endpoint vnic will be attached.

Returns:

  • (String) 


320
321
322
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 320

def nsg_id
  @nsg_id
end

#opendashboard_fqdn ⇒ String

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

Returns:

  • (String) 


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

def opendashboard_fqdn
  @opendashboard_fqdn
end

#opendashboard_node_count ⇒ Integer

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

Returns:

  • (Integer) 


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

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) 


274
275
276
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 274

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) 


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

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) 


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

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) 


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

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) 


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

def opensearch_fqdn
  @opensearch_fqdn
end

#opensearch_private_ip ⇒ String

[Required] The cluster's private IP address.

Returns:

  • (String) 


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

def opensearch_private_ip
  @opensearch_private_ip
end

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

Returns:



331
332
333
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 331

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


324
325
326
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 324

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:



328
329
330
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 328

def reverse_connection_endpoints
  @reverse_connection_endpoints
end

#search_node_count ⇒ Integer

The number of search nodes configured for the cluster.

Returns:

  • (Integer) 


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

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) 


210
211
212
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 210

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) 


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

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) 


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

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) 


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

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) 


214
215
216
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 214

def search_node_storage_gb
  @search_node_storage_gb
end

#security_attributes ⇒ Hash<String, Hash<String, Object>>

Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Oracle-ZPR\": {\"MaxEgressCount\": {\"value\": \"42\", \"mode\": \"enforce\"}}}

Returns:

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


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

def security_attributes
  @security_attributes
end

#security_master_user_name ⇒ String

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

Returns:

  • (String) 


306
307
308
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 306

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) 


310
311
312
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 310

def security_master_user_password_hash
  @security_master_user_password_hash
end

#security_mode ⇒ String

The security mode of the cluster.

Returns:

  • (String) 


302
303
304
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 302

def security_mode
  @security_mode
end

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

Returns:



313
314
315
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 313

def security_saml_config
  @security_saml_config
end

#software_version ⇒ String

[Required] The software version the cluster is running.

Returns:

  • (String) 


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

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) 


290
291
292
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 290

def subnet_compartment_id
  @subnet_compartment_id
end

#subnet_id ⇒ String

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

Returns:

  • (String) 


282
283
284
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 282

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


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

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


76
77
78
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 76

def time_created
  @time_created
end

#time_deleted ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_deleted
  @time_deleted
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

#total_storage_gb ⇒ Integer

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

Returns:

  • (Integer) 


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

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) 


286
287
288
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 286

def vcn_compartment_id
  @vcn_compartment_id
end

#vcn_id ⇒ String

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

Returns:

  • (String) 


278
279
280
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 278

def vcn_id
  @vcn_id
end

Class Method Details

.attribute_map ⇒ Object

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



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
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 347

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',
    'security_attributes': :'securityAttributes',
    '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',
    'coordinator_node_count': :'coordinatorNodeCount',
    'coordinator_node_host_type': :'coordinatorNodeHostType',
    'coordinator_node_host_shape': :'coordinatorNodeHostShape',
    'coordinator_node_host_ocpu_count': :'coordinatorNodeHostOcpuCount',
    'coordinator_node_host_memory_gb': :'coordinatorNodeHostMemoryGB',
    'ml_node_count': :'mlNodeCount',
    'ml_node_host_type': :'mlNodeHostType',
    'ml_node_host_shape': :'mlNodeHostShape',
    'ml_node_host_ocpu_count': :'mlNodeHostOcpuCount',
    'ml_node_host_memory_gb': :'mlNodeHostMemoryGB',
    'ml_node_storage_gb': :'mlNodeStorageGB',
    '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',
    'nsg_id': :'nsgId',
    'reverse_connection_endpoint_customer_ips': :'reverseConnectionEndpointCustomerIps',
    'reverse_connection_endpoints': :'reverseConnectionEndpoints',
    'outbound_cluster_config': :'outboundClusterConfig',
    'inbound_cluster_ids': :'inboundClusterIds',
    'maintenance_details': :'maintenanceDetails',
    'load_balancer_config': :'loadBalancerConfig',
    'certificate_config': :'certificateConfig'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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>>',
    'security_attributes': :'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',
    'coordinator_node_count': :'Integer',
    'coordinator_node_host_type': :'String',
    'coordinator_node_host_shape': :'String',
    'coordinator_node_host_ocpu_count': :'Integer',
    'coordinator_node_host_memory_gb': :'Integer',
    'ml_node_count': :'Integer',
    'ml_node_host_type': :'String',
    'ml_node_host_shape': :'String',
    'ml_node_host_ocpu_count': :'Integer',
    'ml_node_host_memory_gb': :'Integer',
    'ml_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',
    'nsg_id': :'String',
    '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',
    'load_balancer_config': :'OCI::Opensearch::Models::LoadBalancerConfig',
    'certificate_config': :'OCI::Opensearch::Models::CertificateConfig'
    # 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



1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 1104

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 &&
    security_attributes == other.security_attributes &&
    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 &&
    coordinator_node_count == other.coordinator_node_count &&
    coordinator_node_host_type == other.coordinator_node_host_type &&
    coordinator_node_host_shape == other.coordinator_node_host_shape &&
    coordinator_node_host_ocpu_count == other.coordinator_node_host_ocpu_count &&
    coordinator_node_host_memory_gb == other.coordinator_node_host_memory_gb &&
    ml_node_count == other.ml_node_count &&
    ml_node_host_type == other.ml_node_host_type &&
    ml_node_host_shape == other.ml_node_host_shape &&
    ml_node_host_ocpu_count == other.ml_node_host_ocpu_count &&
    ml_node_host_memory_gb == other.ml_node_host_memory_gb &&
    ml_node_storage_gb == other.ml_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 &&
    nsg_id == other.nsg_id &&
    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 &&
    load_balancer_config == other.load_balancer_config &&
    certificate_config == other.certificate_config
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



1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 1204

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


1184
1185
1186
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 1184

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



1193
1194
1195
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 1193

def hash
  [id, display_name, compartment_id, lifecycle_state, time_created, time_updated, time_deleted, lifecycle_details, freeform_tags, defined_tags, system_tags, security_attributes, 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, coordinator_node_count, coordinator_node_host_type, coordinator_node_host_shape, coordinator_node_host_ocpu_count, coordinator_node_host_memory_gb, ml_node_count, ml_node_host_type, ml_node_host_shape, ml_node_host_ocpu_count, ml_node_host_memory_gb, ml_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, nsg_id, reverse_connection_endpoint_customer_ips, reverse_connection_endpoints, outbound_cluster_config, inbound_cluster_ids, maintenance_details, load_balancer_config, certificate_config].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 1237

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



1231
1232
1233
 
# File 'lib/oci/opensearch/models/opensearch_cluster.rb', line 1231

def to_s
  to_hash.to_s
end