google-api-python-client 2.183.0__py3-none-any.whl → 2.185.0__py3-none-any.whl

googleapiclient/discovery_cache/documents/sqladmin.v1.json

@@ -17,7 +17,7 @@
 "canonicalName": "SQL Admin",
 "description": "API for Cloud SQL database instance management",
 "discoveryVersion": "v1",
-"documentationLink": "https://developers.google.com/cloud-sql/",
+"documentationLink": "https://cloud.google.com/sql/docs",
 "fullyEncodeReservedExpansion": true,
 "icons": {
 "x16": "http://www.google.com/images/icons/product/search-16.gif",
@@ -1225,13 +1225,13 @@
 ],
 "parameters": {
 "instance": {
-"description": "Database instance ID. This does not include the project ID.",
+"description": "Required. Database instance ID. This does not include the project ID.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "project": {
-"description": "Project ID of the project that contains the instance.",
+"description": "Required. Project ID of the project that contains the instance.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -1445,6 +1445,41 @@
 "https://www.googleapis.com/auth/sqlservice.admin"
 ]
 },
+"preCheckMajorVersionUpgrade": {
+"description": "Execute MVU Pre-checks",
+"flatPath": "v1/projects/{project}/instances/{instance}/preCheckMajorVersionUpgrade",
+"httpMethod": "POST",
+"id": "sql.instances.preCheckMajorVersionUpgrade",
+"parameterOrder": [
+"project",
+"instance"
+],
+"parameters": {
+"instance": {
+"description": "Required. Cloud SQL instance ID. This does not include the project ID.",
+"location": "path",
+"required": true,
+"type": "string"
+},
+"project": {
+"description": "Required. Project ID of the project that contains the instance.",
+"location": "path",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/projects/{project}/instances/{instance}/preCheckMajorVersionUpgrade",
+"request": {
+"$ref": "InstancesPreCheckMajorVersionUpgradeRequest"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform",
+"https://www.googleapis.com/auth/sqlservice.admin"
+]
+},
 "promoteReplica": {
 "description": "Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart.",
 "flatPath": "v1/projects/{project}/instances/{instance}/promoteReplica",
@@ -1917,13 +1952,13 @@
 ],
 "parameters": {
 "operation": {
-"description": "Instance operation ID.",
+"description": "Required. Instance operation ID.",
 "location": "path",
 "required": true,
 "type": "string"
 },
 "project": {
-"description": "Project ID of the project that contains the instance.",
+"description": "Required. Project ID of the project that contains the instance.",
 "location": "path",
 "required": true,
 "type": "string"
@@ -2650,7 +2685,7 @@
 }
 }
 },
-"revision": "20250908",
+"revision": "20251006",
 "rootUrl": "https://sqladmin.googleapis.com/",
 "schemas": {
 "AclEntry": {
@@ -2838,6 +2873,7 @@
 "POSTGRES_15",
 "POSTGRES_16",
 "POSTGRES_17",
+"POSTGRES_18",
 "SQLSERVER_2019_STANDARD",
 "SQLSERVER_2019_ENTERPRISE",
 "SQLSERVER_2019_EXPRESS",
@@ -2896,6 +2932,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -2940,6 +2977,7 @@ false
 "The database version is PostgreSQL 15.",
 "The database version is PostgreSQL 16.",
 "The database version is PostgreSQL 17.",
+"The database version is PostgreSQL 18.",
 "The database version is SQL Server 2019 Standard.",
 "The database version is SQL Server 2019 Enterprise.",
 "The database version is SQL Server 2019 Express.",
@@ -3297,6 +3335,7 @@ false
 "POSTGRES_15",
 "POSTGRES_16",
 "POSTGRES_17",
+"POSTGRES_18",
 "SQLSERVER_2019_STANDARD",
 "SQLSERVER_2019_ENTERPRISE",
 "SQLSERVER_2019_EXPRESS",
@@ -3355,6 +3394,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -3399,6 +3439,7 @@ false
 "The database version is PostgreSQL 15.",
 "The database version is PostgreSQL 16.",
 "The database version is PostgreSQL 17.",
+"The database version is PostgreSQL 18.",
 "The database version is SQL Server 2019 Standard.",
 "The database version is SQL Server 2019 Enterprise.",
 "The database version is SQL Server 2019 Express.",
@@ -3743,6 +3784,7 @@ false
 "POSTGRES_15",
 "POSTGRES_16",
 "POSTGRES_17",
+"POSTGRES_18",
 "SQLSERVER_2019_STANDARD",
 "SQLSERVER_2019_ENTERPRISE",
 "SQLSERVER_2019_EXPRESS",
@@ -3801,6 +3843,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -3845,6 +3888,7 @@ false
 "The database version is PostgreSQL 15.",
 "The database version is PostgreSQL 16.",
 "The database version is PostgreSQL 17.",
+"The database version is PostgreSQL 18.",
 "The database version is SQL Server 2019 Standard.",
 "The database version is SQL Server 2019 Enterprise.",
 "The database version is SQL Server 2019 Express.",
@@ -4145,6 +4189,7 @@ false
 "POSTGRES_15",
 "POSTGRES_16",
 "POSTGRES_17",
+"POSTGRES_18",
 "SQLSERVER_2019_STANDARD",
 "SQLSERVER_2019_ENTERPRISE",
 "SQLSERVER_2019_EXPRESS",
@@ -4203,6 +4248,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -4247,6 +4293,7 @@ false
 "The database version is PostgreSQL 15.",
 "The database version is PostgreSQL 16.",
 "The database version is PostgreSQL 17.",
+"The database version is PostgreSQL 18.",
 "The database version is SQL Server 2019 Standard.",
 "The database version is SQL Server 2019 Enterprise.",
 "The database version is SQL Server 2019 Express.",
@@ -4766,7 +4813,7 @@ false
 "type": "string"
 },
 "partialResultMode": {
-"description": "Optional. Controls how the API should respond when the SQL execution result exceeds 10 MB. The default mode is to throw an error.",
+"description": "Optional. Controls how the API should respond when the SQL execution result is incomplete due to the size limit or another error. The default mode is to throw an error.",
 "enum": [
 "PARTIAL_RESULT_MODE_UNSPECIFIED",
 "FAIL_PARTIAL_RESULT",
@@ -4774,8 +4821,8 @@ false
 ],
 "enumDescriptions": [
 "Unspecified mode, effectively the same as `FAIL_PARTIAL_RESULT`.",
-"Throw an error if the result exceeds 10 MB. Don't return the result.",
-"Return a truncated result and set `partial_result` to true if the result exceeds 10 MB. Don't throw an error."
+"Throw an error if the result exceeds 10 MB or if only a partial result can be retrieved. Don't return the result.",
+"Return a truncated result and set `partial_result` to true if the result exceeds 10 MB or if only a partial result can be retrieved due to error. Don't throw an error."
 ],
 "type": "string"
 },
@@ -5095,6 +5142,7 @@ false
 "POSTGRES_15",
 "POSTGRES_16",
 "POSTGRES_17",
+"POSTGRES_18",
 "SQLSERVER_2019_STANDARD",
 "SQLSERVER_2019_ENTERPRISE",
 "SQLSERVER_2019_EXPRESS",
@@ -5153,6 +5201,7 @@ false,
 false,
 false,
 false,
+false,
 false
 ],
 "enumDescriptions": [
@@ -5197,6 +5246,7 @@ false
 "The database version is PostgreSQL 15.",
 "The database version is PostgreSQL 16.",
 "The database version is PostgreSQL 17.",
+"The database version is PostgreSQL 18.",
 "The database version is SQL Server 2019 Standard.",
 "The database version is SQL Server 2019 Enterprise.",
 "The database version is SQL Server 2019 Express.",
@@ -5770,6 +5820,17 @@ false
 },
 "type": "object"
 },
+"InstancesPreCheckMajorVersionUpgradeRequest": {
+"description": "Request for Pre-checks for MVU",
+"id": "InstancesPreCheckMajorVersionUpgradeRequest",
+"properties": {
+"preCheckMajorVersionUpgradeContext": {
+"$ref": "PreCheckMajorVersionUpgradeContext",
+"description": "Required. Contains details about the pre-check major version upgrade operation."
+}
+},
+"type": "object"
+},
 "InstancesReencryptRequest": {
 "description": "Database Instance reencrypt request.",
 "id": "InstancesReencryptRequest",
@@ -6434,6 +6495,10 @@ false
 ],
 "type": "string"
 },
+"preCheckMajorVersionUpgradeContext": {
+"$ref": "PreCheckMajorVersionUpgradeContext",
+"description": "This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found)."
+},
 "selfLink": {
 "description": "The URI of this resource.",
 "type": "string"
@@ -6771,6 +6836,219 @@ false
 },
 "type": "object"
 },
+"PreCheckMajorVersionUpgradeContext": {
+"description": "Pre-check major version upgrade context.",
+"id": "PreCheckMajorVersionUpgradeContext",
+"properties": {
+"kind": {
+"description": "Optional. This is always `sql#preCheckMajorVersionUpgradeContext`.",
+"type": "string"
+},
+"preCheckResponse": {
+"description": "Output only. The responses from the precheck operation.",
+"items": {
+"$ref": "PreCheckResponse"
+},
+"readOnly": true,
+"type": "array"
+},
+"targetDatabaseVersion": {
+"description": "Required. The target database version to upgrade to.",
+"enum": [
+"SQL_DATABASE_VERSION_UNSPECIFIED",
+"MYSQL_5_1",
+"MYSQL_5_5",
+"MYSQL_5_6",
+"MYSQL_5_7",
+"MYSQL_8_0",
+"MYSQL_8_0_18",
+"MYSQL_8_0_26",
+"MYSQL_8_0_27",
+"MYSQL_8_0_28",
+"MYSQL_8_0_29",
+"MYSQL_8_0_30",
+"MYSQL_8_0_31",
+"MYSQL_8_0_32",
+"MYSQL_8_0_33",
+"MYSQL_8_0_34",
+"MYSQL_8_0_35",
+"MYSQL_8_0_36",
+"MYSQL_8_0_37",
+"MYSQL_8_0_39",
+"MYSQL_8_0_40",
+"MYSQL_8_0_41",
+"MYSQL_8_0_42",
+"MYSQL_8_0_43",
+"MYSQL_8_0_44",
+"MYSQL_8_0_45",
+"MYSQL_8_0_46",
+"MYSQL_8_4",
+"SQLSERVER_2017_STANDARD",
+"SQLSERVER_2017_ENTERPRISE",
+"SQLSERVER_2017_EXPRESS",
+"SQLSERVER_2017_WEB",
+"POSTGRES_9_6",
+"POSTGRES_10",
+"POSTGRES_11",
+"POSTGRES_12",
+"POSTGRES_13",
+"POSTGRES_14",
+"POSTGRES_15",
+"POSTGRES_16",
+"POSTGRES_17",
+"POSTGRES_18",
+"SQLSERVER_2019_STANDARD",
+"SQLSERVER_2019_ENTERPRISE",
+"SQLSERVER_2019_EXPRESS",
+"SQLSERVER_2019_WEB",
+"SQLSERVER_2022_STANDARD",
+"SQLSERVER_2022_ENTERPRISE",
+"SQLSERVER_2022_EXPRESS",
+"SQLSERVER_2022_WEB"
+],
+"enumDeprecated": [
+false,
+true,
+true,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+true,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false,
+false
+],
+"enumDescriptions": [
+"This is an unknown database version.",
+"The database version is MySQL 5.1.",
+"The database version is MySQL 5.5.",
+"The database version is MySQL 5.6.",
+"The database version is MySQL 5.7.",
+"The database version is MySQL 8.",
+"The database major version is MySQL 8.0 and the minor version is 18.",
+"The database major version is MySQL 8.0 and the minor version is 26.",
+"The database major version is MySQL 8.0 and the minor version is 27.",
+"The database major version is MySQL 8.0 and the minor version is 28.",
+"The database major version is MySQL 8.0 and the minor version is 29.",
+"The database major version is MySQL 8.0 and the minor version is 30.",
+"The database major version is MySQL 8.0 and the minor version is 31.",
+"The database major version is MySQL 8.0 and the minor version is 32.",
+"The database major version is MySQL 8.0 and the minor version is 33.",
+"The database major version is MySQL 8.0 and the minor version is 34.",
+"The database major version is MySQL 8.0 and the minor version is 35.",
+"The database major version is MySQL 8.0 and the minor version is 36.",
+"The database major version is MySQL 8.0 and the minor version is 37.",
+"The database major version is MySQL 8.0 and the minor version is 39.",
+"The database major version is MySQL 8.0 and the minor version is 40.",
+"The database major version is MySQL 8.0 and the minor version is 41.",
+"The database major version is MySQL 8.0 and the minor version is 42.",
+"The database major version is MySQL 8.0 and the minor version is 43.",
+"The database major version is MySQL 8.0 and the minor version is 44.",
+"The database major version is MySQL 8.0 and the minor version is 45.",
+"The database major version is MySQL 8.0 and the minor version is 46.",
+"The database version is MySQL 8.4.",
+"The database version is SQL Server 2017 Standard.",
+"The database version is SQL Server 2017 Enterprise.",
+"The database version is SQL Server 2017 Express.",
+"The database version is SQL Server 2017 Web.",
+"The database version is PostgreSQL 9.6.",
+"The database version is PostgreSQL 10.",
+"The database version is PostgreSQL 11.",
+"The database version is PostgreSQL 12.",
+"The database version is PostgreSQL 13.",
+"The database version is PostgreSQL 14.",
+"The database version is PostgreSQL 15.",
+"The database version is PostgreSQL 16.",
+"The database version is PostgreSQL 17.",
+"The database version is PostgreSQL 18.",
+"The database version is SQL Server 2019 Standard.",
+"The database version is SQL Server 2019 Enterprise.",
+"The database version is SQL Server 2019 Express.",
+"The database version is SQL Server 2019 Web.",
+"The database version is SQL Server 2022 Standard.",
+"The database version is SQL Server 2022 Enterprise.",
+"The database version is SQL Server 2022 Express.",
+"The database version is SQL Server 2022 Web."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
+"PreCheckResponse": {
+"description": "Structured PreCheckResponse containing message, type, and required actions.",
+"id": "PreCheckResponse",
+"properties": {
+"actionsRequired": {
+"description": "The actions that the user needs to take. Use repeated for multiple actions.",
+"items": {
+"type": "string"
+},
+"type": "array"
+},
+"message": {
+"description": "The message to be displayed to the user.",
+"type": "string"
+},
+"messageType": {
+"description": "The type of message whether it is an info, warning, or error.",
+"enum": [
+"MESSAGE_TYPE_UNSPECIFIED",
+"INFO",
+"WARNING",
+"ERROR"
+],
+"enumDescriptions": [
+"Default unspecified value to prevent unintended behavior changes.",
+"General informational messages that don't require action.",
+"Warnings that might impact the upgrade but don't block it.",
+"Errors that a user must resolve before proceeding with the upgrade."
+],
+"type": "string"
+}
+},
+"type": "object"
+},
 "PscAutoConnectionConfig": {
 "description": "Settings for an automatically-setup Private Service Connect consumer endpoint that is used to connect to a Cloud SQL instance.",
 "id": "PscAutoConnectionConfig",
@@ -6843,7 +7121,7 @@ false
 "type": "string"
 },
 "partialResult": {
-"description": "Set to true if the SQL execution's result is truncated due to size limits.",
+"description": "Set to true if the SQL execution's result is truncated due to size limits or an error retrieving results.",
 "type": "boolean"
 },
 "rows": {
@@ -6852,6 +7130,10 @@ false
 "$ref": "Row"
 },
 "type": "array"
+},
+"status": {
+"$ref": "Status",
+"description": "If results were truncated due to an error, details of that error."
 }
 },
 "type": "object"
@@ -6878,6 +7160,16 @@ false
 "format": "int32",
 "type": "integer"
 },
+"scaleInCooldownSeconds": {
+"description": "The cooldown period for scale-in operations.",
+"format": "int32",
+"type": "integer"
+},
+"scaleOutCooldownSeconds": {
+"description": "The cooldown period for scale-out operations.",
+"format": "int32",
+"type": "integer"
+},
 "targetMetrics": {
 "description": "Optional. Target metrics for read pool auto scaling.",
 "items": {
@@ -7080,6 +7372,10 @@ true
 },
 "type": "array"
 },
+"autoUpgradeEnabled": {
+"description": "Optional. Cloud SQL for MySQL auto-upgrade configuration. When this parameter is set to true, auto-upgrade is enabled for MySQL 8.0 minor versions. The MySQL version must be 8.0.35 or higher.",
+"type": "boolean"
+},
 "availabilityType": {
 "description": "Availability type. Potential values: * `ZONAL`: The instance serves data from only one zone. Outages in that zone affect data accessibility. * `REGIONAL`: The instance can serve data from more than one zone in a region (it is highly available)./ For more information, see [Overview of the High Availability Configuration](https://cloud.google.com/sql/docs/mysql/high-availability).",
 "enum": [
@@ -7347,12 +7643,20 @@ false
 "enum": [
 "ACTIVE_DIRECTORY_MODE_UNSPECIFIED",
 "MANAGED_ACTIVE_DIRECTORY",
-"SELF_MANAGED_ACTIVE_DIRECTORY"
+"SELF_MANAGED_ACTIVE_DIRECTORY",
+"CUSTOMER_MANAGED_ACTIVE_DIRECTORY"
+],
+"enumDeprecated": [
+false,
+false,
+true,
+false
 ],
 "enumDescriptions": [
 "Unspecified mode. Will default to MANAGED_ACTIVE_DIRECTORY if the mode is not specified to maintain backward compatibility.",
 "Managed Active Directory mode.",
-"Self-managed Active Directory mode."
+"Deprecated: Use CUSTOMER_MANAGED_ACTIVE_DIRECTORY instead.",
+"Customer-managed Active Directory mode."
 ],
 "type": "string"
 },
@@ -7536,6 +7840,10 @@ false
 "$ref": "QueryResult"
 },
 "type": "array"
+},
+"status": {
+"$ref": "Status",
+"description": "Contains the error from the database if the SQL execution failed."
 }
 },
 "type": "object"
@@ -8029,6 +8337,33 @@ false
 },
 "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",
+"properties": {
+"code": {
+"description": "The status code, which should be an enum value of google.rpc.Code.",
+"format": "int32",
+"type": "integer"
+},
+"details": {
+"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
+"items": {
+"additionalProperties": {
+"description": "Properties of the object. Contains field @type with type URL.",
+"type": "any"
+},
+"type": "object"
+},
+"type": "array"
+},
+"message": {
+"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "SyncFlags": {
 "description": "Initial sync flags for certain Cloud SQL APIs. Currently used for the MySQL external server initial dump.",
 "id": "SyncFlags",
@@ -8153,6 +8488,10 @@ false
 "description": "Optional. The host from which the user can connect. For `insert` operations, host defaults to an empty string. For `update` operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional.",
 "type": "string"
 },
+"iamEmail": {
+"description": "Optional. The full email for an IAM user. For normal database users, this will not be filled. Only applicable to MySQL database users.",
+"type": "string"
+},
 "iamStatus": {
 "description": "Indicates if a group is active or inactive for IAM database authentication.",
 "enum": [