AggregateFleet provides statistics about the fleet grouped by various fields.
Retrieves the next page of results.
aggregateIssueStats(body=None, x__xgafv=None)
AggregateIssueStats provides database resource issues statistics.
Close httplib2 connections.
queryDatabaseResourceGroups(body=None, x__xgafv=None)
QueryDatabaseResourceGroups returns paginated results of database groups.
queryDatabaseResourceGroups_next()
Retrieves the next page of results.
queryIssues(body=None, x__xgafv=None)
QueryIssues provides a list of issues and recommendations that a user has access to and that are within the requested scope.
Retrieves the next page of results.
queryProducts(pageSize=None, pageToken=None, parent=None, x__xgafv=None)
QueryProducts provides a list of all possible products which can be used to filter database resources.
Retrieves the next page of results.
aggregateFleet(baselineDate_day=None, baselineDate_month=None, baselineDate_year=None, filter=None, groupBy=None, orderBy=None, pageSize=None, pageToken=None, parent=None, x__xgafv=None)
AggregateFleet provides statistics about the fleet grouped by various fields.
Args:
baselineDate_day: integer, Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
baselineDate_month: integer, Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
baselineDate_year: integer, Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
filter: string, Optional. The expression to filter resources. Supported fields are: `full_resource_name`, `resource_type`, `container`, `product.type`, `product.engine`, `product.version`, `location`, `labels`, `issues`, fields of availability_info, data_protection_info, 'resource_name', etc. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. When `AND` and `OR` are both used in the expression, parentheses must be appropriately used to group the combinations. Example: `location="us-east1"` Example: `container="projects/123" OR container="projects/456"` Example: `(container="projects/123" OR container="projects/456") AND location="us-east1"`
groupBy: string, Optional. A field that statistics are grouped by. Valid values are any combination of the following: * container * product.type * product.engine * product.version * location * sub_resource_type * management_type * tag.key * tag.value * tag.source * tag.inherited * label.key * label.value * label.source * has_maintenance_schedule * has_deny_maintenance_schedules Comma separated list.
orderBy: string, Optional. Valid values to order by are: * resource_groups_count * resources_count * and all fields supported by `group_by` The default order is ascending. Add "DESC" after the field name to indicate descending order. Add "ASC" after the field name to indicate ascending order. It supports ordering using multiple fields. For example: `order_by = "resource_groups_count"` sorts response in ascending order `order_by = "resource_groups_count DESC"` sorts response in descending order `order_by = "product.type, product.version DESC, location"` orders by type in ascending order, version in descending order and location in ascending order
pageSize: integer, Optional. If unspecified, at most 50 items will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, Optional. A page token, received from a previous `AggregateFleet` call. Provide this to retrieve the subsequent page. All other parameters should match the parameters in the call that provided the page token except for page_size which can be different.
parent: string, Required. Parent can be a project, a folder, or an organization. The search is limited to the resources within the `scope`. The allowed values are: * projects/{PROJECT_ID} (e.g., "projects/foo-bar") * projects/{PROJECT_NUMBER} (e.g., "projects/12345678") * folders/{FOLDER_NUMBER} (e.g., "folders/1234567") * organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response message to aggregate a fleet by some group by fields.
"nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"resourceGroupsTotalCount": 42, # Count of all resource groups in the fleet. This includes counts from all pages.
"resourceTotalCount": 42, # Count of all resources in the fleet. This includes counts from all pages.
"rows": [ # Represents a row grouped by the fields in the input.
{ # Individual row grouped by a particular dimension.
"deltaDetails": { # 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 or removed in the fleet as well as to capture the resources that have a change in Issue/Signal status. # Optional. Delta counts and details of resources which were added to/deleted from fleet.
"decreasedResources": [ # Details of resources that have decreased.
{ # Capture the resource details for resources that are included in the delta counts.
"container": "A String", # Specifies where the resource is created. For Google Cloud resources, it is the full name of the project.
"fullResourceName": "A String", # Full resource name of the resource.
"location": "A String", # Location of the resource.
"product": { # Product specification for databasecenter resources. # Product type of the resource.
"engine": "A String", # Optional. The specific engine that the underlying database is running.
"minorVersion": "A String", # Optional. Minor version of the underlying database engine. Example values: For MySQL, it could be "8.0.35", "5.7.25" etc. For PostgreSQL, it could be "14.4", "15.5" etc.
"type": "A String", # Optional. Type of specific database product. It could be CloudSQL, AlloyDB etc..
"version": "A String", # Optional. Version of the underlying database engine. Example values: For MySQL, it could be "8.0", "5.7" etc. For Postgres, it could be "14", "15" etc.
},
},
],
"increasedResources": [ # Details of resources that have increased.
{ # Capture the resource details for resources that are included in the delta counts.
"container": "A String", # Specifies where the resource is created. For Google Cloud resources, it is the full name of the project.
"fullResourceName": "A String", # Full resource name of the resource.
"location": "A String", # Location of the resource.
"product": { # Product specification for databasecenter resources. # Product type of the resource.
"engine": "A String", # Optional. The specific engine that the underlying database is running.
"minorVersion": "A String", # Optional. Minor version of the underlying database engine. Example values: For MySQL, it could be "8.0.35", "5.7.25" etc. For PostgreSQL, it could be "14.4", "15.5" etc.
"type": "A String", # Optional. Type of specific database product. It could be CloudSQL, AlloyDB etc..
"version": "A String", # Optional. Version of the underlying database engine. Example values: For MySQL, it could be "8.0", "5.7" etc. For Postgres, it could be "14", "15" etc.
},
},
],
},
"dimension": [ # Group by dimension.
{ # Dimension used to aggregate the fleet.
"container": "A String", # Specifies where the resource is created. For Google Cloud resources, it is the full name of the project.
"edition": "A String", # The edition of the resource.
"hasDenyMaintenanceSchedules": True or False, # Whether the resource has deny maintenance schedules.
"hasMaintenanceSchedule": True or False, # Whether the resource has a maintenance schedule.
"labelKey": "A String", # Label key of the resource.
"labelSource": "A String", # Label source of the resource.
"labelValue": "A String", # Label value of the resource.
"location": "A String", # The location of the resources. It supports returning only regional locations in Google Cloud.
"managementType": "A String", # The management type of the resource.
"productEngine": "A String", # Engine refers to underlying database binary running in an instance.
"productType": "A String", # Type to identify a product
"productVersion": "A String", # Version of the underlying database engine
"resourceCategory": "A String", # The category of the resource.
"resourceType": "A String", # The type of resource defined according to the pattern: {Service Name}/{Type}. Ex: sqladmin.googleapis.com/Instance alloydb.googleapis.com/Cluster alloydb.googleapis.com/Instance spanner.googleapis.com/Instance
"subResourceType": "A String", # Subtype of the resource specified at creation time.
"tagInherited": True or False, # Tag inheritance value of the resource.
"tagKey": "A String", # Tag key of the resource.
"tagSource": "A String", # Tag source of the resource.
"tagValue": "A String", # Tag value of the resource.
},
],
"resourceGroupsCount": 42, # Number of resource groups that have a particular dimension.
"resourcesCount": 42, # Number of resources that have a particular dimension.
},
],
"totalSize": "A String", # Output only. The total number of rows in the entire list.
"unreachable": [ # Unordered list. List of unreachable regions from where data could not be retrieved.
"A String",
],
}
aggregateFleet_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
aggregateIssueStats(body=None, x__xgafv=None)
AggregateIssueStats provides database resource issues statistics.
Args:
body: object, The request body.
The object takes the form of:
{ # AggregateIssueStatsRequest represents the input to the AggregateIssueStats method.
"baselineDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The baseline date w.r.t. which the delta counts are calculated. If not set, delta counts are not included in the response and the response indicates the current state of the fleet.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"filter": "A String", # Optional. The expression to filter resources. Supported fields are: `full_resource_name`, `resource_type`, `container`, `product.type`, `product.engine`, `product.version`, `location`, `labels`, `issues`, fields of availability_info, data_protection_info,'resource_name', etc. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. When `AND` and `OR` are both used in the expression, parentheses must be appropriately used to group the combinations. Example: `location="us-east1"` Example: `container="projects/123" OR container="projects/456"` Example: `(container="projects/123" OR container="projects/456") AND location="us-east1"`
"parent": "A String", # Required. Parent can be a project, a folder, or an organization. The search is limited to the resources within the `scope`. The allowed values are: * projects/{PROJECT_ID} (e.g., "projects/foo-bar") * projects/{PROJECT_NUMBER} (e.g., "projects/12345678") * folders/{FOLDER_NUMBER} (e.g., "folders/1234567") * organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
"signalTypeGroups": [ # Optional. Lists of signal types that are issues.
{ # 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] }
"displayName": "A String", # Required. The display name of a signal group.
"signalTypes": [ # Optional. List of signal types present in the group.
"A String",
],
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response message containing one of more group of relevant health issues for database resources.
"issueGroupStats": [ # List of issue group stats where each group contains stats for resources having a particular combination of relevant issues.
{ # IssueGroupStats refers to stats for a particulare combination of relevant health issues of database resources.
"displayName": "A String", # Database resource level health card name. This will corresponds to one of the requested input group names.
"healthyResourceGroupsCount": 42, # The number of resource groups from the total groups as defined above that are healthy with respect to all of the specified issues.
"healthyResourcesCount": 42, # The number of resources from the total defined above in field total_resources_count that are healthy with respect to all of the specified issues.
"issueStats": [ # List of issues stats containing count of resources having particular issue category.
{ # IssueStats holds stats for a particular signal category.
"deltaDetails": { # 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 or removed in the fleet as well as to capture the resources that have a change in Issue/Signal status. # Optional. Delta counts and details of resources for which issue was raised or fixed.
"decreasedResources": [ # Details of resources that have decreased.
{ # Capture the resource details for resources that are included in the delta counts.
"container": "A String", # Specifies where the resource is created. For Google Cloud resources, it is the full name of the project.
"fullResourceName": "A String", # Full resource name of the resource.
"location": "A String", # Location of the resource.
"product": { # Product specification for databasecenter resources. # Product type of the resource.
"engine": "A String", # Optional. The specific engine that the underlying database is running.
"minorVersion": "A String", # Optional. Minor version of the underlying database engine. Example values: For MySQL, it could be "8.0.35", "5.7.25" etc. For PostgreSQL, it could be "14.4", "15.5" etc.
"type": "A String", # Optional. Type of specific database product. It could be CloudSQL, AlloyDB etc..
"version": "A String", # Optional. Version of the underlying database engine. Example values: For MySQL, it could be "8.0", "5.7" etc. For Postgres, it could be "14", "15" etc.
},
},
],
"increasedResources": [ # Details of resources that have increased.
{ # Capture the resource details for resources that are included in the delta counts.
"container": "A String", # Specifies where the resource is created. For Google Cloud resources, it is the full name of the project.
"fullResourceName": "A String", # Full resource name of the resource.
"location": "A String", # Location of the resource.
"product": { # Product specification for databasecenter resources. # Product type of the resource.
"engine": "A String", # Optional. The specific engine that the underlying database is running.
"minorVersion": "A String", # Optional. Minor version of the underlying database engine. Example values: For MySQL, it could be "8.0.35", "5.7.25" etc. For PostgreSQL, it could be "14.4", "15.5" etc.
"type": "A String", # Optional. Type of specific database product. It could be CloudSQL, AlloyDB etc..
"version": "A String", # Optional. Version of the underlying database engine. Example values: For MySQL, it could be "8.0", "5.7" etc. For Postgres, it could be "14", "15" etc.
},
},
],
},
"issueSeverity": "A String", # Severity of the issue.
"resourceCount": 42, # Number of resources having issues of a given type.
"signalType": "A String", # Type of signal which is an issue.
},
],
"resourceGroupsCount": 42, # Total count of the groups of resources returned by the filter that also have one or more resources for which any of the specified issues are applicable.
"resourcesCount": 42, # Total count of resources returned by the filter for which any of the specified issues are applicable.
},
],
"totalResourceGroupsCount": 42, # Total count of the resource filtered in based on the user given filter.
"totalResourcesCount": 42, # Total count of the resources filtered in based on the user given filter.
"unreachable": [ # Unordered list. List of unreachable regions from where data could not be retrieved.
"A String",
],
}
close()
Close httplib2 connections.
queryDatabaseResourceGroups(body=None, x__xgafv=None)
QueryDatabaseResourceGroups returns paginated results of database groups.
Args:
body: object, The request body.
The object takes the form of:
{ # QueryDatabaseResourceGroupsRequest is the request to get a list of database groups.
"filter": "A String", # Optional. The expression to filter resources. The following fields are filterable: * full_resource_name * resource_type * container * product.type * product.engine * product.version * location * labels * resource_category * machine_config.cpu_count * machine_config.memory_size_bytes * machine_config.shard_count * resource_name * tags * backupdr_config.backupdr_managed * edition The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. When `AND` and `OR` are both used in the expression, parentheses must be appropriately used to group the combinations. Example: `location="us-east1"` Example: `container="projects/123" OR container="projects/456"` Example: `(container="projects/123" OR container="projects/456") AND location="us-east1"` Example: `full_resource_name=~"test"` Example: `full_resource_name=~"test.*master"`
"orderBy": "A String", # Optional. A field that specifies the sort order of the results. The following fields are sortable: * full_resource_name * product.type * product.engine * product.version * container * issue_count * machine_config.vcpu_count * machine_config.memory_size_bytes * machine_config.shard_count * resource_name * issue_severity * signal_type * location * resource_type * instance_type * edition * metrics.p99_cpu_utilization * metrics.p95_cpu_utilization * metrics.current_storage_used_bytes * metrics.node_count * metrics.processing_unit_count * metrics.current_memory_used_bytes * metrics.peak_storage_utilization * metrics.peak_number_connections * metrics.peak_memory_utilization The default order is ascending. Add "DESC" after the field name to indicate descending order. Add "ASC" after the field name to indicate ascending order. It only supports a single field at a time. For example: `order_by = "full_resource_name"` sorts response in ascending order `order_by = "full_resource_name DESC"` sorts response in descending order `order_by = "issue_count DESC"` sorts response in descending order of count of all issues associated with a resource. More explicitly, `order_by = "full_resource_name, product"` is not supported.
"pageSize": 42, # Optional. If unspecified, at most 50 resource groups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
"pageToken": "A String", # Optional. A page token, received from a previous `QueryDatabaseResourceGroupsRequest` call. Provide this to retrieve the subsequent page. All parameters except page_token should match the parameters in the call that provided the page page token.
"parent": "A String", # Required. Parent can be a project, a folder, or an organization. The search is limited to the resources within the `scope`. The allowed values are: * projects/{PROJECT_ID} (e.g., "projects/foo-bar") * projects/{PROJECT_NUMBER} (e.g., "projects/12345678") * folders/{FOLDER_NUMBER} (e.g., "folders/1234567") * organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
"signalFilters": [ # Optional. Filters based on signals. The list will be ORed together and then ANDed with the `filters` field above.
{ # 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.
"signalStatus": "A String", # Optional. Represents the status of the Signal for which the filter is for.
"signalType": "A String", # Optional. Represents the type of the Signal for which the filter is for.
},
],
"signalTypeGroups": [ # Optional. Groups of signal types that are requested.
{ # 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] }
"displayName": "A String", # Required. The display name of a signal group.
"signalTypes": [ # Optional. List of signal types present in the group.
"A String",
],
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # QueryDatabaseResourceGroupsResponse represents the response message containing a list of resource groups.
"nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"resourceGroups": [ # List of database resource groups that pass the filter.
{ # 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.
"rootResources": [ # A database resource that serves as a root of the group of database resources. It is repeated just in case we have the concept of multiple roots in the future, however, it will only be populated with a single value for now.
{ # DatabaseResource represents every individually configured database unit representing compute and/or storage.
"affiliations": [ # Optional. Affiliation details of the resource.
{ # Affiliation information of a resource
"fullResourceName": "A String", # Optional. Full resource name
"lineages": [ # Optional. Multiple lineages can be created from a resource. For example, a resource can be replicated to multiple target resources. In this case, there will be multiple lineages for the resource, one for each target resource.
{ # lineage information of the affiliated resources This captures source, target and process which created the lineage.
"processFqn": "A String", # Optional. FQN of process which created the lineage i.e. dataplex, datastream etc.
"processType": "A String", # Optional. Type of process which created the lineage.
"sourceFqn": "A String", # Optional. FQN of source table / column
"targetFqn": "A String", # Optional. FQN of target table / column
},
],
"resourceId": "A String", # Optional. resource id of affiliated resource
},
],
"backupdrConfig": { # BackupDRConfig to capture the backup and disaster recovery details of database resource. # Optional. Backup and disaster recovery details for the resource.
"backupdrManaged": True or False, # Indicates if the resource is managed by BackupDR.
},
"childResources": [ # List of children associated with a database group.
# Object with schema name: DatabaseResource
],
"container": "A String", # Specifies where the resource is created. For Google Cloud resources, it is the full name of the project.
"edition": "A String", # The edition of the resource.
"fullResourceName": "A String", # The full resource name, based on CAIS resource name format https://cloud.google.com/asset-inventory/docs/resource-name-format Example: `//cloudsql.googleapis.com/projects/project-number/instances/mysql-1` `//cloudsql.googleapis.com/projects/project-number/instances/postgres-1` `//spanner.googleapis.com/projects/project-number/instances/spanner-instance-1` `//alloydb.googleapis.com/projects/project-number/locations/us-central1/clusters/c1` `//alloydb.googleapis.com/projects/project-number/locations/us-central1/clusters/c1/instances/i1`
"labels": [ # Labels applied on the resource. The requirements for labels assigned to Google Cloud resources may be found at https://cloud.google.com/resource-manager/docs/labels-overview#requirements
{ # Label is a key value pair applied to a resource.
"key": "A String", # The key part of the label.
"source": "A String", # The source of the Label. Source is empty if the label is directly attached to the resource and not inherited.
"value": "A String", # The value part of the label.
},
],
"location": "A String", # The location of the resources. It supports returning only regional locations in Google Cloud. These are of the form: "us-central1", "us-east1", etc. See https://cloud.google.com/about/locations for a list of such regions.
"machineConfig": { # MachineConfig describes the configuration of a machine specific to a Database Resource. # Machine configuration like CPU, memory, etc for the resource.
"baselineSlotCount": "A String", # Optional. Baseline slots for BigQuery Reservations. Baseline slots are in increments of 50.
"maxReservationSlotCount": "A String", # Optional. Max slots for BigQuery Reservations. Max slots are in increments of 50.
"memorySizeBytes": "A String", # Memory size in bytes.
"shardCount": 42, # Optional. The number of Shards (if applicable).
"vcpuCount": 3.14, # Optional. The number of vCPUs (if applicable).
},
"maintenanceInfo": { # MaintenanceInfo to capture the maintenance details of database resource. # Optional. The maintenance information of the resource.
"currentVersionReleaseDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. The date when the maintenance version was released.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"denyMaintenanceSchedules": [ # Optional. List of Deny maintenance period for the database resource.
{ # Deny maintenance period for the database resource. It specifies the time range during which the maintenance cannot start. This is configured by the customer.
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. Deny period end date.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The start date of the deny maintenance period.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time in UTC when the deny period starts on start_date and ends on end_date.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
],
"maintenanceSchedule": { # 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. # Optional. Maintenance window for the database resource.
"day": "A String", # Optional. Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.
"phase": "A String", # Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance
"startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Preferred time to start the maintenance operation on the specified day.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
"maintenanceVersion": "A String", # Output only. Current Maintenance version of the database resource. Example: "MYSQL_8_0_41.R20250531.01_15"
"possibleFailureReasons": [ # Output only. List of possible reasons why the maintenance is not completed. This is an optional field and is only populated if there are any reasons for failures recorded for the maintenance by DB Center. FAILURE maintenance status may not always have a failure reason.
"A String",
],
"previousMaintenanceVersion": "A String", # Output only. Previous maintenance version of the database resource. Example: "MYSQL_8_0_41.R20250531.01_15". This is available once a minor version maintenance is complete on a database resource.
"state": "A String", # Output only. Resource maintenance state. This is to capture the current state of the maintenance.
"upcomingMaintenance": { # Upcoming maintenance window for the database resource. # Output only. Upcoming maintenance window for the database resource. This is only populated for an engine, if upcoming maintenance is scheduled for the resource. This schedule is generated per engine and engine version, and there is only one upcoming maintenance window at any given time. In case of upcoming maintenance, the maintenance_state will be set to SCHEDULED first, and then IN_PROGRESS when the maintenance window starts.
"endTime": "A String", # Output only. End time of the upcoming maintenance. This is only populated for an engine, if end time is public for the engine.
"startTime": "A String", # Output only. Start time of the upcoming maintenance. Start time is always populated when an upcoming maintenance is scheduled.
},
},
"metrics": { # Metrics represents the metrics for a database resource. # Observable metrics for the resource e.g. CPU utilization, memory utilization, etc.
"currentMemoryUsedBytes": { # MetricData represents the metric data for a database resource. # Current memory used by the resource in bytes.
"observationTime": "A String", # The time the metric was observed in the metric source service.
"value": { # TypedValue represents the value of the metric based on data type. # The value associated with the metric.
"doubleValue": 3.14, # The value of the metric as double.
"int64Value": "A String", # The value of the metric as int.
},
},
"currentStorageUsedBytes": { # MetricData represents the metric data for a database resource. # Current storage used by the resource in bytes.
"observationTime": "A String", # The time the metric was observed in the metric source service.
"value": { # TypedValue represents the value of the metric based on data type. # The value associated with the metric.
"doubleValue": 3.14, # The value of the metric as double.
"int64Value": "A String", # The value of the metric as int.
},
},
"nodeCount": { # MetricData represents the metric data for a database resource. # Number of nodes in instance for spanner or bigtable.
"observationTime": "A String", # The time the metric was observed in the metric source service.
"value": { # TypedValue represents the value of the metric based on data type. # The value associated with the metric.
"doubleValue": 3.14, # The value of the metric as double.
"int64Value": "A String", # The value of the metric as int.
},
},
"p95CpuUtilization": { # MetricData represents the metric data for a database resource. # P95 CPU utilization observed for the resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).
"observationTime": "A String", # The time the metric was observed in the metric source service.
"value": { # TypedValue represents the value of the metric based on data type. # The value associated with the metric.
"doubleValue": 3.14, # The value of the metric as double.
"int64Value": "A String", # The value of the metric as int.
},
},
"p99CpuUtilization": { # MetricData represents the metric data for a database resource. # P99 CPU utilization observed for the resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).
"observationTime": "A String", # The time the metric was observed in the metric source service.
"value": { # TypedValue represents the value of the metric based on data type. # The value associated with the metric.
"doubleValue": 3.14, # The value of the metric as double.
"int64Value": "A String", # The value of the metric as int.
},
},
"peakMemoryUtilization": { # MetricData represents the metric data for a database resource. # Peak memory utilization observed for the resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).
"observationTime": "A String", # The time the metric was observed in the metric source service.
"value": { # TypedValue represents the value of the metric based on data type. # The value associated with the metric.
"doubleValue": 3.14, # The value of the metric as double.
"int64Value": "A String", # The value of the metric as int.
},
},
"peakNumberConnections": { # MetricData represents the metric data for a database resource. # Peak number of connections observed for the resource. The value is a positive integer.
"observationTime": "A String", # The time the metric was observed in the metric source service.
"value": { # TypedValue represents the value of the metric based on data type. # The value associated with the metric.
"doubleValue": 3.14, # The value of the metric as double.
"int64Value": "A String", # The value of the metric as int.
},
},
"peakStorageUtilization": { # MetricData represents the metric data for a database resource. # Peak storage utilization observed for the resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).
"observationTime": "A String", # The time the metric was observed in the metric source service.
"value": { # TypedValue represents the value of the metric based on data type. # The value associated with the metric.
"doubleValue": 3.14, # The value of the metric as double.
"int64Value": "A String", # The value of the metric as int.
},
},
"processingUnitCount": { # MetricData represents the metric data for a database resource. # Number of processing units in spanner.
"observationTime": "A String", # The time the metric was observed in the metric source service.
"value": { # TypedValue represents the value of the metric based on data type. # The value associated with the metric.
"doubleValue": 3.14, # The value of the metric as double.
"int64Value": "A String", # The value of the metric as int.
},
},
},
"product": { # Product specification for databasecenter resources. # The product this resource represents.
"engine": "A String", # Optional. The specific engine that the underlying database is running.
"minorVersion": "A String", # Optional. Minor version of the underlying database engine. Example values: For MySQL, it could be "8.0.35", "5.7.25" etc. For PostgreSQL, it could be "14.4", "15.5" etc.
"type": "A String", # Optional. Type of specific database product. It could be CloudSQL, AlloyDB etc..
"version": "A String", # Optional. Version of the underlying database engine. Example values: For MySQL, it could be "8.0", "5.7" etc. For Postgres, it could be "14", "15" etc.
},
"resourceCategory": "A String", # The category of the resource.
"resourceName": "A String", # The name of the resource(The last part of the full resource name). Example: For full resource name - `//cloudsql.googleapis.com/projects/project-number/instances/mysql-1`, resource name - `mysql-1` For full resource name - `//cloudsql.googleapis.com/projects/project-number/instances/postgres-1` , resource name - `postgres-1` Note: In some cases, there might be more than one resource with the same resource name.
"resourceType": "A String", # The type of resource defined according to the pattern: {Service Name}/{Type}. Ex: sqladmin.googleapis.com/Instance alloydb.googleapis.com/Cluster alloydb.googleapis.com/Instance spanner.googleapis.com/Instance
"signalGroups": [ # The list of signal groups and count of issues related to the resource. Only those signals which have been requested would be included.
{ # A group of signals and their counts.
"displayName": "A String", # Title of a signal group corresponding to the request.
"issueCount": 42, # When applied to a DatabaseResource represents count of issues associated with the resource. A signal is an issue when its SignalStatus field is set to SIGNAL_STATUS_ISSUE.
"signals": [ # List of signals present in the group and associated with the resource. Only applies to a DatabaseResource.
{ # Represents a signal.
"additionalDetails": [ # Additional information related to the signal. In the case of composite signals, this field encapsulates details associated with granular signals, having a signal status of "ISSUE"; signals with a status of "OK" are not included. For granular signals, it encompasses information relevant to the signal, regardless of the signal status.
{ # Details related to signal.
"automatedBackupPolicyInfo": { # Automated backup policy signal info # Automated backup policy information applies to signals with type SIGNAL_TYPE_NO_AUTOMATED_BACKUP_POLICY.
"isEnabled": True or False, # Is automated policy enabled.
"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. # Optional. Sub resource details associated with the signal.
"container": "A String", # Specifies where the resource is created. For Google Cloud resources, it is the full name of the project.
"fullResourceName": "A String", # Optional. Resource name associated with the sub resource where backup settings are configured. E.g."//spanner.googleapis.com/projects/project1/instances/inst1/databases/db1" for Spanner where backup retention is configured on database within an instance OPTIONAL
"product": { # Product specification for databasecenter resources. # Optional. Product information associated with the sub resource where backup retention settings are configured. e.g. ``` product: { type : PRODUCT_TYPE_SPANNER engine : ENGINE_CLOUD_SPANNER_WITH_POSTGRES_DIALECT } ``` for Spanner where backup is configured on database within an instance OPTIONAL
"engine": "A String", # Optional. The specific engine that the underlying database is running.
"minorVersion": "A String", # Optional. Minor version of the underlying database engine. Example values: For MySQL, it could be "8.0.35", "5.7.25" etc. For PostgreSQL, it could be "14.4", "15.5" etc.
"type": "A String", # Optional. Type of specific database product. It could be CloudSQL, AlloyDB etc..
"version": "A String", # Optional. Version of the underlying database engine. Example values: For MySQL, it could be "8.0", "5.7" etc. For Postgres, it could be "14", "15" etc.
},
"resourceType": "A String", # Optional. Resource type associated with the sub resource where backup settings are configured. E.g. "spanner.googleapis.com/Database" for Spanner where backup retention is configured on database within an instance OPTIONAL
},
},
"backupRunInfo": { # Metadata about latest backup run state for a database resource. # Backup run information applies to signals with types SIGNAL_TYPE_LAST_BACKUP_FAILED and SIGNAL_TYPE_LAST_BACKUP_OLD.
"endTime": "A String", # The time the backup operation completed.
"errorMessage": "A String", # Additional information about the error encountered.
"operationErrorType": "A String", # Optional. OperationErrorType to expose specific error when backup operation of database resource failed, that is state is FAILED.
"startTime": "A String", # The time the backup operation started.
"state": "A String", # Output only. The state of this run.
"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. # Optional. Sub resource details associated with the backup run.
"container": "A String", # Specifies where the resource is created. For Google Cloud resources, it is the full name of the project.
"fullResourceName": "A String", # Optional. Resource name associated with the sub resource where backup settings are configured. E.g."//spanner.googleapis.com/projects/project1/instances/inst1/databases/db1" for Spanner where backup retention is configured on database within an instance OPTIONAL
"product": { # Product specification for databasecenter resources. # Optional. Product information associated with the sub resource where backup retention settings are configured. e.g. ``` product: { type : PRODUCT_TYPE_SPANNER engine : ENGINE_CLOUD_SPANNER_WITH_POSTGRES_DIALECT } ``` for Spanner where backup is configured on database within an instance OPTIONAL
"engine": "A String", # Optional. The specific engine that the underlying database is running.
"minorVersion": "A String", # Optional. Minor version of the underlying database engine. Example values: For MySQL, it could be "8.0.35", "5.7.25" etc. For PostgreSQL, it could be "14.4", "15.5" etc.
"type": "A String", # Optional. Type of specific database product. It could be CloudSQL, AlloyDB etc..
"version": "A String", # Optional. Version of the underlying database engine. Example values: For MySQL, it could be "8.0", "5.7" etc. For Postgres, it could be "14", "15" etc.
},
"resourceType": "A String", # Optional. Resource type associated with the sub resource where backup settings are configured. E.g. "spanner.googleapis.com/Database" for Spanner where backup retention is configured on database within an instance OPTIONAL
},
},
"deletionProtectionInfo": { # Deletion protection signal info for a database resource. # Deletion protection information applies to signals with type SIGNAL_TYPE_NO_DELETION_PROTECTION
"deletionProtectionEnabled": True or False, # Is deletion protection enabled.
"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. # Optional. Sub resource details associated with the signal.
"container": "A String", # Specifies where the resource is created. For Google Cloud resources, it is the full name of the project.
"fullResourceName": "A String", # Optional. Resource name associated with the sub resource where backup settings are configured. E.g."//spanner.googleapis.com/projects/project1/instances/inst1/databases/db1" for Spanner where backup retention is configured on database within an instance OPTIONAL
"product": { # Product specification for databasecenter resources. # Optional. Product information associated with the sub resource where backup retention settings are configured. e.g. ``` product: { type : PRODUCT_TYPE_SPANNER engine : ENGINE_CLOUD_SPANNER_WITH_POSTGRES_DIALECT } ``` for Spanner where backup is configured on database within an instance OPTIONAL
"engine": "A String", # Optional. The specific engine that the underlying database is running.
"minorVersion": "A String", # Optional. Minor version of the underlying database engine. Example values: For MySQL, it could be "8.0.35", "5.7.25" etc. For PostgreSQL, it could be "14.4", "15.5" etc.
"type": "A String", # Optional. Type of specific database product. It could be CloudSQL, AlloyDB etc..
"version": "A String", # Optional. Version of the underlying database engine. Example values: For MySQL, it could be "8.0", "5.7" etc. For Postgres, it could be "14", "15" etc.
},
"resourceType": "A String", # Optional. Resource type associated with the sub resource where backup settings are configured. E.g. "spanner.googleapis.com/Database" for Spanner where backup retention is configured on database within an instance OPTIONAL
},
},
"inefficientQueryInfo": { # Metadata about inefficient query signal info for a database resource. # Inefficient query information applies to signals with type SIGNAL_TYPE_INEFFICIENT_QUERY.
"database": "A String", # Name of the database where index is required. For example, "db1", which is the name of the database present in the instance.
"impactedQueriesCount": "A String", # Count of queries to be impacted if index is applied
"sqlIndexStatement": "A String", # SQL statement of the index. Based on the ddl type, this will be either CREATE INDEX or DROP INDEX.
"storageCostBytes": "A String", # Cost of additional disk usage in bytes
"table": "A String", # Name of the table where index is required
},
"maintenanceRecommendationInfo": { # Info associated with maintenance recommendation. # Maintenance recommendation information applies to signals with type SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES.
"resourceMaintenanceSchedules": [ # Optional. List of recommended maintenance schedules for the database resource.
{ # 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.
"day": "A String", # Optional. Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.
"phase": "A String", # Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance
"startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Preferred time to start the maintenance operation on the specified day.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
],
},
"outdatedMinorVersionInfo": { # Info associated with outdated minor version. # Outdated minor version information applies to signals with type SIGNAL_TYPE_OUTDATED_MINOR_VERSION.
"recommendedMinorVersion": "A String", # Recommended minor version of the underlying database engine. Example values: For MySQL, it could be "8.0.35", "5.7.25" etc. For PostgreSQL, it could be "14.4", "15.5" etc.
},
"recommendationInfo": { # Info associated with recommendation. # Recommendation information applies to recommendations.
"recommender": "A String", # Name of recommendation. Examples: organizations/1234/locations/us-central1/recommenders/google.cloudsql.instance.PerformanceRecommender/recommendations/9876
"recommenderId": "A String", # ID of recommender. Examples: "google.cloudsql.instance.PerformanceRecommender"
"recommenderSubtype": "A String", # Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = "google.cloudsql.instance.PerformanceRecommender", recommender_subtype can be "MYSQL_HIGH_NUMBER_OF_OPEN_TABLES_BEST_PRACTICE"/"POSTGRES_HIGH_TRANSACTION_ID_UTILIZATION_BEST_PRACTICE"
},
"resourceSuspensionInfo": { # Resource suspension info for a database resource. # Resource suspension information applies to signals with type SIGNAL_TYPE_RESOURCE_SUSPENDED.
"resourceSuspended": True or False, # Is resource suspended.
"suspensionReason": "A String", # Suspension reason for the resource.
},
"sccInfo": { # Info associated with SCC signals. # SCC information applies to SCC signals.
"category": "A String", # Name by which SCC calls this signal.
"externalUri": "A String", # External URI which points to a SCC page associated with the signal.
"regulatoryStandards": [ # Compliances that are associated with the signal.
{ # Compliances associated with signals.
"standard": "A String", # Name of industry compliance standards, such as such as CIS, PCI, and OWASP.
"version": "A String", # Version of the standard or benchmark, for example, 1.1.
},
],
"signal": "A String", # Name of the signal.
},
"shortBackupRetentionInfo": { # Metadata about backup retention settings for a database resource. # Short backup retention information applies to signals with type SIGNAL_TYPE_SHORT_BACKUP_RETENTION.
"durationBasedRetention": "A String", # Duration based retention period i.e. 172800 seconds (2 days)
"quantityBasedRetention": 42, # Number of backups that will be retained.
"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. # Optional. Sub resource details associated with the backup configuration.
"container": "A String", # Specifies where the resource is created. For Google Cloud resources, it is the full name of the project.
"fullResourceName": "A String", # Optional. Resource name associated with the sub resource where backup settings are configured. E.g."//spanner.googleapis.com/projects/project1/instances/inst1/databases/db1" for Spanner where backup retention is configured on database within an instance OPTIONAL
"product": { # Product specification for databasecenter resources. # Optional. Product information associated with the sub resource where backup retention settings are configured. e.g. ``` product: { type : PRODUCT_TYPE_SPANNER engine : ENGINE_CLOUD_SPANNER_WITH_POSTGRES_DIALECT } ``` for Spanner where backup is configured on database within an instance OPTIONAL
"engine": "A String", # Optional. The specific engine that the underlying database is running.
"minorVersion": "A String", # Optional. Minor version of the underlying database engine. Example values: For MySQL, it could be "8.0.35", "5.7.25" etc. For PostgreSQL, it could be "14.4", "15.5" etc.
"type": "A String", # Optional. Type of specific database product. It could be CloudSQL, AlloyDB etc..
"version": "A String", # Optional. Version of the underlying database engine. Example values: For MySQL, it could be "8.0", "5.7" etc. For Postgres, it could be "14", "15" etc.
},
"resourceType": "A String", # Optional. Resource type associated with the sub resource where backup settings are configured. E.g. "spanner.googleapis.com/Database" for Spanner where backup retention is configured on database within an instance OPTIONAL
},
"timestampBasedRetentionTime": "A String", # Timestamp based retention period i.e. till 2024-05-01T00:00:00Z
},
"signalEventTime": "A String", # Event time when signal was recorded by source service.
"signalSource": "A String", # Where the signal is coming from.
"signalType": "A String", # Type of the signal.
},
],
"issueCreateTime": "A String", # Timestamp when the issue was created (when signal status is ISSUE).
"issueSeverity": "A String", # Severity of the issue.
"signalStatus": "A String", # Status of the signal.
"signalType": "A String", # Type of the signal.
},
],
},
],
"subResourceType": "A String", # Subtype of the resource specified at creation time.
"tags": [ # Tags applied on the resource. The requirements for tags assigned to Google Cloud resources may be found at https://cloud.google.com/resource-manager/docs/tags/tags-overview
{ # Tag is a key value pair attached to a resource.
"inherited": True or False, # Indicates the inheritance status of a tag value attached to the given resource. If the tag value is inherited from one of the resource's ancestors, inherited will be true. If false, then the tag value is directly attached to the resource.
"key": "A String",
"source": "A String", # The source of the tag. According to https://cloud.google.com/resource-manager/docs/tags/tags-overview#tags_and_labels, tags can be created only at the project or organization level. Tags can be inherited from different project as well not just the current project where the database resource is present. Format: "projects/{PROJECT_ID}", "projects/{PROJECT_NUMBER}", "organizations/{ORGANIZATION_ID}"
"value": "A String", # The value part of the tag.
},
],
},
],
"signalGroups": [ # The filtered signal groups and the count of issues associated with the resources that have been filtered in.
{ # Count of issues for a group of signals.
"displayName": "A String", # Title of a signal group corresponding to the request.
"issueCount": 42, # The count of the number of issues associated with those resources that are explicitly filtered in by the filters present in the request. A signal is an issue when its SignalStatus field is set to SIGNAL_STATUS_ISSUE.
},
],
},
],
"totalSize": "A String", # Output only. The total number of resource groups in the entire list.
"unreachable": [ # Unordered list. List of unreachable regions from where data could not be retrieved.
"A String",
],
}
queryDatabaseResourceGroups_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
queryIssues(body=None, x__xgafv=None)
QueryIssues provides a list of issues and recommendations that a user has access to and that are within the requested scope.
Args:
body: object, The request body.
The object takes the form of:
{ # QueryIssuesRequest is the request to get a list of issues.
"filter": "A String", # Optional. Supported fields are: 'product', `location`, `issue_severity`, 'tags', 'labels',
"orderBy": "A String", # Optional. Following fields are sortable: SignalType Product Location IssueSeverity The default order is ascending. Add "DESC" after the field name to indicate descending order. Add "ASC" after the field name to indicate ascending order. It only supports a single field at a time.
"pageSize": 42, # Optional. If unspecified, at most 50 issues will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
"pageToken": "A String", # Optional. A page token, received from a previous `QueryIssues` call. Provide this to retrieve the subsequent page. All parameters except page size should match the parameters used in the call that provided the page token.
"parent": "A String", # Required. Parent can be a project, a folder, or an organization. The list is limited to the one attached to resources within the `scope` that a user has access to. The allowed values are: * projects/{PROJECT_ID} (e.g., "projects/foo-bar") * projects/{PROJECT_NUMBER} (e.g., "projects/12345678") * folders/{FOLDER_NUMBER} (e.g., "folders/1234567") * organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
"signalProductsFilters": [ # Optional. Filters based on signal and product. The filter list will be ORed across pairs and ANDed within a signal and products pair.
{ # SignalProductsFilters represents a signal and list of supported products.
"products": [ # Optional. Product type of the resource. The version of the product will be ignored in filtering.
{ # Product specification for databasecenter resources.
"engine": "A String", # Optional. The specific engine that the underlying database is running.
"minorVersion": "A String", # Optional. Minor version of the underlying database engine. Example values: For MySQL, it could be "8.0.35", "5.7.25" etc. For PostgreSQL, it could be "14.4", "15.5" etc.
"type": "A String", # Optional. Type of specific database product. It could be CloudSQL, AlloyDB etc..
"version": "A String", # Optional. Version of the underlying database engine. Example values: For MySQL, it could be "8.0", "5.7" etc. For Postgres, it could be "14", "15" etc.
},
],
"signalType": "A String", # Optional. The type of signal.
},
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # QueryIssuesResponse is the response containing a list of issues.
"nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"resourceIssues": [ # List of issues and resource details.
{ # DatabaseResource and Issue associated with it.
"resource": { # DatabaseResource represents every individually configured database unit representing compute and/or storage. # Resource associated with the issue.
"affiliations": [ # Optional. Affiliation details of the resource.
{ # Affiliation information of a resource
"fullResourceName": "A String", # Optional. Full resource name
"lineages": [ # Optional. Multiple lineages can be created from a resource. For example, a resource can be replicated to multiple target resources. In this case, there will be multiple lineages for the resource, one for each target resource.
{ # lineage information of the affiliated resources This captures source, target and process which created the lineage.
"processFqn": "A String", # Optional. FQN of process which created the lineage i.e. dataplex, datastream etc.
"processType": "A String", # Optional. Type of process which created the lineage.
"sourceFqn": "A String", # Optional. FQN of source table / column
"targetFqn": "A String", # Optional. FQN of target table / column
},
],
"resourceId": "A String", # Optional. resource id of affiliated resource
},
],
"backupdrConfig": { # BackupDRConfig to capture the backup and disaster recovery details of database resource. # Optional. Backup and disaster recovery details for the resource.
"backupdrManaged": True or False, # Indicates if the resource is managed by BackupDR.
},
"childResources": [ # List of children associated with a database group.
# Object with schema name: DatabaseResource
],
"container": "A String", # Specifies where the resource is created. For Google Cloud resources, it is the full name of the project.
"edition": "A String", # The edition of the resource.
"fullResourceName": "A String", # The full resource name, based on CAIS resource name format https://cloud.google.com/asset-inventory/docs/resource-name-format Example: `//cloudsql.googleapis.com/projects/project-number/instances/mysql-1` `//cloudsql.googleapis.com/projects/project-number/instances/postgres-1` `//spanner.googleapis.com/projects/project-number/instances/spanner-instance-1` `//alloydb.googleapis.com/projects/project-number/locations/us-central1/clusters/c1` `//alloydb.googleapis.com/projects/project-number/locations/us-central1/clusters/c1/instances/i1`
"labels": [ # Labels applied on the resource. The requirements for labels assigned to Google Cloud resources may be found at https://cloud.google.com/resource-manager/docs/labels-overview#requirements
{ # Label is a key value pair applied to a resource.
"key": "A String", # The key part of the label.
"source": "A String", # The source of the Label. Source is empty if the label is directly attached to the resource and not inherited.
"value": "A String", # The value part of the label.
},
],
"location": "A String", # The location of the resources. It supports returning only regional locations in Google Cloud. These are of the form: "us-central1", "us-east1", etc. See https://cloud.google.com/about/locations for a list of such regions.
"machineConfig": { # MachineConfig describes the configuration of a machine specific to a Database Resource. # Machine configuration like CPU, memory, etc for the resource.
"baselineSlotCount": "A String", # Optional. Baseline slots for BigQuery Reservations. Baseline slots are in increments of 50.
"maxReservationSlotCount": "A String", # Optional. Max slots for BigQuery Reservations. Max slots are in increments of 50.
"memorySizeBytes": "A String", # Memory size in bytes.
"shardCount": 42, # Optional. The number of Shards (if applicable).
"vcpuCount": 3.14, # Optional. The number of vCPUs (if applicable).
},
"maintenanceInfo": { # MaintenanceInfo to capture the maintenance details of database resource. # Optional. The maintenance information of the resource.
"currentVersionReleaseDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. The date when the maintenance version was released.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"denyMaintenanceSchedules": [ # Optional. List of Deny maintenance period for the database resource.
{ # Deny maintenance period for the database resource. It specifies the time range during which the maintenance cannot start. This is configured by the customer.
"endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. Deny period end date.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The start date of the deny maintenance period.
"day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
"month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
"time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time in UTC when the deny period starts on start_date and ends on end_date.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
],
"maintenanceSchedule": { # 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. # Optional. Maintenance window for the database resource.
"day": "A String", # Optional. Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.
"phase": "A String", # Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance
"startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Preferred time to start the maintenance operation on the specified day.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
"maintenanceVersion": "A String", # Output only. Current Maintenance version of the database resource. Example: "MYSQL_8_0_41.R20250531.01_15"
"possibleFailureReasons": [ # Output only. List of possible reasons why the maintenance is not completed. This is an optional field and is only populated if there are any reasons for failures recorded for the maintenance by DB Center. FAILURE maintenance status may not always have a failure reason.
"A String",
],
"previousMaintenanceVersion": "A String", # Output only. Previous maintenance version of the database resource. Example: "MYSQL_8_0_41.R20250531.01_15". This is available once a minor version maintenance is complete on a database resource.
"state": "A String", # Output only. Resource maintenance state. This is to capture the current state of the maintenance.
"upcomingMaintenance": { # Upcoming maintenance window for the database resource. # Output only. Upcoming maintenance window for the database resource. This is only populated for an engine, if upcoming maintenance is scheduled for the resource. This schedule is generated per engine and engine version, and there is only one upcoming maintenance window at any given time. In case of upcoming maintenance, the maintenance_state will be set to SCHEDULED first, and then IN_PROGRESS when the maintenance window starts.
"endTime": "A String", # Output only. End time of the upcoming maintenance. This is only populated for an engine, if end time is public for the engine.
"startTime": "A String", # Output only. Start time of the upcoming maintenance. Start time is always populated when an upcoming maintenance is scheduled.
},
},
"metrics": { # Metrics represents the metrics for a database resource. # Observable metrics for the resource e.g. CPU utilization, memory utilization, etc.
"currentMemoryUsedBytes": { # MetricData represents the metric data for a database resource. # Current memory used by the resource in bytes.
"observationTime": "A String", # The time the metric was observed in the metric source service.
"value": { # TypedValue represents the value of the metric based on data type. # The value associated with the metric.
"doubleValue": 3.14, # The value of the metric as double.
"int64Value": "A String", # The value of the metric as int.
},
},
"currentStorageUsedBytes": { # MetricData represents the metric data for a database resource. # Current storage used by the resource in bytes.
"observationTime": "A String", # The time the metric was observed in the metric source service.
"value": { # TypedValue represents the value of the metric based on data type. # The value associated with the metric.
"doubleValue": 3.14, # The value of the metric as double.
"int64Value": "A String", # The value of the metric as int.
},
},
"nodeCount": { # MetricData represents the metric data for a database resource. # Number of nodes in instance for spanner or bigtable.
"observationTime": "A String", # The time the metric was observed in the metric source service.
"value": { # TypedValue represents the value of the metric based on data type. # The value associated with the metric.
"doubleValue": 3.14, # The value of the metric as double.
"int64Value": "A String", # The value of the metric as int.
},
},
"p95CpuUtilization": { # MetricData represents the metric data for a database resource. # P95 CPU utilization observed for the resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).
"observationTime": "A String", # The time the metric was observed in the metric source service.
"value": { # TypedValue represents the value of the metric based on data type. # The value associated with the metric.
"doubleValue": 3.14, # The value of the metric as double.
"int64Value": "A String", # The value of the metric as int.
},
},
"p99CpuUtilization": { # MetricData represents the metric data for a database resource. # P99 CPU utilization observed for the resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).
"observationTime": "A String", # The time the metric was observed in the metric source service.
"value": { # TypedValue represents the value of the metric based on data type. # The value associated with the metric.
"doubleValue": 3.14, # The value of the metric as double.
"int64Value": "A String", # The value of the metric as int.
},
},
"peakMemoryUtilization": { # MetricData represents the metric data for a database resource. # Peak memory utilization observed for the resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).
"observationTime": "A String", # The time the metric was observed in the metric source service.
"value": { # TypedValue represents the value of the metric based on data type. # The value associated with the metric.
"doubleValue": 3.14, # The value of the metric as double.
"int64Value": "A String", # The value of the metric as int.
},
},
"peakNumberConnections": { # MetricData represents the metric data for a database resource. # Peak number of connections observed for the resource. The value is a positive integer.
"observationTime": "A String", # The time the metric was observed in the metric source service.
"value": { # TypedValue represents the value of the metric based on data type. # The value associated with the metric.
"doubleValue": 3.14, # The value of the metric as double.
"int64Value": "A String", # The value of the metric as int.
},
},
"peakStorageUtilization": { # MetricData represents the metric data for a database resource. # Peak storage utilization observed for the resource. The value is a fraction between 0.0 and 1.0 (may momentarily exceed 1.0 in some cases).
"observationTime": "A String", # The time the metric was observed in the metric source service.
"value": { # TypedValue represents the value of the metric based on data type. # The value associated with the metric.
"doubleValue": 3.14, # The value of the metric as double.
"int64Value": "A String", # The value of the metric as int.
},
},
"processingUnitCount": { # MetricData represents the metric data for a database resource. # Number of processing units in spanner.
"observationTime": "A String", # The time the metric was observed in the metric source service.
"value": { # TypedValue represents the value of the metric based on data type. # The value associated with the metric.
"doubleValue": 3.14, # The value of the metric as double.
"int64Value": "A String", # The value of the metric as int.
},
},
},
"product": { # Product specification for databasecenter resources. # The product this resource represents.
"engine": "A String", # Optional. The specific engine that the underlying database is running.
"minorVersion": "A String", # Optional. Minor version of the underlying database engine. Example values: For MySQL, it could be "8.0.35", "5.7.25" etc. For PostgreSQL, it could be "14.4", "15.5" etc.
"type": "A String", # Optional. Type of specific database product. It could be CloudSQL, AlloyDB etc..
"version": "A String", # Optional. Version of the underlying database engine. Example values: For MySQL, it could be "8.0", "5.7" etc. For Postgres, it could be "14", "15" etc.
},
"resourceCategory": "A String", # The category of the resource.
"resourceName": "A String", # The name of the resource(The last part of the full resource name). Example: For full resource name - `//cloudsql.googleapis.com/projects/project-number/instances/mysql-1`, resource name - `mysql-1` For full resource name - `//cloudsql.googleapis.com/projects/project-number/instances/postgres-1` , resource name - `postgres-1` Note: In some cases, there might be more than one resource with the same resource name.
"resourceType": "A String", # The type of resource defined according to the pattern: {Service Name}/{Type}. Ex: sqladmin.googleapis.com/Instance alloydb.googleapis.com/Cluster alloydb.googleapis.com/Instance spanner.googleapis.com/Instance
"signalGroups": [ # The list of signal groups and count of issues related to the resource. Only those signals which have been requested would be included.
{ # A group of signals and their counts.
"displayName": "A String", # Title of a signal group corresponding to the request.
"issueCount": 42, # When applied to a DatabaseResource represents count of issues associated with the resource. A signal is an issue when its SignalStatus field is set to SIGNAL_STATUS_ISSUE.
"signals": [ # List of signals present in the group and associated with the resource. Only applies to a DatabaseResource.
{ # Represents a signal.
"additionalDetails": [ # Additional information related to the signal. In the case of composite signals, this field encapsulates details associated with granular signals, having a signal status of "ISSUE"; signals with a status of "OK" are not included. For granular signals, it encompasses information relevant to the signal, regardless of the signal status.
{ # Details related to signal.
"automatedBackupPolicyInfo": { # Automated backup policy signal info # Automated backup policy information applies to signals with type SIGNAL_TYPE_NO_AUTOMATED_BACKUP_POLICY.
"isEnabled": True or False, # Is automated policy enabled.
"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. # Optional. Sub resource details associated with the signal.
"container": "A String", # Specifies where the resource is created. For Google Cloud resources, it is the full name of the project.
"fullResourceName": "A String", # Optional. Resource name associated with the sub resource where backup settings are configured. E.g."//spanner.googleapis.com/projects/project1/instances/inst1/databases/db1" for Spanner where backup retention is configured on database within an instance OPTIONAL
"product": { # Product specification for databasecenter resources. # Optional. Product information associated with the sub resource where backup retention settings are configured. e.g. ``` product: { type : PRODUCT_TYPE_SPANNER engine : ENGINE_CLOUD_SPANNER_WITH_POSTGRES_DIALECT } ``` for Spanner where backup is configured on database within an instance OPTIONAL
"engine": "A String", # Optional. The specific engine that the underlying database is running.
"minorVersion": "A String", # Optional. Minor version of the underlying database engine. Example values: For MySQL, it could be "8.0.35", "5.7.25" etc. For PostgreSQL, it could be "14.4", "15.5" etc.
"type": "A String", # Optional. Type of specific database product. It could be CloudSQL, AlloyDB etc..
"version": "A String", # Optional. Version of the underlying database engine. Example values: For MySQL, it could be "8.0", "5.7" etc. For Postgres, it could be "14", "15" etc.
},
"resourceType": "A String", # Optional. Resource type associated with the sub resource where backup settings are configured. E.g. "spanner.googleapis.com/Database" for Spanner where backup retention is configured on database within an instance OPTIONAL
},
},
"backupRunInfo": { # Metadata about latest backup run state for a database resource. # Backup run information applies to signals with types SIGNAL_TYPE_LAST_BACKUP_FAILED and SIGNAL_TYPE_LAST_BACKUP_OLD.
"endTime": "A String", # The time the backup operation completed.
"errorMessage": "A String", # Additional information about the error encountered.
"operationErrorType": "A String", # Optional. OperationErrorType to expose specific error when backup operation of database resource failed, that is state is FAILED.
"startTime": "A String", # The time the backup operation started.
"state": "A String", # Output only. The state of this run.
"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. # Optional. Sub resource details associated with the backup run.
"container": "A String", # Specifies where the resource is created. For Google Cloud resources, it is the full name of the project.
"fullResourceName": "A String", # Optional. Resource name associated with the sub resource where backup settings are configured. E.g."//spanner.googleapis.com/projects/project1/instances/inst1/databases/db1" for Spanner where backup retention is configured on database within an instance OPTIONAL
"product": { # Product specification for databasecenter resources. # Optional. Product information associated with the sub resource where backup retention settings are configured. e.g. ``` product: { type : PRODUCT_TYPE_SPANNER engine : ENGINE_CLOUD_SPANNER_WITH_POSTGRES_DIALECT } ``` for Spanner where backup is configured on database within an instance OPTIONAL
"engine": "A String", # Optional. The specific engine that the underlying database is running.
"minorVersion": "A String", # Optional. Minor version of the underlying database engine. Example values: For MySQL, it could be "8.0.35", "5.7.25" etc. For PostgreSQL, it could be "14.4", "15.5" etc.
"type": "A String", # Optional. Type of specific database product. It could be CloudSQL, AlloyDB etc..
"version": "A String", # Optional. Version of the underlying database engine. Example values: For MySQL, it could be "8.0", "5.7" etc. For Postgres, it could be "14", "15" etc.
},
"resourceType": "A String", # Optional. Resource type associated with the sub resource where backup settings are configured. E.g. "spanner.googleapis.com/Database" for Spanner where backup retention is configured on database within an instance OPTIONAL
},
},
"deletionProtectionInfo": { # Deletion protection signal info for a database resource. # Deletion protection information applies to signals with type SIGNAL_TYPE_NO_DELETION_PROTECTION
"deletionProtectionEnabled": True or False, # Is deletion protection enabled.
"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. # Optional. Sub resource details associated with the signal.
"container": "A String", # Specifies where the resource is created. For Google Cloud resources, it is the full name of the project.
"fullResourceName": "A String", # Optional. Resource name associated with the sub resource where backup settings are configured. E.g."//spanner.googleapis.com/projects/project1/instances/inst1/databases/db1" for Spanner where backup retention is configured on database within an instance OPTIONAL
"product": { # Product specification for databasecenter resources. # Optional. Product information associated with the sub resource where backup retention settings are configured. e.g. ``` product: { type : PRODUCT_TYPE_SPANNER engine : ENGINE_CLOUD_SPANNER_WITH_POSTGRES_DIALECT } ``` for Spanner where backup is configured on database within an instance OPTIONAL
"engine": "A String", # Optional. The specific engine that the underlying database is running.
"minorVersion": "A String", # Optional. Minor version of the underlying database engine. Example values: For MySQL, it could be "8.0.35", "5.7.25" etc. For PostgreSQL, it could be "14.4", "15.5" etc.
"type": "A String", # Optional. Type of specific database product. It could be CloudSQL, AlloyDB etc..
"version": "A String", # Optional. Version of the underlying database engine. Example values: For MySQL, it could be "8.0", "5.7" etc. For Postgres, it could be "14", "15" etc.
},
"resourceType": "A String", # Optional. Resource type associated with the sub resource where backup settings are configured. E.g. "spanner.googleapis.com/Database" for Spanner where backup retention is configured on database within an instance OPTIONAL
},
},
"inefficientQueryInfo": { # Metadata about inefficient query signal info for a database resource. # Inefficient query information applies to signals with type SIGNAL_TYPE_INEFFICIENT_QUERY.
"database": "A String", # Name of the database where index is required. For example, "db1", which is the name of the database present in the instance.
"impactedQueriesCount": "A String", # Count of queries to be impacted if index is applied
"sqlIndexStatement": "A String", # SQL statement of the index. Based on the ddl type, this will be either CREATE INDEX or DROP INDEX.
"storageCostBytes": "A String", # Cost of additional disk usage in bytes
"table": "A String", # Name of the table where index is required
},
"maintenanceRecommendationInfo": { # Info associated with maintenance recommendation. # Maintenance recommendation information applies to signals with type SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES.
"resourceMaintenanceSchedules": [ # Optional. List of recommended maintenance schedules for the database resource.
{ # 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.
"day": "A String", # Optional. Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.
"phase": "A String", # Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance
"startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Preferred time to start the maintenance operation on the specified day.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
],
},
"outdatedMinorVersionInfo": { # Info associated with outdated minor version. # Outdated minor version information applies to signals with type SIGNAL_TYPE_OUTDATED_MINOR_VERSION.
"recommendedMinorVersion": "A String", # Recommended minor version of the underlying database engine. Example values: For MySQL, it could be "8.0.35", "5.7.25" etc. For PostgreSQL, it could be "14.4", "15.5" etc.
},
"recommendationInfo": { # Info associated with recommendation. # Recommendation information applies to recommendations.
"recommender": "A String", # Name of recommendation. Examples: organizations/1234/locations/us-central1/recommenders/google.cloudsql.instance.PerformanceRecommender/recommendations/9876
"recommenderId": "A String", # ID of recommender. Examples: "google.cloudsql.instance.PerformanceRecommender"
"recommenderSubtype": "A String", # Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = "google.cloudsql.instance.PerformanceRecommender", recommender_subtype can be "MYSQL_HIGH_NUMBER_OF_OPEN_TABLES_BEST_PRACTICE"/"POSTGRES_HIGH_TRANSACTION_ID_UTILIZATION_BEST_PRACTICE"
},
"resourceSuspensionInfo": { # Resource suspension info for a database resource. # Resource suspension information applies to signals with type SIGNAL_TYPE_RESOURCE_SUSPENDED.
"resourceSuspended": True or False, # Is resource suspended.
"suspensionReason": "A String", # Suspension reason for the resource.
},
"sccInfo": { # Info associated with SCC signals. # SCC information applies to SCC signals.
"category": "A String", # Name by which SCC calls this signal.
"externalUri": "A String", # External URI which points to a SCC page associated with the signal.
"regulatoryStandards": [ # Compliances that are associated with the signal.
{ # Compliances associated with signals.
"standard": "A String", # Name of industry compliance standards, such as such as CIS, PCI, and OWASP.
"version": "A String", # Version of the standard or benchmark, for example, 1.1.
},
],
"signal": "A String", # Name of the signal.
},
"shortBackupRetentionInfo": { # Metadata about backup retention settings for a database resource. # Short backup retention information applies to signals with type SIGNAL_TYPE_SHORT_BACKUP_RETENTION.
"durationBasedRetention": "A String", # Duration based retention period i.e. 172800 seconds (2 days)
"quantityBasedRetention": 42, # Number of backups that will be retained.
"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. # Optional. Sub resource details associated with the backup configuration.
"container": "A String", # Specifies where the resource is created. For Google Cloud resources, it is the full name of the project.
"fullResourceName": "A String", # Optional. Resource name associated with the sub resource where backup settings are configured. E.g."//spanner.googleapis.com/projects/project1/instances/inst1/databases/db1" for Spanner where backup retention is configured on database within an instance OPTIONAL
"product": { # Product specification for databasecenter resources. # Optional. Product information associated with the sub resource where backup retention settings are configured. e.g. ``` product: { type : PRODUCT_TYPE_SPANNER engine : ENGINE_CLOUD_SPANNER_WITH_POSTGRES_DIALECT } ``` for Spanner where backup is configured on database within an instance OPTIONAL
"engine": "A String", # Optional. The specific engine that the underlying database is running.
"minorVersion": "A String", # Optional. Minor version of the underlying database engine. Example values: For MySQL, it could be "8.0.35", "5.7.25" etc. For PostgreSQL, it could be "14.4", "15.5" etc.
"type": "A String", # Optional. Type of specific database product. It could be CloudSQL, AlloyDB etc..
"version": "A String", # Optional. Version of the underlying database engine. Example values: For MySQL, it could be "8.0", "5.7" etc. For Postgres, it could be "14", "15" etc.
},
"resourceType": "A String", # Optional. Resource type associated with the sub resource where backup settings are configured. E.g. "spanner.googleapis.com/Database" for Spanner where backup retention is configured on database within an instance OPTIONAL
},
"timestampBasedRetentionTime": "A String", # Timestamp based retention period i.e. till 2024-05-01T00:00:00Z
},
"signalEventTime": "A String", # Event time when signal was recorded by source service.
"signalSource": "A String", # Where the signal is coming from.
"signalType": "A String", # Type of the signal.
},
],
"issueCreateTime": "A String", # Timestamp when the issue was created (when signal status is ISSUE).
"issueSeverity": "A String", # Severity of the issue.
"signalStatus": "A String", # Status of the signal.
"signalType": "A String", # Type of the signal.
},
],
},
],
"subResourceType": "A String", # Subtype of the resource specified at creation time.
"tags": [ # Tags applied on the resource. The requirements for tags assigned to Google Cloud resources may be found at https://cloud.google.com/resource-manager/docs/tags/tags-overview
{ # Tag is a key value pair attached to a resource.
"inherited": True or False, # Indicates the inheritance status of a tag value attached to the given resource. If the tag value is inherited from one of the resource's ancestors, inherited will be true. If false, then the tag value is directly attached to the resource.
"key": "A String",
"source": "A String", # The source of the tag. According to https://cloud.google.com/resource-manager/docs/tags/tags-overview#tags_and_labels, tags can be created only at the project or organization level. Tags can be inherited from different project as well not just the current project where the database resource is present. Format: "projects/{PROJECT_ID}", "projects/{PROJECT_NUMBER}", "organizations/{ORGANIZATION_ID}"
"value": "A String", # The value part of the tag.
},
],
},
"signal": { # Represents a signal. # Signal associated with the issue.
"additionalDetails": [ # Additional information related to the signal. In the case of composite signals, this field encapsulates details associated with granular signals, having a signal status of "ISSUE"; signals with a status of "OK" are not included. For granular signals, it encompasses information relevant to the signal, regardless of the signal status.
{ # Details related to signal.
"automatedBackupPolicyInfo": { # Automated backup policy signal info # Automated backup policy information applies to signals with type SIGNAL_TYPE_NO_AUTOMATED_BACKUP_POLICY.
"isEnabled": True or False, # Is automated policy enabled.
"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. # Optional. Sub resource details associated with the signal.
"container": "A String", # Specifies where the resource is created. For Google Cloud resources, it is the full name of the project.
"fullResourceName": "A String", # Optional. Resource name associated with the sub resource where backup settings are configured. E.g."//spanner.googleapis.com/projects/project1/instances/inst1/databases/db1" for Spanner where backup retention is configured on database within an instance OPTIONAL
"product": { # Product specification for databasecenter resources. # Optional. Product information associated with the sub resource where backup retention settings are configured. e.g. ``` product: { type : PRODUCT_TYPE_SPANNER engine : ENGINE_CLOUD_SPANNER_WITH_POSTGRES_DIALECT } ``` for Spanner where backup is configured on database within an instance OPTIONAL
"engine": "A String", # Optional. The specific engine that the underlying database is running.
"minorVersion": "A String", # Optional. Minor version of the underlying database engine. Example values: For MySQL, it could be "8.0.35", "5.7.25" etc. For PostgreSQL, it could be "14.4", "15.5" etc.
"type": "A String", # Optional. Type of specific database product. It could be CloudSQL, AlloyDB etc..
"version": "A String", # Optional. Version of the underlying database engine. Example values: For MySQL, it could be "8.0", "5.7" etc. For Postgres, it could be "14", "15" etc.
},
"resourceType": "A String", # Optional. Resource type associated with the sub resource where backup settings are configured. E.g. "spanner.googleapis.com/Database" for Spanner where backup retention is configured on database within an instance OPTIONAL
},
},
"backupRunInfo": { # Metadata about latest backup run state for a database resource. # Backup run information applies to signals with types SIGNAL_TYPE_LAST_BACKUP_FAILED and SIGNAL_TYPE_LAST_BACKUP_OLD.
"endTime": "A String", # The time the backup operation completed.
"errorMessage": "A String", # Additional information about the error encountered.
"operationErrorType": "A String", # Optional. OperationErrorType to expose specific error when backup operation of database resource failed, that is state is FAILED.
"startTime": "A String", # The time the backup operation started.
"state": "A String", # Output only. The state of this run.
"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. # Optional. Sub resource details associated with the backup run.
"container": "A String", # Specifies where the resource is created. For Google Cloud resources, it is the full name of the project.
"fullResourceName": "A String", # Optional. Resource name associated with the sub resource where backup settings are configured. E.g."//spanner.googleapis.com/projects/project1/instances/inst1/databases/db1" for Spanner where backup retention is configured on database within an instance OPTIONAL
"product": { # Product specification for databasecenter resources. # Optional. Product information associated with the sub resource where backup retention settings are configured. e.g. ``` product: { type : PRODUCT_TYPE_SPANNER engine : ENGINE_CLOUD_SPANNER_WITH_POSTGRES_DIALECT } ``` for Spanner where backup is configured on database within an instance OPTIONAL
"engine": "A String", # Optional. The specific engine that the underlying database is running.
"minorVersion": "A String", # Optional. Minor version of the underlying database engine. Example values: For MySQL, it could be "8.0.35", "5.7.25" etc. For PostgreSQL, it could be "14.4", "15.5" etc.
"type": "A String", # Optional. Type of specific database product. It could be CloudSQL, AlloyDB etc..
"version": "A String", # Optional. Version of the underlying database engine. Example values: For MySQL, it could be "8.0", "5.7" etc. For Postgres, it could be "14", "15" etc.
},
"resourceType": "A String", # Optional. Resource type associated with the sub resource where backup settings are configured. E.g. "spanner.googleapis.com/Database" for Spanner where backup retention is configured on database within an instance OPTIONAL
},
},
"deletionProtectionInfo": { # Deletion protection signal info for a database resource. # Deletion protection information applies to signals with type SIGNAL_TYPE_NO_DELETION_PROTECTION
"deletionProtectionEnabled": True or False, # Is deletion protection enabled.
"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. # Optional. Sub resource details associated with the signal.
"container": "A String", # Specifies where the resource is created. For Google Cloud resources, it is the full name of the project.
"fullResourceName": "A String", # Optional. Resource name associated with the sub resource where backup settings are configured. E.g."//spanner.googleapis.com/projects/project1/instances/inst1/databases/db1" for Spanner where backup retention is configured on database within an instance OPTIONAL
"product": { # Product specification for databasecenter resources. # Optional. Product information associated with the sub resource where backup retention settings are configured. e.g. ``` product: { type : PRODUCT_TYPE_SPANNER engine : ENGINE_CLOUD_SPANNER_WITH_POSTGRES_DIALECT } ``` for Spanner where backup is configured on database within an instance OPTIONAL
"engine": "A String", # Optional. The specific engine that the underlying database is running.
"minorVersion": "A String", # Optional. Minor version of the underlying database engine. Example values: For MySQL, it could be "8.0.35", "5.7.25" etc. For PostgreSQL, it could be "14.4", "15.5" etc.
"type": "A String", # Optional. Type of specific database product. It could be CloudSQL, AlloyDB etc..
"version": "A String", # Optional. Version of the underlying database engine. Example values: For MySQL, it could be "8.0", "5.7" etc. For Postgres, it could be "14", "15" etc.
},
"resourceType": "A String", # Optional. Resource type associated with the sub resource where backup settings are configured. E.g. "spanner.googleapis.com/Database" for Spanner where backup retention is configured on database within an instance OPTIONAL
},
},
"inefficientQueryInfo": { # Metadata about inefficient query signal info for a database resource. # Inefficient query information applies to signals with type SIGNAL_TYPE_INEFFICIENT_QUERY.
"database": "A String", # Name of the database where index is required. For example, "db1", which is the name of the database present in the instance.
"impactedQueriesCount": "A String", # Count of queries to be impacted if index is applied
"sqlIndexStatement": "A String", # SQL statement of the index. Based on the ddl type, this will be either CREATE INDEX or DROP INDEX.
"storageCostBytes": "A String", # Cost of additional disk usage in bytes
"table": "A String", # Name of the table where index is required
},
"maintenanceRecommendationInfo": { # Info associated with maintenance recommendation. # Maintenance recommendation information applies to signals with type SIGNAL_TYPE_RECOMMENDED_MAINTENANCE_POLICIES.
"resourceMaintenanceSchedules": [ # Optional. List of recommended maintenance schedules for the database resource.
{ # 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.
"day": "A String", # Optional. Preferred day of the week for maintenance, e.g. MONDAY, TUESDAY, etc.
"phase": "A String", # Optional. Phase of the maintenance window. This is to capture order of maintenance. For example, for Cloud SQL resources, this can be used to capture if the maintenance window is in Week1, Week2, Week5, etc. Non production resources are usually part of early phase. For more details, refer to Cloud SQL resources - https://cloud.google.com/sql/docs/mysql/maintenance
"startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Preferred time to start the maintenance operation on the specified day.
"hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
"minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59.
"nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999.
"seconds": 42, # Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds.
},
},
],
},
"outdatedMinorVersionInfo": { # Info associated with outdated minor version. # Outdated minor version information applies to signals with type SIGNAL_TYPE_OUTDATED_MINOR_VERSION.
"recommendedMinorVersion": "A String", # Recommended minor version of the underlying database engine. Example values: For MySQL, it could be "8.0.35", "5.7.25" etc. For PostgreSQL, it could be "14.4", "15.5" etc.
},
"recommendationInfo": { # Info associated with recommendation. # Recommendation information applies to recommendations.
"recommender": "A String", # Name of recommendation. Examples: organizations/1234/locations/us-central1/recommenders/google.cloudsql.instance.PerformanceRecommender/recommendations/9876
"recommenderId": "A String", # ID of recommender. Examples: "google.cloudsql.instance.PerformanceRecommender"
"recommenderSubtype": "A String", # Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = "google.cloudsql.instance.PerformanceRecommender", recommender_subtype can be "MYSQL_HIGH_NUMBER_OF_OPEN_TABLES_BEST_PRACTICE"/"POSTGRES_HIGH_TRANSACTION_ID_UTILIZATION_BEST_PRACTICE"
},
"resourceSuspensionInfo": { # Resource suspension info for a database resource. # Resource suspension information applies to signals with type SIGNAL_TYPE_RESOURCE_SUSPENDED.
"resourceSuspended": True or False, # Is resource suspended.
"suspensionReason": "A String", # Suspension reason for the resource.
},
"sccInfo": { # Info associated with SCC signals. # SCC information applies to SCC signals.
"category": "A String", # Name by which SCC calls this signal.
"externalUri": "A String", # External URI which points to a SCC page associated with the signal.
"regulatoryStandards": [ # Compliances that are associated with the signal.
{ # Compliances associated with signals.
"standard": "A String", # Name of industry compliance standards, such as such as CIS, PCI, and OWASP.
"version": "A String", # Version of the standard or benchmark, for example, 1.1.
},
],
"signal": "A String", # Name of the signal.
},
"shortBackupRetentionInfo": { # Metadata about backup retention settings for a database resource. # Short backup retention information applies to signals with type SIGNAL_TYPE_SHORT_BACKUP_RETENTION.
"durationBasedRetention": "A String", # Duration based retention period i.e. 172800 seconds (2 days)
"quantityBasedRetention": 42, # Number of backups that will be retained.
"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. # Optional. Sub resource details associated with the backup configuration.
"container": "A String", # Specifies where the resource is created. For Google Cloud resources, it is the full name of the project.
"fullResourceName": "A String", # Optional. Resource name associated with the sub resource where backup settings are configured. E.g."//spanner.googleapis.com/projects/project1/instances/inst1/databases/db1" for Spanner where backup retention is configured on database within an instance OPTIONAL
"product": { # Product specification for databasecenter resources. # Optional. Product information associated with the sub resource where backup retention settings are configured. e.g. ``` product: { type : PRODUCT_TYPE_SPANNER engine : ENGINE_CLOUD_SPANNER_WITH_POSTGRES_DIALECT } ``` for Spanner where backup is configured on database within an instance OPTIONAL
"engine": "A String", # Optional. The specific engine that the underlying database is running.
"minorVersion": "A String", # Optional. Minor version of the underlying database engine. Example values: For MySQL, it could be "8.0.35", "5.7.25" etc. For PostgreSQL, it could be "14.4", "15.5" etc.
"type": "A String", # Optional. Type of specific database product. It could be CloudSQL, AlloyDB etc..
"version": "A String", # Optional. Version of the underlying database engine. Example values: For MySQL, it could be "8.0", "5.7" etc. For Postgres, it could be "14", "15" etc.
},
"resourceType": "A String", # Optional. Resource type associated with the sub resource where backup settings are configured. E.g. "spanner.googleapis.com/Database" for Spanner where backup retention is configured on database within an instance OPTIONAL
},
"timestampBasedRetentionTime": "A String", # Timestamp based retention period i.e. till 2024-05-01T00:00:00Z
},
"signalEventTime": "A String", # Event time when signal was recorded by source service.
"signalSource": "A String", # Where the signal is coming from.
"signalType": "A String", # Type of the signal.
},
],
"issueCreateTime": "A String", # Timestamp when the issue was created (when signal status is ISSUE).
"issueSeverity": "A String", # Severity of the issue.
"signalStatus": "A String", # Status of the signal.
"signalType": "A String", # Type of the signal.
},
},
],
"unreachable": [ # Unordered list. List of unreachable regions from where data could not be retrieved.
"A String",
],
}
queryIssues_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
queryProducts(pageSize=None, pageToken=None, parent=None, x__xgafv=None)
QueryProducts provides a list of all possible products which can be used to filter database resources.
Args:
pageSize: integer, Optional. If unspecified, at most 50 products will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, Optional. A page token, received from a previous `ListLocations` call. Provide this to retrieve the subsequent page. All other parameters except page size should match the call that provided the page page token.
parent: string, Required. Parent can be a project, a folder, or an organization. The allowed values are: * projects/{PROJECT_ID}/locations/{LOCATION} (e.g.,"projects/foo-bar/locations/us-central1") * projects/{PROJECT_NUMBER}/locations/{LOCATION} (e.g.,"projects/12345678/locations/us-central1") * folders/{FOLDER_NUMBER}/locations/{LOCATION} (e.g.,"folders/1234567/locations/us-central1") * organizations/{ORGANIZATION_NUMBER}/locations/{LOCATION} (e.g.,"organizations/123456/locations/us-central1") * projects/{PROJECT_ID} (e.g., "projects/foo-bar") * projects/{PROJECT_NUMBER} (e.g., "projects/12345678") * folders/{FOLDER_NUMBER} (e.g., "folders/1234567") * organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456")
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # QueryProductsResponse represents the response containing a list of products.
"nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages
"products": [ # List of database products returned.
{ # Product specification for databasecenter resources.
"engine": "A String", # Optional. The specific engine that the underlying database is running.
"minorVersion": "A String", # Optional. Minor version of the underlying database engine. Example values: For MySQL, it could be "8.0.35", "5.7.25" etc. For PostgreSQL, it could be "14.4", "15.5" etc.
"type": "A String", # Optional. Type of specific database product. It could be CloudSQL, AlloyDB etc..
"version": "A String", # Optional. Version of the underlying database engine. Example values: For MySQL, it could be "8.0", "5.7" etc. For Postgres, it could be "14", "15" etc.
},
],
"unreachable": [ # Unordered list. List of unreachable regions from where data could not be retrieved.
"A String",
],
}
queryProducts_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.