Class DbSystemSummary
- java.lang.Object
-
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
- com.oracle.bmc.database.model.DbSystemSummary
-
@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public final class DbSystemSummary extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
The Database Service supports several types of DB systems, ranging in size, price, and performance.For details about each type of system, see Bare Metal and Virtual Machine DB Systems.
*Note:** Deprecated for Exadata Cloud Service instances using the new [resource model](https://docs.oracle.com/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model). To provision and manage new Exadata Cloud Service systems, use the
CloudExadataInfrastructure
andCloudVmCluster
. See [Exadata Cloud Service](https://docs.oracle.com/iaas/Content/Database/Concepts/exaoverview.htm) for more information on Exadata systems.For Exadata Cloud Service instances, support for this API will end on May 15th, 2021. See [Switching an Exadata DB System to the New Resource Model and APIs](https://docs.oracle.com/iaas/Content/Database/Concepts/exaflexsystem_topic-resource_model_conversion.htm) for details on converting existing Exadata DB systems to the new resource model.
To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
For information about access control and compartments, see [Overview of the Identity Service](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm).
For information about availability domains, see [Regions and Availability Domains](https://docs.oracle.com/iaas/Content/General/Concepts/regions.htm).
To get a list of availability domains, use the ListAvailabilityDomains operation in the Identity Service API.
*Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
Note: Objects should always be created or deserialized using theDbSystemSummary.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 theDbSystemSummary.Builder
, which maintain a set of all explicitly set fields calledDbSystemSummary.Builder.__explicitlySet__
. ThehashCode()
andequals(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).
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
DbSystemSummary.Builder
static class
DbSystemSummary.DatabaseEdition
The Oracle Database edition that applies to all the databases on the DB system.static class
DbSystemSummary.DiskRedundancy
The type of redundancy configured for the DB system.static class
DbSystemSummary.LicenseModel
The Oracle license model that applies to all the databases on the DB system.static class
DbSystemSummary.LifecycleState
The current state of the DB system.static class
DbSystemSummary.StorageVolumePerformanceMode
The block storage volume performance level.
-
Constructor Summary
Constructors Constructor Description DbSystemSummary(String id, String compartmentId, String displayName, String availabilityDomain, List<String> faultDomains, String subnetId, String backupSubnetId, List<String> nsgIds, List<String> backupNetworkNsgIds, String giSoftwareImageId, Integer memorySizeInGBs, DbSystemSummary.StorageVolumePerformanceMode storageVolumePerformanceMode, String shape, DbSystemOptions dbSystemOptions, List<String> sshPublicKeys, String timeZone, String hostname, String domain, String kmsKeyId, String version, String osVersion, Integer cpuCoreCount, String clusterName, Integer dataStoragePercentage, DbSystemSummary.DatabaseEdition databaseEdition, String lastPatchHistoryEntryId, Integer listenerPort, DbSystemSummary.LifecycleState lifecycleState, Date timeCreated, String lifecycleDetails, DbSystemSummary.DiskRedundancy diskRedundancy, Boolean sparseDiskgroup, List<String> scanIpIds, List<String> vipIds, List<String> scanIpv6Ids, List<String> vipv6Ids, String scanDnsRecordId, String scanDnsName, String zoneId, Integer dataStorageSizeInGBs, Integer recoStorageSizeInGB, Integer nodeCount, DbSystemSummary.LicenseModel licenseModel, MaintenanceWindow maintenanceWindow, String lastMaintenanceRunId, String nextMaintenanceRunId, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> securityAttributes, String sourceDbSystemId, Date pointInTimeDataDiskCloneTimestamp, DataCollectionOptions dataCollectionOptions)
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DbSystemSummary.Builder
builder()
Create a new builder.boolean
equals(Object o)
String
getAvailabilityDomain()
The name of the availability domain that the DB system is located in.List<String>
getBackupNetworkNsgIds()
A list of the OCIDs of the network security groups (NSGs) that the backup network of this DB system belongs to.String
getBackupSubnetId()
The OCID of the backup network subnet the DB system is associated with.String
getClusterName()
The cluster name for Exadata and 2-node RAC virtual machine DB systems.String
getCompartmentId()
The OCID of the compartment.Integer
getCpuCoreCount()
The number of CPU cores enabled on the DB system.DbSystemSummary.DatabaseEdition
getDatabaseEdition()
The Oracle Database edition that applies to all the databases on the DB system.DataCollectionOptions
getDataCollectionOptions()
Integer
getDataStoragePercentage()
The percentage assigned to DATA storage (user data and database files).Integer
getDataStorageSizeInGBs()
The data storage size, in gigabytes, that is currently available to the DB system.DbSystemOptions
getDbSystemOptions()
Map<String,Map<String,Object>>
getDefinedTags()
Defined tags for this resource.DbSystemSummary.DiskRedundancy
getDiskRedundancy()
The type of redundancy configured for the DB system.String
getDisplayName()
The user-friendly name for the DB system.String
getDomain()
The domain name for the DB system.List<String>
getFaultDomains()
List of the Fault Domains in which this DB system is provisioned.Map<String,String>
getFreeformTags()
Free-form tags for this resource.String
getGiSoftwareImageId()
The OCID of a grid infrastructure software image.String
getHostname()
The hostname for the DB system.String
getId()
The OCID of the DB system.String
getKmsKeyId()
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.String
getLastMaintenanceRunId()
The OCID of the last maintenance run.String
getLastPatchHistoryEntryId()
The OCID of the last patch history.DbSystemSummary.LicenseModel
getLicenseModel()
The Oracle license model that applies to all the databases on the DB system.String
getLifecycleDetails()
Additional information about the current lifecycle state.DbSystemSummary.LifecycleState
getLifecycleState()
The current state of the DB system.Integer
getListenerPort()
The port number configured for the listener on the DB system.MaintenanceWindow
getMaintenanceWindow()
Integer
getMemorySizeInGBs()
Memory allocated to the DB system, in gigabytes.String
getNextMaintenanceRunId()
The OCID of the next maintenance run.Integer
getNodeCount()
The number of nodes in the DB system.List<String>
getNsgIds()
The list of OCIDs for the network security groups (NSGs) to which this resource belongs.String
getOsVersion()
The most recent OS Patch Version applied on the DB system.Date
getPointInTimeDataDiskCloneTimestamp()
The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.Integer
getRecoStorageSizeInGB()
The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system.String
getScanDnsName()
The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.String
getScanDnsRecordId()
The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.List<String>
getScanIpIds()
The OCID of the Single Client Access Name (SCAN) IPv4 addresses associated with the DB system.List<String>
getScanIpv6Ids()
The OCID of the Single Client Access Name (SCAN) IPv6 addresses associated with the DB system.Map<String,Map<String,Object>>
getSecurityAttributes()
Security Attributes for this resource.String
getShape()
The shape of the DB system.String
getSourceDbSystemId()
The OCID of the DB system.Boolean
getSparseDiskgroup()
True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured.List<String>
getSshPublicKeys()
The public key portion of one or more key pairs used for SSH access to the DB system.DbSystemSummary.StorageVolumePerformanceMode
getStorageVolumePerformanceMode()
The block storage volume performance level.String
getSubnetId()
The OCID of the subnet the DB system is associated with.Date
getTimeCreated()
The date and time the DB system was created.String
getTimeZone()
The time zone of the DB system.String
getVersion()
The Oracle Database version of the DB system.List<String>
getVipIds()
The OCID of the virtual IPv4 (VIP) addresses associated with the DB system.List<String>
getVipv6Ids()
The OCID of the virtual IPv6 (VIP) addresses associated with the DB system.String
getZoneId()
The OCID of the zone the DB system is associated with.int
hashCode()
DbSystemSummary.Builder
toBuilder()
String
toString()
String
toString(boolean includeByteArrayContents)
Return a string representation of the object.
-
-
-
Constructor Detail
-
DbSystemSummary
@Deprecated @ConstructorProperties({"id","compartmentId","displayName","availabilityDomain","faultDomains","subnetId","backupSubnetId","nsgIds","backupNetworkNsgIds","giSoftwareImageId","memorySizeInGBs","storageVolumePerformanceMode","shape","dbSystemOptions","sshPublicKeys","timeZone","hostname","domain","kmsKeyId","version","osVersion","cpuCoreCount","clusterName","dataStoragePercentage","databaseEdition","lastPatchHistoryEntryId","listenerPort","lifecycleState","timeCreated","lifecycleDetails","diskRedundancy","sparseDiskgroup","scanIpIds","vipIds","scanIpv6Ids","vipv6Ids","scanDnsRecordId","scanDnsName","zoneId","dataStorageSizeInGBs","recoStorageSizeInGB","nodeCount","licenseModel","maintenanceWindow","lastMaintenanceRunId","nextMaintenanceRunId","freeformTags","definedTags","securityAttributes","sourceDbSystemId","pointInTimeDataDiskCloneTimestamp","dataCollectionOptions"}) public DbSystemSummary(String id, String compartmentId, String displayName, String availabilityDomain, List<String> faultDomains, String subnetId, String backupSubnetId, List<String> nsgIds, List<String> backupNetworkNsgIds, String giSoftwareImageId, Integer memorySizeInGBs, DbSystemSummary.StorageVolumePerformanceMode storageVolumePerformanceMode, String shape, DbSystemOptions dbSystemOptions, List<String> sshPublicKeys, String timeZone, String hostname, String domain, String kmsKeyId, String version, String osVersion, Integer cpuCoreCount, String clusterName, Integer dataStoragePercentage, DbSystemSummary.DatabaseEdition databaseEdition, String lastPatchHistoryEntryId, Integer listenerPort, DbSystemSummary.LifecycleState lifecycleState, Date timeCreated, String lifecycleDetails, DbSystemSummary.DiskRedundancy diskRedundancy, Boolean sparseDiskgroup, List<String> scanIpIds, List<String> vipIds, List<String> scanIpv6Ids, List<String> vipv6Ids, String scanDnsRecordId, String scanDnsName, String zoneId, Integer dataStorageSizeInGBs, Integer recoStorageSizeInGB, Integer nodeCount, DbSystemSummary.LicenseModel licenseModel, MaintenanceWindow maintenanceWindow, String lastMaintenanceRunId, String nextMaintenanceRunId, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> securityAttributes, String sourceDbSystemId, Date pointInTimeDataDiskCloneTimestamp, DataCollectionOptions dataCollectionOptions)
Deprecated.
-
-
Method Detail
-
builder
public static DbSystemSummary.Builder builder()
Create a new builder.
-
toBuilder
public DbSystemSummary.Builder toBuilder()
-
getDisplayName
public String getDisplayName()
The user-friendly name for the DB system.The name does not have to be unique.
- Returns:
- the value
-
getAvailabilityDomain
public String getAvailabilityDomain()
The name of the availability domain that the DB system is located in.- Returns:
- the value
-
getFaultDomains
public List<String> getFaultDomains()
List of the Fault Domains in which this DB system is provisioned.- Returns:
- the value
-
getSubnetId
public String getSubnetId()
The OCID of the subnet the DB system is associated with.*Subnet Restrictions:** - For bare metal DB systems and for single node virtual machine DB systems, do not use a subnet that overlaps with 192.168.16.16/28. - For Exadata and virtual machine 2-node RAC DB 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 the DB system is associated with.Applicable only to Exadata DB systems.
*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
-
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
-
getMemorySizeInGBs
public Integer getMemorySizeInGBs()
Memory allocated to the DB system, in gigabytes.- Returns:
- the value
-
getStorageVolumePerformanceMode
public DbSystemSummary.StorageVolumePerformanceMode getStorageVolumePerformanceMode()
The block storage volume performance level.Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume Performance for more information.
- Returns:
- the value
-
getShape
public String getShape()
The shape of the DB system.The shape determines resources to allocate to the DB system. - For virtual machine shapes, the number of CPU cores and memory - For bare metal and Exadata shapes, the number of CPU cores, storage, and memory
- Returns:
- the value
-
getDbSystemOptions
public DbSystemOptions getDbSystemOptions()
-
getSshPublicKeys
public List<String> getSshPublicKeys()
The public key portion of one or more key pairs used for SSH access to the DB system.- Returns:
- the value
-
getTimeZone
public String getTimeZone()
The time zone of the DB system.For details, see DB System Time Zones.
- Returns:
- the value
-
getHostname
public String getHostname()
The hostname for the DB system.- Returns:
- the value
-
getDomain
public String getDomain()
The domain name for the DB system.- Returns:
- the value
-
getKmsKeyId
public String getKmsKeyId()
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.- Returns:
- the value
-
getVersion
public String getVersion()
The Oracle Database version of the DB system.- Returns:
- the value
-
getOsVersion
public String getOsVersion()
The most recent OS Patch Version applied on the DB system.- Returns:
- the value
-
getCpuCoreCount
public Integer getCpuCoreCount()
The number of CPU cores enabled on the DB system.- Returns:
- the value
-
getClusterName
public String getClusterName()
The cluster name for Exadata and 2-node RAC virtual machine DB systems.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 40 and 80. The default is 80 percent assigned to DATA storage. Not applicable for virtual machine DB systems.
- Returns:
- the value
-
getDatabaseEdition
public DbSystemSummary.DatabaseEdition getDatabaseEdition()
The Oracle Database edition that applies to all the databases on the DB system.- Returns:
- the value
-
getLastPatchHistoryEntryId
public String getLastPatchHistoryEntryId()
The OCID of the last patch history.This value is updated as soon as a patch operation starts.
- Returns:
- the value
-
getListenerPort
public Integer getListenerPort()
The port number configured for the listener on the DB system.- Returns:
- the value
-
getLifecycleState
public DbSystemSummary.LifecycleState getLifecycleState()
The current state of the DB system.- Returns:
- the value
-
getTimeCreated
public Date getTimeCreated()
The date and time the DB system was created.- Returns:
- the value
-
getLifecycleDetails
public String getLifecycleDetails()
Additional information about the current lifecycle state.- Returns:
- the value
-
getDiskRedundancy
public DbSystemSummary.DiskRedundancy getDiskRedundancy()
The type of redundancy configured for the DB system.NORMAL is 2-way redundancy. HIGH is 3-way redundancy.
- Returns:
- the value
-
getSparseDiskgroup
public Boolean getSparseDiskgroup()
True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured.- Returns:
- the value
-
getScanIpIds
public List<String> getScanIpIds()
The OCID of the Single Client Access Name (SCAN) IPv4 addresses associated with the DB system.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 IPv4 (VIP) addresses associated with the DB system.The Cluster Ready Services (CRS) creates and maintains one VIPv4 address for each node in the DB system to enable failover. If one node fails, the VIPv4 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 DB system.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 IPv6 (VIP) addresses associated with the DB system.The Cluster Ready Services (CRS) creates and maintains one VIP IpV6 address for each node in the DB system 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 DB system.- Returns:
- the value
-
getScanDnsName
public String getScanDnsName()
The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.- Returns:
- the value
-
getZoneId
public String getZoneId()
The OCID of the zone the DB system is associated with.- Returns:
- the value
-
getDataStorageSizeInGBs
public Integer getDataStorageSizeInGBs()
The data storage size, in gigabytes, that is currently available to the DB system.Applies only for virtual machine DB systems.
- Returns:
- the value
-
getRecoStorageSizeInGB
public Integer getRecoStorageSizeInGB()
The RECO/REDO storage size, in gigabytes, that is currently allocated to the DB system.Applies only for virtual machine DB systems.
- Returns:
- the value
-
getNodeCount
public Integer getNodeCount()
The number of nodes in the DB system.For RAC DB systems, the value is greater than 1.
- Returns:
- the value
-
getLicenseModel
public DbSystemSummary.LicenseModel getLicenseModel()
The Oracle license model that applies to all the databases on the DB system.The default is LICENSE_INCLUDED.
- Returns:
- the value
-
getMaintenanceWindow
public MaintenanceWindow getMaintenanceWindow()
-
getLastMaintenanceRunId
public String getLastMaintenanceRunId()
The OCID of the last maintenance run.- Returns:
- the value
-
getNextMaintenanceRunId
public String getNextMaintenanceRunId()
The OCID of the next maintenance run.- 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
-
getSourceDbSystemId
public String getSourceDbSystemId()
The OCID of the DB system.- Returns:
- the value
-
getPointInTimeDataDiskCloneTimestamp
public Date getPointInTimeDataDiskCloneTimestamp()
The point in time for a cloned database system when the data disks were cloned from the source database system, as described in RFC 3339.- Returns:
- the value
-
getDataCollectionOptions
public DataCollectionOptions getDataCollectionOptions()
-
toString
public String toString()
- Overrides:
toString
in classcom.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 classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
-