google-api-python-client 2.141.0__py2.py3-none-any.whl → 2.143.0__py2.py3-none-any.whl

googleapiclient/discovery_cache/documents/alloydb.v1alpha.json

@@ -735,6 +735,34 @@
 "scopes": [
 "https://www.googleapis.com/auth/cloud-platform"
 ]
+},
+"upgrade": {
+"description": "Upgrades a single Cluster. Imperative only.",
+"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:upgrade",
+"httpMethod": "PATCH",
+"id": "alloydb.projects.locations.clusters.upgrade",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The resource name of the cluster.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1alpha/{+name}:upgrade",
+"request": {
+"$ref": "UpgradeClusterRequest"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
 }
 },
 "resources": {
@@ -1489,7 +1517,7 @@
 }
 }
 },
-"revision": "20240703",
+"revision": "20240806",
 "rootUrl": "https://alloydb.googleapis.com/",
 "schemas": {
 "AuthorizedNetwork": {
@@ -1786,6 +1814,26 @@ false
 },
 "type": "object"
 },
+"CloudSQLBackupRunSource": {
+"description": "The source CloudSQL backup resource.",
+"id": "CloudSQLBackupRunSource",
+"properties": {
+"backupRunId": {
+"description": "Required. The CloudSQL backup run ID.",
+"format": "int64",
+"type": "string"
+},
+"instanceId": {
+"description": "Required. The CloudSQL instance ID.",
+"type": "string"
+},
+"project": {
+"description": "The project ID of the source CloudSQL instance. This should be the same as the AlloyDB cluster's project.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "Cluster": {
 "description": "A cluster is a collection of regional AlloyDB resources. It can include a primary instance and one or more read pool instances. All cluster resources share a storage layer, which scales as needed.",
 "id": "Cluster",
@@ -1806,6 +1854,11 @@ false
 "description": "Output only. Cluster created from backup.",
 "readOnly": true
 },
+"cloudsqlBackupRunSource": {
+"$ref": "CloudSQLBackupRunSource",
+"description": "Output only. Cluster created from CloudSQL snapshot.",
+"readOnly": true
+},
 "clusterType": {
 "description": "Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster`",
 "enum": [
@@ -2021,6 +2074,86 @@ false
 },
 "type": "object"
 },
+"ClusterUpgradeDetails": {
+"description": "Upgrade details of a cluster. This cluster can be primary or secondary.",
+"id": "ClusterUpgradeDetails",
+"properties": {
+"clusterType": {
+"description": "Cluster type which can either be primary or secondary.",
+"enum": [
+"CLUSTER_TYPE_UNSPECIFIED",
+"PRIMARY",
+"SECONDARY"
+],
+"enumDescriptions": [
+"The type of the cluster is unknown.",
+"Primary cluster that support read and write operations.",
+"Secondary cluster that is replicating from another region. This only supports read."
+],
+"type": "string"
+},
+"databaseVersion": {
+"description": "Database version of the cluster after the upgrade operation. This will be the target version if the upgrade was successful otherwise it remains the same as that before the upgrade operation.",
+"enum": [
+"DATABASE_VERSION_UNSPECIFIED",
+"POSTGRES_13",
+"POSTGRES_14",
+"POSTGRES_15",
+"POSTGRES_16"
+],
+"enumDeprecated": [
+false,
+true,
+false,
+false,
+false
+],
+"enumDescriptions": [
+"This is an unknown database version.",
+"DEPRECATED - The database version is Postgres 13.",
+"The database version is Postgres 14.",
+"The database version is Postgres 15.",
+"The database version is Postgres 16."
+],
+"type": "string"
+},
+"instanceUpgradeDetails": {
+"description": "Upgrade details of the instances directly associated with this cluster.",
+"items": {
+"$ref": "InstanceUpgradeDetails"
+},
+"type": "array"
+},
+"name": {
+"description": "Normalized name of the cluster",
+"type": "string"
+},
+"stageInfo": {
+"description": "Array containing stage info associated with this cluster.",
+"items": {
+"$ref": "StageInfo"
+},
+"type": "array"
+},
+"upgradeStatus": {
+"description": "Upgrade status of the cluster.",
+"enum": [
+"STATUS_UNSPECIFIED",
+"SUCCESS",
+"FAILED",
+"PARTIAL_SUCCESS"
+],
+"enumDescriptions": [
+"Unspecified status.",
+"Operation succeeded.",
+"Operation failed.",
+"Operation partially succeeded."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "ConnectionInfo": {
 "description": "ConnectionInfo singleton resource. https://google.aip.dev/156",
 "id": "ConnectionInfo",
@@ -2570,6 +2703,49 @@ false
 },
 "type": "object"
 },
+"InstanceUpgradeDetails": {
+"description": "Details regarding the upgrade of instaces associated with a cluster.",
+"id": "InstanceUpgradeDetails",
+"properties": {
+"instanceType": {
+"description": "Instance type.",
+"enum": [
+"INSTANCE_TYPE_UNSPECIFIED",
+"PRIMARY",
+"READ_POOL",
+"SECONDARY"
+],
+"enumDescriptions": [
+"The type of the instance is unknown.",
+"PRIMARY instances support read and write operations.",
+"READ POOL instances support read operations only. Each read pool instance consists of one or more homogeneous nodes. * Read pool of size 1 can only have zonal availability. * Read pools with node count of 2 or more can have regional availability (nodes are present in 2 or more zones in a region).",
+"SECONDARY instances support read operations only. SECONDARY instance is a cross-region read replica"
+],
+"type": "string"
+},
+"name": {
+"description": "Normalized name of the instance.",
+"type": "string"
+},
+"upgradeStatus": {
+"description": "Upgrade status of the instance.",
+"enum": [
+"STATUS_UNSPECIFIED",
+"SUCCESS",
+"FAILED",
+"PARTIAL_SUCCESS"
+],
+"enumDescriptions": [
+"Unspecified status.",
+"Operation succeeded.",
+"Operation failed.",
+"Operation partially succeeded."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "IntegerRestrictions": {
 "description": "Restrictions on INTEGER type values.",
 "id": "IntegerRestrictions",
@@ -2895,6 +3071,10 @@ false
 "description": "Track actively running queries on the instance. If not set, this flag is \"off\" by default.",
 "type": "boolean"
 },
+"trackClientAddress": {
+"description": "Track client address for an instance. If not set, default value is \"off\".",
+"type": "boolean"
+},
 "trackWaitEventTypes": {
 "description": "Output only. Track wait event types during query execution for an instance. This flag is turned \"on\" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by producer API.",
 "readOnly": true,
@@ -3126,6 +3306,13 @@ false
 "RestartInstanceRequest": {
 "id": "RestartInstanceRequest",
 "properties": {
+"nodeIds": {
+"description": "Optional. Full name of the nodes as obtained from INSTANCE_VIEW_FULL to restart upon. Only applicable for read instances.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
 "requestId": {
 "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
 "type": "string"
@@ -3226,6 +3413,51 @@ false
 },
 "type": "object"
 },
+"StageInfo": {
+"description": "Stage information for different stages in the upgrade process.",
+"id": "StageInfo",
+"properties": {
+"logsUrl": {
+"description": "logs_url is the URL for the logs associated with a stage if that stage has logs. Right now, only three stages have logs: ALLOYDB_PRECHECK, PG_UPGRADE_CHECK, PRIMARY_INSTANCE_UPGRADE.",
+"type": "string"
+},
+"stage": {
+"description": "The stage.",
+"enum": [
+"STAGE_UNSPECIFIED",
+"ALLOYDB_PRECHECK",
+"PG_UPGRADE_CHECK",
+"PRIMARY_INSTANCE_UPGRADE",
+"READ_POOL_UPGRADE"
+],
+"enumDescriptions": [
+"Unspecified stage.",
+"This stage is for the custom checks done before upgrade.",
+"This stage is for `pg_upgrade --check` run before upgrade.",
+"This stage is primary upgrade.",
+"This stage is read pool upgrade."
+],
+"type": "string"
+},
+"status": {
+"description": "Status of the stage.",
+"enum": [
+"STATUS_UNSPECIFIED",
+"SUCCESS",
+"FAILED",
+"PARTIAL_SUCCESS"
+],
+"enumDescriptions": [
+"Unspecified status.",
+"Operation succeeded.",
+"Operation failed.",
+"Operation partially succeeded."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "Status": {
 "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
 "id": "Status",
@@ -3358,43 +3590,19 @@ false
 "type": "object"
 },
 "StorageDatabasecenterPartnerapiV1mainCustomMetadataData": {
-"description": "Any custom metadata associated with the resource. i.e. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data",
+"description": "Any custom metadata associated with the resource. e.g. A spanner instance can have multiple databases with its own unique metadata. Information for these individual databases can be captured in custom metadata data",
 "id": "StorageDatabasecenterPartnerapiV1mainCustomMetadataData",
 "properties": {
-"databaseMetadata": {
+"internalResourceMetadata": {
+"description": "Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration.",
 "items": {
-"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseMetadata"
+"$ref": "StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata"
 },
 "type": "array"
 }
 },
 "type": "object"
 },
-"StorageDatabasecenterPartnerapiV1mainDatabaseMetadata": {
-"description": "Metadata for individual databases created in an instance. i.e. spanner instance can have multiple databases with unique configuration settings.",
-"id": "StorageDatabasecenterPartnerapiV1mainDatabaseMetadata",
-"properties": {
-"backupConfiguration": {
-"$ref": "StorageDatabasecenterPartnerapiV1mainBackupConfiguration",
-"description": "Backup configuration for this database"
-},
-"backupRun": {
-"$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun",
-"description": "Information about the last backup attempt for this database"
-},
-"product": {
-"$ref": "StorageDatabasecenterProtoCommonProduct"
-},
-"resourceId": {
-"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId"
-},
-"resourceName": {
-"description": "Required. Database name. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel",
-"type": "string"
-}
-},
-"type": "object"
-},
 "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed": {
 "description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform.",
 "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed",
@@ -3423,8 +3631,7 @@ false
 "type": "string"
 },
 "observabilityMetricData": {
-"$ref": "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData",
-"description": "More feed data would be added in subsequent CLs"
+"$ref": "StorageDatabasecenterPartnerapiV1mainObservabilityMetricData"
 },
 "recommendationSignalData": {
 "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceRecommendationSignalData"
@@ -3533,6 +3740,24 @@ false
 "description": "Required. Unique identifier for the signal. This is an unique id which would be mainatined by partner to identify a signal.",
 "type": "string"
 },
+"signalSeverity": {
+"description": "The severity of the signal, such as if it's a HIGH or LOW severity.",
+"enum": [
+"SIGNAL_SEVERITY_UNSPECIFIED",
+"CRITICAL",
+"HIGH",
+"MEDIUM",
+"LOW"
+],
+"enumDescriptions": [
+"This value is used for findings when a source doesn't write a severity value.",
+"A critical vulnerability is easily discoverable by an external actor, exploitable.",
+"A high risk vulnerability can be easily discovered and exploited in combination with other vulnerabilities.",
+"A medium risk vulnerability could be used by an actor to gain access to resources or privileges that enable them to eventually gain access and the ability to execute arbitrary code or exfiltrate data.",
+"A low risk vulnerability hampers a security organization's ability to detect vulnerabilities or active threats in their deployment."
+],
+"type": "string"
+},
 "signalType": {
 "description": "Required. Type of signal, for example, `AVAILABLE_IN_MULTIPLE_ZONES`, `LOGGING_MOST_ERRORS`, etc.",
 "enum": [
@@ -3829,7 +4054,7 @@ false
 "type": "string"
 },
 "resourceType": {
-"description": "Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel",
+"description": "Required. The type of resource this ID is identifying. Ex redis.googleapis.com/Instance, redis.googleapis.com/Cluster, alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance, spanner.googleapis.com/Database, firestore.googleapis.com/Database, sqladmin.googleapis.com/Instance, bigtableadmin.googleapis.com/Cluster, bigtableadmin.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel",
 "type": "string"
 },
 "uniqueId": {
@@ -4327,6 +4552,31 @@ false
 },
 "type": "object"
 },
+"StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata": {
+"description": "Metadata for individual internal resources in an instance. e.g. spanner instance can have multiple databases with unique configuration settings. Similarly bigtable can have multiple clusters within same bigtable instance.",
+"id": "StorageDatabasecenterPartnerapiV1mainInternalResourceMetadata",
+"properties": {
+"backupConfiguration": {
+"$ref": "StorageDatabasecenterPartnerapiV1mainBackupConfiguration",
+"description": "Backup configuration for this database"
+},
+"backupRun": {
+"$ref": "StorageDatabasecenterPartnerapiV1mainBackupRun",
+"description": "Information about the last backup attempt for this database"
+},
+"product": {
+"$ref": "StorageDatabasecenterProtoCommonProduct"
+},
+"resourceId": {
+"$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId"
+},
+"resourceName": {
+"description": "Required. internal resource name for spanner this will be database name e.g.\"spanner.googleapis.com/projects/123/abc/instances/inst1/databases/db1\"",
+"type": "string"
+}
+},
+"type": "object"
+},
 "StorageDatabasecenterPartnerapiV1mainMachineConfiguration": {
 "description": "MachineConfiguration describes the configuration of a machine specific to Database Resource.",
 "id": "StorageDatabasecenterPartnerapiV1mainMachineConfiguration",
@@ -4500,7 +4750,9 @@ false
 "ENGINE_CLOUD_SPANNER_WITH_GOOGLESQL_DIALECT",
 "ENGINE_MEMORYSTORE_FOR_REDIS",
 "ENGINE_MEMORYSTORE_FOR_REDIS_CLUSTER",
-"ENGINE_OTHER"
+"ENGINE_OTHER",
+"ENGINE_FIRESTORE_WITH_NATIVE_MODE",
+"ENGINE_FIRESTORE_WITH_DATASTORE_MODE"
 ],
 "enumDeprecated": [
 false,
@@ -4516,6 +4768,8 @@ false,
 false,
 false,
 false,
+false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -4532,7 +4786,9 @@ false
 "Cloud Spanner with Google SQL dialect.",
 "Memorystore with Redis dialect.",
 "Memorystore with Redis cluster dialect.",
-"Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum."
+"Other refers to rest of other database engine. This is to be when engine is known, but it is not present in this enum.",
+"Firestore with native mode.",
+"Firestore with datastore mode."
 ],
 "type": "string"
 },
@@ -4549,7 +4805,8 @@ false
 "ON_PREM",
 "PRODUCT_TYPE_MEMORYSTORE",
 "PRODUCT_TYPE_BIGTABLE",
-"PRODUCT_TYPE_OTHER"
+"PRODUCT_TYPE_OTHER",
+"PRODUCT_TYPE_FIRESTORE"
 ],
 "enumDeprecated": [
 false,
@@ -4562,6 +4819,7 @@ false,
 true,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -4575,7 +4833,8 @@ false
 "On premises database product.",
 "Memorystore product area in GCP",
 "Bigtable product area in GCP",
-"Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum."
+"Other refers to rest of other product type. This is to be when product type is known, but it is not present in this enum.",
+"Firestore product area in GCP."
 ],
 "type": "string"
 },
@@ -4737,6 +4996,11 @@ false
 "format": "google-datetime",
 "type": "string"
 },
+"graceEndTime": {
+"description": "grace end time of the cluster.",
+"format": "google-datetime",
+"type": "string"
+},
 "startTime": {
 "description": "start time of the trial cluster.",
 "format": "google-datetime",
@@ -4771,6 +5035,84 @@ false
 },
 "type": "object"
 },
+"UpgradeClusterRequest": {
+"description": "Upgrades a cluster.",
+"id": "UpgradeClusterRequest",
+"properties": {
+"etag": {
+"description": "Optional. The current etag of the Cluster. If an etag is provided and does not match the current etag of the Cluster, upgrade will be blocked and an ABORTED error will be returned.",
+"type": "string"
+},
+"requestId": {
+"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
+"type": "string"
+},
+"validateOnly": {
+"description": "Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but does not actually execute the upgrade.",
+"type": "boolean"
+},
+"version": {
+"description": "Required. The version the cluster is going to be upgraded to.",
+"enum": [
+"DATABASE_VERSION_UNSPECIFIED",
+"POSTGRES_13",
+"POSTGRES_14",
+"POSTGRES_15",
+"POSTGRES_16"
+],
+"enumDeprecated": [
+false,
+true,
+false,
+false,
+false
+],
+"enumDescriptions": [
+"This is an unknown database version.",
+"DEPRECATED - The database version is Postgres 13.",
+"The database version is Postgres 14.",
+"The database version is Postgres 15.",
+"The database version is Postgres 16."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
+"UpgradeClusterResponse": {
+"description": "UpgradeClusterResponse contains the response for upgrade cluster operation.",
+"id": "UpgradeClusterResponse",
+"properties": {
+"clusterUpgradeDetails": {
+"description": "Array of upgrade details for the current cluster and all the secondary clusters associated with this cluster.",
+"items": {
+"$ref": "ClusterUpgradeDetails"
+},
+"type": "array"
+},
+"message": {
+"description": "A user friendly message summarising the upgrade operation details and the next steps for the user if there is any.",
+"type": "string"
+},
+"status": {
+"description": "Status of upgrade operation.",
+"enum": [
+"STATUS_UNSPECIFIED",
+"SUCCESS",
+"FAILED",
+"PARTIAL_SUCCESS"
+],
+"enumDescriptions": [
+"Unspecified status.",
+"Operation succeeded.",
+"Operation failed.",
+"Operation partially succeeded."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "User": {
 "description": "Message describing User object.",
 "id": "User",