Package com.oracle.bmc.database.model

Class CloudVmCluster

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class CloudVmCluster
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Details of the cloud VM cluster.

    Applies to Exadata Cloud Service instances only.
    Note: Objects should always be created or deserialized using the CloudVmCluster.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the CloudVmCluster.Builder, which maintain a set of all explicitly set fields called CloudVmCluster.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getId

        public String getId()
        The OCID of the cloud VM cluster.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment.
        Returns:
        the value

      • getSubscriptionId

        public String getSubscriptionId()
        The OCID of the subscription with which resource needs to be associated with.
        Returns:
        the value

      • getAvailabilityDomain

        public String getAvailabilityDomain()
        The name of the availability domain that the cloud Exadata infrastructure resource is located in.
        Returns:
        the value

      • getSubnetId

        public String getSubnetId()
        The OCID of the subnet associated with the cloud VM cluster.

        *Subnet Restrictions:** - For Exadata and virtual machine 2-node RAC systems, do not use a subnet that overlaps with 192.168.128.0/20.

        These subnets are used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet will cause the private interconnect to malfunction. This restriction applies to both the client subnet and backup subnet.

        Returns:
        the value

      • getBackupSubnetId

        public String getBackupSubnetId()
        The OCID of the backup network subnet associated with the cloud VM cluster.

        *Subnet Restriction:** See the subnet restrictions information for **subnetId**.

        Returns:
        the value

      • getNsgIds

        public List<String> getNsgIds()
        The list of OCIDs for the network security groups (NSGs) to which this resource belongs.

        Setting this to an empty list removes all resources from all NSGs. For more information about NSGs, see Security Rules. NsgIds restrictions: - A network security group (NSG) is optional for Autonomous Databases with private access. The nsgIds list can be empty.

        Returns:
        the value

      • getBackupNetworkNsgIds

        public List<String> getBackupNetworkNsgIds()
        A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to.

        Setting this to an empty array after the list is created removes the resource from all NSGs. For more information about NSGs, see Security Rules. Applicable only to Exadata systems.

        Returns:
        the value

      • getLastUpdateHistoryEntryId

        public String getLastUpdateHistoryEntryId()
        The OCID of the last maintenance update history entry.

        This value is updated when a maintenance update starts.

        Returns:
        the value

      • getShape

        public String getShape()
        The model name of the Exadata hardware running the cloud VM cluster.
        Returns:
        the value

      • getListenerPort

        public Long getListenerPort()
        The port number configured for the listener on the cloud VM cluster.
        Returns:
        the value

      • getNodeCount

        public Integer getNodeCount()
        The number of nodes in the cloud VM cluster.
        Returns:
        the value

      • getStorageSizeInGBs

        public Integer getStorageSizeInGBs()
        The storage allocation for the disk group, in gigabytes (GB).
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        The user-friendly name for the cloud VM cluster.

        The name does not need to be unique.

        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time that the cloud VM cluster was created.
        Returns:
        the value

      • getLifecycleDetails

        public String getLifecycleDetails()
        Additional information about the current lifecycle state.
        Returns:
        the value

      • getHostname

        public String getHostname()
        The hostname for the cloud VM cluster.
        Returns:
        the value

      • getDomain

        public String getDomain()
        The domain name for the cloud VM cluster.
        Returns:
        the value

      • getCpuCoreCount

        public Integer getCpuCoreCount()
        The number of CPU cores enabled on the cloud VM cluster.
        Returns:
        the value

      • getOcpuCount

        public Float getOcpuCount()
        The number of OCPU cores to enable on the cloud VM cluster.

        Only 1 decimal place is allowed for the fractional part.

        Returns:
        the value

      • getMemorySizeInGBs

        public Integer getMemorySizeInGBs()
        The memory to be allocated in GBs.
        Returns:
        the value

      • getDbNodeStorageSizeInGBs

        public Integer getDbNodeStorageSizeInGBs()
        The local node storage to be allocated in GBs.
        Returns:
        the value

      • getDataStorageSizeInTBs

        public Double getDataStorageSizeInTBs()
        The data disk group size to be allocated in TBs.
        Returns:
        the value

      • getDbServers

        public List<String> getDbServers()
        The list of DB servers.
        Returns:
        the value

      • getClusterName

        public String getClusterName()
        The cluster name for cloud VM cluster.

        The cluster name must begin with an alphabetic character, and may contain hyphens (-). Underscores (_) are not permitted. The cluster name can be no longer than 11 characters and is not case sensitive.

        Returns:
        the value

      • getDataStoragePercentage

        public Integer getDataStoragePercentage()
        The percentage assigned to DATA storage (user data and database files).

        The remaining percentage is assigned to RECO storage (database redo logs, archive logs, and recovery manager backups). Accepted values are 35, 40, 60 and 80. The default is 80 percent assigned to DATA storage. See Storage Configuration in the Exadata documentation for details on the impact of the configuration settings on storage.

        Returns:
        the value

      • getIsLocalBackupEnabled

        public Boolean getIsLocalBackupEnabled()
        If true, database backup on local Exadata storage is configured for the cloud VM cluster.

        If false, database backup on local Exadata storage is not available in the cloud VM cluster.

        Returns:
        the value

      • getCloudExadataInfrastructureId

        public String getCloudExadataInfrastructureId()
        The OCID of the cloud Exadata infrastructure.
        Returns:
        the value

      • getIsSparseDiskgroupEnabled

        public Boolean getIsSparseDiskgroupEnabled()
        If true, sparse disk group is configured for the cloud VM cluster.

        If false, sparse disk group is not created.

        Returns:
        the value

      • getGiVersion

        public String getGiVersion()
        A valid Oracle Grid Infrastructure (GI) software version.
        Returns:
        the value

      • getSystemVersion

        public String getSystemVersion()
        Operating system version of the image.
        Returns:
        the value

      • getSshPublicKeys

        public List<String> getSshPublicKeys()
        The public key portion of one or more key pairs used for SSH access to the cloud VM cluster.
        Returns:
        the value

      • getLicenseModel

        public CloudVmCluster.LicenseModel getLicenseModel()
        The Oracle license model that applies to the cloud VM cluster.

        The default is LICENSE_INCLUDED.

        Returns:
        the value

      • getDiskRedundancy

        public CloudVmCluster.DiskRedundancy getDiskRedundancy()
        The type of redundancy configured for the cloud Vm cluster.

        NORMAL is 2-way redundancy. HIGH is 3-way redundancy.

        Returns:
        the value

      • getScanIpIds

        public List<String> getScanIpIds()
        The OCID of the Single Client Access Name (SCAN) IPv4 addresses associated with the cloud VM cluster.

        SCAN IPv4 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.

        *Note:** For a single-node DB system, this list is empty.

        Returns:
        the value

      • getVipIds

        public List<String> getVipIds()
        The OCID of the virtual IP (VIP) IPv4 addresses associated with the cloud VM cluster.

        The Cluster Ready Services (CRS) creates and maintains one VIP IPv4 address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.

        *Note:** For a single-node DB system, this list is empty.

        Returns:
        the value

      • getScanIpv6Ids

        public List<String> getScanIpv6Ids()
        The OCID of the Single Client Access Name (SCAN) IPv6 addresses associated with the cloud VM cluster.

        SCAN IPv6 addresses are typically used for load balancing and are not assigned to any interface. Oracle Clusterware directs the requests to the appropriate nodes in the cluster.

        *Note:** For a single-node DB system, this list is empty.

        Returns:
        the value

      • getVipv6Ids

        public List<String> getVipv6Ids()
        The OCID of the virtual IP (VIP) IPv6 addresses associated with the cloud VM cluster.

        The Cluster Ready Services (CRS) creates and maintains one VIP IPv6 address for each node in the Exadata Cloud Service instance to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.

        *Note:** For a single-node DB system, this list is empty.

        Returns:
        the value

      • getScanDnsRecordId

        public String getScanDnsRecordId()
        The OCID of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.
        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        Free-form tags for this resource.

        Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

        Example: {"Department": "Finance"}

        Returns:
        the value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

        Returns:
        the value

      • getSecurityAttributes

        public Map<String,​Map<String,​Object>> getSecurityAttributes()
        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”: “audit”}}}

        Returns:
        the value

      • getSystemTags

        public Map<String,​Map<String,​Object>> getSystemTags()
        System tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

        Returns:
        the value

      • getScanDnsName

        public String getScanDnsName()
        The FQDN of the DNS record for the SCAN IP addresses that are associated with the cloud VM cluster.
        Returns:
        the value

      • getZoneId

        public String getZoneId()
        The OCID of the zone the cloud VM cluster is associated with.
        Returns:
        the value

      • getScanListenerPortTcp

        public Integer getScanListenerPortTcp()
        The TCP Single Client Access Name (SCAN) port.

        The default port is 1521.

        Returns:
        the value

      • getScanListenerPortTcpSsl

        public Integer getScanListenerPortTcpSsl()
        The TCPS Single Client Access Name (SCAN) port.

        The default port is 2484.

        Returns:
        the value

      • getGiSoftwareImageId

        public String getGiSoftwareImageId()
        The OCID of a grid infrastructure software image.

        This is a database software image of the type GRID_IMAGE.

        Returns:
        the value

      • getFileSystemConfigurationDetails

        public List<FileSystemConfigurationDetail> getFileSystemConfigurationDetails()
        Details of the file system configuration of the VM cluster.
        Returns:
        the value

      • getVmClusterType

        public CloudVmCluster.VmClusterType getVmClusterType()
        The vmcluster type for the VM cluster/Cloud VM cluster.
        Returns:
        the value

      • getComputeModel

        public CloudVmCluster.ComputeModel getComputeModel()
        The compute model of the Autonomous Database.

        This is required if using the computeCount parameter. If using cpuCoreCount then it is an error to specify computeModel to a non-null value. ECPU compute model is the recommended model and OCPU compute model is legacy.

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel