| GitHub Repository |
Prerelease Implications
This package is a prerelease version! Use with caution.
Prerelease versions are considered unstable as they may be shut down and/or subject to breaking changes when upgrading. Use them only for testing or if you specifically need their experimental features.
Client Classes
Client classes are the main entry point to using a package. They contain several variations of Java methods for each of the API's methods.
| Client | Description |
|---|---|
| com. |
Service Description: DatabaseCenter contains methods to query fleet view for database resources.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started: |
Settings Classes
Settings classes can be used to configure credentials, endpoints, and retry settings for a Client.
| Settings | Description |
|---|---|
| com. |
Settings class to configure an instance of DatabaseCenterClient.
The default instance has everything set to sensible defaults: |
Classes
| Class | Description |
|---|---|
| com. |
Details related to signal. |
| com. |
Details related to signal. |
| com. |
The request message to aggregate fleet which are grouped by a field. |
| com. |
The request message to aggregate fleet which are grouped by a field. |
| com. |
The response message to aggregate a fleet by some group by fields. |
| com. |
The response message to aggregate a fleet by some group by fields. |
| com. |
Individual row grouped by a particular dimension. |
| com. |
Individual row grouped by a particular dimension. |
| com. |
AggregateIssueStatsRequest represents the input to the AggregateIssueStats method. |
| com. |
AggregateIssueStatsRequest represents the input to the AggregateIssueStats method. |
| com. |
The response message containing one of more group of relevant health issues for database resources. |
| com. |
The response message containing one of more group of relevant health issues for database resources. |
| com. |
Automated backup policy signal info |
| com. |
Automated backup policy signal info |
| com. |
BackupDRConfig to capture the backup and disaster recovery details of database resource. |
| com. |
BackupDRConfig to capture the backup and disaster recovery details of database resource. |
| com. |
Metadata about latest backup run state for a database resource. |
| com. |
Metadata about latest backup run state for a database resource. |
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
|
| com. |
DatabaseCenter contains methods to query fleet view for database resources. |
| com. |
Base class for the server implementation of the service DatabaseCenter. DatabaseCenter contains methods to query fleet view for database resources. |
| com. |
Builder for DatabaseCenterSettings. |
| com. |
DatabaseResource represents every individually configured database unit representing compute and/or storage. NextId: 20 |
| com. |
DatabaseResource represents every individually configured database unit representing compute and/or storage. NextId: 20 |
| com. |
DatabaseResourceGroup represents all resources that serve a common data set. It is considered notionally as a single entity, powered by any number of units of compute and storage. |
| com. |
DatabaseResourceGroup represents all resources that serve a common data set. It is considered notionally as a single entity, powered by any number of units of compute and storage. |
| com. |
Deletion protection signal info for a database resource. |
| com. |
Deletion protection signal info for a database resource. |
| com. |
Captures the details of items that have increased or decreased in some bucket when compared to some point in history. It is currently used to capture the delta of resources that have been added |
| com. |
Captures the details of items that have increased or decreased in some bucket when compared to some point in history. It is currently used to capture the delta of resources that have been added |
| com. |
Dimension used to aggregate the fleet. |
| com. |
Dimension used to aggregate the fleet. |
| com. |
Metadata about inefficient query signal info for a database resource. |
| com. |
Metadata about inefficient query signal info for a database resource. |
| com. |
Count of issues for a group of signals. |
| com. |
Count of issues for a group of signals. |
| com. |
IssueGroupStats refers to stats for a particulare combination of relevant health issues of database resources. |
| com. |
IssueGroupStats refers to stats for a particulare combination of relevant health issues of database resources. |
| com. |
IssueStats holds stats for a particular signal category. |
| com. |
IssueStats holds stats for a particular signal category. |
| com. |
Label is a key value pair applied to a resource. |
| com. |
Label is a key value pair applied to a resource. |
| com. |
MachineConfig describes the configuration of a machine specific to a Database Resource. |
| com. |
MachineConfig describes the configuration of a machine specific to a Database Resource. |
| com. |
|
| com. |
MaintenanceInfo to capture the maintenance details of database resource. |
| com. |
MaintenanceInfo to capture the maintenance details of database resource. |
| com. |
|
| com. |
Info associated with maintenance recommendation. |
| com. |
Info associated with maintenance recommendation. |
| com. |
MetricData represents the metric data for a database resource. |
| com. |
MetricData represents the metric data for a database resource. |
| com. |
|
| com. |
Metrics represents the metrics for a database resource. |
| com. |
Metrics represents the metrics for a database resource. |
| com. |
|
| com. |
Info associated with outdated minor version. |
| com. |
Info associated with outdated minor version. |
| com. |
Product specification for databasecenter resources. |
| com. |
Product specification for databasecenter resources. |
| com. |
|
| com. |
QueryDatabaseResourceGroupsRequest is the request to get a list of database groups. |
| com. |
QueryDatabaseResourceGroupsRequest is the request to get a list of database groups. |
| com. |
QueryDatabaseResourceGroupsResponse represents the response message containing a list of resource groups. |
| com. |
QueryDatabaseResourceGroupsResponse represents the response message containing a list of resource groups. |
| com. |
QueryProductsRequest is the request to get a list of products. |
| com. |
QueryProductsRequest is the request to get a list of products. |
| com. |
QueryProductsResponse represents the response containing a list of products. |
| com. |
QueryProductsResponse represents the response containing a list of products. |
| com. |
Info associated with recommendation. |
| com. |
Info associated with recommendation. |
| com. |
Compliances associated with signals. |
| com. |
Compliances associated with signals. |
| com. |
Capture the resource details for resources that are included in the delta counts. |
| com. |
Capture the resource details for resources that are included in the delta counts. |
| com. |
Deny maintenance period for the database resource. It specifies the time range during which the maintenance cannot start. This is configured by the customer. |
| com. |
Deny maintenance period for the database resource. It specifies the time range during which the maintenance cannot start. This is configured by the customer. |
| com. |
Maintenance window for the database resource. It specifies preferred time and day of the week and phase in some cases, when the maintenance can start. |
| com. |
Maintenance window for the database resource. It specifies preferred time and day of the week and phase in some cases, when the maintenance can start. |
| com. |
Resource suspension info for a database resource. |
| com. |
Resource suspension info for a database resource. |
| com. |
Metadata about backup retention settings for a database resource. |
| com. |
Metadata about backup retention settings for a database resource. |
| com. |
Info associated with SCC signals. |
| com. |
Info associated with SCC signals. |
| com. |
|
| com. |
Represents a signal. |
| com. |
Represents a signal. |
| com. |
A filter for Signals. If signal_type is left unset, all signals should be returned. |
| com. |
A filter for Signals. If signal_type is left unset, all signals should be returned. |
| com. |
A group of signals and their counts. |
| com. |
A group of signals and their counts. |
| com. |
A group of signal types that specifies what the user is interested in. Used by QueryDatabaseResourceGroups API. |
| com. |
A group of signal types that specifies what the user is interested in. Used by QueryDatabaseResourceGroups API. |
| com. |
|
| com. |
Sub resource details For Spanner/Bigtable instance certain data protection settings are at sub resource level like database/table. |
| com. |
Sub resource details For Spanner/Bigtable instance certain data protection settings are at sub resource level like database/table. |
| com. |
|
| com. |
Tag is a key value pair attached to a resource. |
| com. |
Tag is a key value pair attached to a resource. |
| com. |
TypedValue represents the value of the metric based on data type. |
| com. |
TypedValue represents the value of the metric based on data type. |
Interfaces
Enums
| Enum | Description |
|---|---|
| com. |
|
| com. |
The status of a backup run. |
| com. |
|
| com. |
Proto representing the edition of the instance. NextId: 4. |
| com. |
Engine refers to underlying database binary running in an instance. |
| com. |
IssueSeverity represents the severity of an issue. |
| com. |
The management type of the resource. |
| com. |
OperationErrorType is used to expose specific error type which can happen in database resource while performing an operation. For example, an error can happen while database resource being backed up. |
| com. |
Phase/Week of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance. |
| com. |
ProductType is used to identify a database service offering either in a cloud provider or on-premise. This enum needs to be updated whenever we introduce a new ProductType. |
| com. |
The enum value corresponds to 'type' suffix in the resource_type field. |
| com. |
|
| com. |
Represents the source system from where a signal comes from. More enum values are expected to be added as needed. |
| com. |
Represents the state of a signal. More enum values are expected to be added as needed. |
| com. |
Represents the type of a signal. More values are expected to be added as needed. |
| com. |
SubResourceType refers to the sub-type of database resource. |
| com. |
The reason for suspension of the database resource. |
| com. |