Package Classes (0.2.0)

Summary of entries of Classes for google-cloud-databasecenter.

Classes

DatabaseCenterAsyncClient

DatabaseCenter contains methods to query fleet view for database resources.

DatabaseCenterClient

DatabaseCenter contains methods to query fleet view for database resources.

QueryDatabaseResourceGroupsAsyncPager

A pager for iterating through query_database_resource_groups requests.

This class thinly wraps an initial QueryDatabaseResourceGroupsResponse object, and provides an __aiter__ method to iterate through its resource_groups field.

If there are more pages, the __aiter__ method will make additional QueryDatabaseResourceGroups requests and continue to iterate through the resource_groups field on the corresponding responses.

All the usual QueryDatabaseResourceGroupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

QueryDatabaseResourceGroupsPager

A pager for iterating through query_database_resource_groups requests.

This class thinly wraps an initial QueryDatabaseResourceGroupsResponse object, and provides an __iter__ method to iterate through its resource_groups field.

If there are more pages, the __iter__ method will make additional QueryDatabaseResourceGroups requests and continue to iterate through the resource_groups field on the corresponding responses.

All the usual QueryDatabaseResourceGroupsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

QueryProductsAsyncPager

A pager for iterating through query_products requests.

This class thinly wraps an initial QueryProductsResponse object, and provides an __aiter__ method to iterate through its products field.

If there are more pages, the __aiter__ method will make additional QueryProducts requests and continue to iterate through the products field on the corresponding responses.

All the usual QueryProductsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

QueryProductsPager

A pager for iterating through query_products requests.

This class thinly wraps an initial QueryProductsResponse object, and provides an __iter__ method to iterate through its products field.

If there are more pages, the __iter__ method will make additional QueryProducts requests and continue to iterate through the products field on the corresponding responses.

All the usual QueryProductsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

AdditionalDetail

Details related to signal.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

AutomatedBackupPolicyInfo

Automated backup policy signal info

BackupDRConfig

BackupDRConfig to capture the backup and disaster recovery details of database resource.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

BackupRunInfo

Metadata about latest backup run state for a database resource.

State

The status of a backup run.

DatabaseResource

DatabaseResource represents every individually configured database unit representing compute and/or storage. NextId: 20

DatabaseResourceGroup

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.

DeletionProtectionInfo

Deletion protection signal info for a database resource.

Edition

Proto representing the edition of the instance. NextId: 4.

Engine

Engine refers to underlying database binary running in an instance.

InefficientQueryInfo

Metadata about inefficient query signal info for a database resource.

IssueCount

Count of issues for a group of signals.

IssueSeverity

IssueSeverity represents the severity of an issue.

Label

Label is a key value pair applied to a resource.

MachineConfig

MachineConfig describes the configuration of a machine specific to a Database Resource. NextID: 5

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

MaintenanceInfo

MaintenanceInfo to capture the maintenance details of database resource.

MaintenanceRecommendationInfo

Info associated with maintenance recommendation.

MetricData

MetricData represents the metric data for a database resource.

Metrics

Metrics represents the metrics for a database resource.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

OperationErrorType

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.

OutdatedMinorVersionInfo

Info associated with outdated minor version.

Phase

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. This enum can be extended to support DB Center specific phases for recommendation plan generation.

Product

Product specification for databasecenter resources.

ProductType

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.

QueryDatabaseResourceGroupsRequest

QueryDatabaseResourceGroupsRequest is the request to get a list of database groups.

QueryDatabaseResourceGroupsResponse

QueryDatabaseResourceGroupsResponse represents the response message containing a list of resource groups.

QueryProductsRequest

QueryProductsRequest is the request to get a list of products.

QueryProductsResponse

QueryProductsResponse represents the response containing a list of products.

RecommendationInfo

Info associated with recommendation.

RegulatoryStandard

Compliances associated with signals.

ResourceCategory

The enum value corresponds to 'type' suffix in the resource_type field.

ResourceMaintenanceDenySchedule

Deny maintenance period for the database resource. It specifies the time range during which the maintenance cannot start. This is configured by the customer.

ResourceMaintenanceSchedule

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.

ResourceSuspensionInfo

Resource suspension info for a database resource.

RetentionSettingsInfo

Metadata about backup retention settings for a database resource.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SCCInfo

Info associated with SCC signals.

Signal

Represents a signal.

SignalFilter

A filter for Signals.

If signal_type is left unset, all signals should be returned. For example, the following filter returns all issues. signal_filter: { signal_status: SIGNAL_STATUS_ISSUE; }

Another example, the following filter returns issues of the given type: signal_filter: { type: SIGNAL_TYPE_NO_PROMOTABLE_REPLICA signal_status: ISSUE }

If signal_status is left unset or set to SIGNAL_STATE_UNSPECIFIED, an error should be returned.

SignalGroup

A group of signals and their counts.

SignalSource

Represents the source system from where a signal comes from. More enum values are expected to be added as needed.

SignalStatus

Represents the state of a signal. More enum values are expected to be added as needed.

SignalType

Represents the type of a signal. More values are expected to be added as needed.

SignalTypeGroup

A group of signal types that specifies what the user is interested in.

Used by QueryDatabaseResourceGroups API.

Example:

signal_type_group { name = "AVAILABILITY" types = [SIGNAL_TYPE_NO_PROMOTABLE_REPLICA] }

SubResource

Sub resource details For Spanner/Bigtable instance certain data protection settings are at sub resource level like database/table. This message is used to capture such sub resource details.

SubResourceType

SubResourceType refers to the sub-type of database resource.

SuspensionReason

The reason for suspension of the database resource.

Tag

Tag is a key value pair attached to a resource.

TypedValue

TypedValue represents the value of the metric based on data type.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Modules

pagers

API documentation for databasecenter_v1beta.services.database_center.pagers module.