@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.cloud.oracle.com/iaas/Content/Database/Concepts/exaflexsystem.htm#exaflexsystem_topic-resource_model).
To provision and manage new Exadata Cloud Service systems, use the CloudExadataInfrastructure and CloudVmCluster. See [Exadata Cloud
Service](https://docs.cloud.oracle.com/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.cloud.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.cloud.oracle.com/Content/Identity/Concepts/policygetstarted.htm).
For information about access control and compartments, see [Overview of the Identity Service](https://docs.cloud.oracle.com/Content/Identity/Concepts/overview.htm).
For information about availability domains, see [Regions and Availability Domains](https://docs.cloud.oracle.com/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 the DbSystemSummary.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 DbSystemSummary.Builder, which maintain a
set of all explicitly set fields called DbSystemSummary.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).
| Modifier and Type | Class and 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.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and 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,
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.
|
| Modifier and Type | Method and 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) IP 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 IP (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.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"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","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, 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)
public static DbSystemSummary.Builder builder()
Create a new builder.
public DbSystemSummary.Builder toBuilder()
public String getDisplayName()
The user-friendly name for the DB system. The name does not have to be unique.
public String getAvailabilityDomain()
The name of the availability domain that the DB system is located in.
public List<String> getFaultDomains()
List of the Fault Domains in which this DB system is provisioned.
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.
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**.
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.
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.
public String getGiSoftwareImageId()
The OCID of a grid
infrastructure software image. This is a database software image of the type GRID_IMAGE.
public Integer getMemorySizeInGBs()
Memory allocated to the DB system, in gigabytes.
public DbSystemSummary.StorageVolumePerformanceMode getStorageVolumePerformanceMode()
The block storage volume performance level. Valid values are BALANCED and HIGH_PERFORMANCE. See Block Volume
Performance
for more information.
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
public DbSystemOptions getDbSystemOptions()
public List<String> getSshPublicKeys()
The public key portion of one or more key pairs used for SSH access to the DB system.
public String getTimeZone()
The time zone of the DB system. For details, see DB System Time Zones.
public String getHostname()
The hostname for the DB system.
public String getDomain()
The domain name for the DB system.
public String getKmsKeyId()
The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.
public String getVersion()
The Oracle Database version of the DB system.
public String getOsVersion()
The most recent OS Patch Version applied on the DB system.
public Integer getCpuCoreCount()
The number of CPU cores enabled on the DB system.
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.
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.
public DbSystemSummary.DatabaseEdition getDatabaseEdition()
The Oracle Database edition that applies to all the databases on the DB system.
public String getLastPatchHistoryEntryId()
The OCID of the last patch history. This value is updated as soon as a patch operation starts.
public Integer getListenerPort()
The port number configured for the listener on the DB system.
public DbSystemSummary.LifecycleState getLifecycleState()
The current state of the DB system.
public Date getTimeCreated()
The date and time the DB system was created.
public String getLifecycleDetails()
Additional information about the current lifecycle state.
public DbSystemSummary.DiskRedundancy getDiskRedundancy()
The type of redundancy configured for the DB system. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.
public Boolean getSparseDiskgroup()
True, if Sparse Diskgroup is configured for Exadata dbsystem, False, if Sparse diskgroup was not configured.
public List<String> getScanIpIds()
The OCID of the Single Client Access Name (SCAN) IP addresses associated with the DB system. SCAN IP 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.
public List<String> getVipIds()
The OCID of the virtual IP (VIP) addresses associated with the DB system. The Cluster Ready Services (CRS) creates and maintains one VIP 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.
public String getScanDnsRecordId()
The OCID of the DNS record for the SCAN IP addresses that are associated with the DB system.
public String getScanDnsName()
The FQDN of the DNS record for the SCAN IP addresses that are associated with the DB system.
public String getZoneId()
The OCID of the zone the DB system is associated with.
public Integer getDataStorageSizeInGBs()
The data storage size, in gigabytes, that is currently available to the DB system. Applies only for virtual machine DB systems.
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.
public Integer getNodeCount()
The number of nodes in the DB system. For RAC DB systems, the value is greater than 1.
public DbSystemSummary.LicenseModel getLicenseModel()
The Oracle license model that applies to all the databases on the DB system. The default is LICENSE_INCLUDED.
public MaintenanceWindow getMaintenanceWindow()
public String getLastMaintenanceRunId()
The OCID of the last maintenance run.
public String getNextMaintenanceRunId()
The OCID of the next maintenance run.
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"}
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.
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"}}}
public String getSourceDbSystemId()
The OCID of the DB system.
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.
public DataCollectionOptions getDataCollectionOptions()
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.