google-api-python-client 2.102.0__py2.py3-none-any.whl → 2.104.0__py2.py3-none-any.whl

googleapiclient/discovery_cache/documents/sqladmin.v1.json

@@ -1023,6 +1023,11 @@
             "instance"
           ],
           "parameters": {
+            "failover": {
+              "description": "Set to true if the promote operation should attempt to re-add the original primary as a replica when it comes back online. Otherwise, if this value is false or not set, the original primary will be a standalone instance.",
+              "location": "query",
+              "type": "boolean"
+            },
             "instance": {
               "description": "Cloud SQL read replica instance name.",
               "location": "path",
@@ -1278,6 +1283,44 @@
             "https://www.googleapis.com/auth/sqlservice.admin"
           ]
         },
+        "switchover": {
+          "description": "Switches over from the primary instance to the replica instance.",
+          "flatPath": "v1/projects/{project}/instances/{instance}/switchover",
+          "httpMethod": "POST",
+          "id": "sql.instances.switchover",
+          "parameterOrder": [
+            "project",
+            "instance"
+          ],
+          "parameters": {
+            "dbTimeout": {
+              "description": "Optional. (MySQL only) Cloud SQL instance operations timeout, which is a sum of all database operations. Default value is 10 minutes and can be modified to a maximum value of 24 hours.",
+              "format": "google-duration",
+              "location": "query",
+              "type": "string"
+            },
+            "instance": {
+              "description": "Cloud SQL read replica instance name.",
+              "location": "path",
+              "required": true,
+              "type": "string"
+            },
+            "project": {
+              "description": "ID of the project that contains the replica.",
+              "location": "path",
+              "required": true,
+              "type": "string"
+            }
+          },
+          "path": "v1/projects/{project}/instances/{instance}/switchover",
+          "response": {
+            "$ref": "Operation"
+          },
+          "scopes": [
+            "https://www.googleapis.com/auth/cloud-platform",
+            "https://www.googleapis.com/auth/sqlservice.admin"
+          ]
+        },
         "truncateLog": {
           "description": "Truncate MySQL general and slow query log tables MySQL only.",
           "flatPath": "v1/projects/{project}/instances/{instance}/truncateLog",
@@ -2122,7 +2165,7 @@
       }
     }
   },
-  "revision": "20230928",
+  "revision": "20231011",
   "rootUrl": "https://sqladmin.googleapis.com/",
   "schemas": {
     "AclEntry": {
@@ -3025,7 +3068,8 @@
           "description": "This field represents the report generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job"
         },
         "primaryDnsName": {
-          "description": "Output only. The dns name of the primary instance in a replication group.",
+          "deprecated": true,
+          "description": "Output only. DEPRECATED: please use write_endpoint instead.",
           "readOnly": true,
           "type": "string"
         },
@@ -3139,6 +3183,11 @@
             "type": "string"
           },
           "type": "array"
+        },
+        "writeEndpoint": {
+          "description": "Output only. The dns name of the primary instance in a replication group.",
+          "readOnly": true,
+          "type": "string"
         }
       },
       "type": "object"
@@ -4052,14 +4101,30 @@
           "description": "PSC settings for this instance."
         },
         "requireSsl": {
-          "description": "Whether SSL connections over IP are enforced or not.",
+          "description": "LINT.IfChange(require_ssl_deprecate) Whether SSL/TLS connections over IP are enforced or not. If set to false, allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate will not be verified. If set to true, only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, use the `ssl_mode` flag instead of the legacy `require_ssl` flag. LINT.ThenChange(//depot/google3/java/com/google/storage/speckle/boss/admin/actions/InstanceUpdateAction.java:update_api_temp_fix)",
           "type": "boolean"
+        },
+        "sslMode": {
+          "description": "Specify how SSL/TLS will be enforced in database connections. This flag is only supported for PostgreSQL. Use the legacy `require_ssl` flag for enforcing SSL/TLS in MySQL and SQL Server. But, for PostgreSQL, it is recommended to use the `ssl_mode` flag instead of the legacy `require_ssl` flag. To avoid the conflict between those flags in PostgreSQL, only the following value pairs are valid: ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED, require_ssl=false; ssl_mode=ENCRYPTED_ONLY, require_ssl=false; ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED, require_ssl=true; Note that the value of `ssl_mode` gets priority over the value of the legacy `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY, require_ssl=false`, the `ssl_mode=ENCRYPTED_ONLY` means \"only accepts SSL connection\", while the `require_ssl=false` means \"both non-SSL and SSL connections are allowed\". The database will respect `ssl_mode` in this case and only accept SSL connections.",
+          "enum": [
+            "SSL_MODE_UNSPECIFIED",
+            "ALLOW_UNENCRYPTED_AND_ENCRYPTED",
+            "ENCRYPTED_ONLY",
+            "TRUSTED_CLIENT_CERTIFICATE_REQUIRED"
+          ],
+          "enumDescriptions": [
+            "SSL mode is unknown.",
+            "Allow non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate will not be verified. When this value is used, legacy `require_ssl` flag must be false or unset to avoid the conflict between values of two flags.",
+            "Only allow connections encrypted with SSL/TLS. When this value is used, legacy `require_ssl` flag must be false or unset to avoid the conflict between values of two flags.",
+            "Only allow connections encrypted with SSL/TLS and with valid client certificates. When this value is used, legacy `require_ssl` flag must be true or unset to avoid the conflict between values of two flags."
+          ],
+          "type": "string"
         }
       },
       "type": "object"
     },
     "IpMapping": {
-      "description": "Database instance IP Mapping.",
+      "description": "Database instance IP mapping",
       "id": "IpMapping",
       "properties": {
         "ipAddress": {
@@ -4604,6 +4669,10 @@
           ],
           "type": "string"
         },
+        "disallowCompromisedCredentials": {
+          "description": "Disallow credentials that have been previously compromised by a public data breach.",
+          "type": "boolean"
+        },
         "disallowUsernameSubstring": {
           "description": "Disallow username as a part of the password.",
           "type": "boolean"
@@ -4647,7 +4716,7 @@
       "id": "PscConfig",
       "properties": {
         "allowedConsumerProjects": {
-          "description": "List of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric).",
+          "description": "Optional. The list of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric).",
           "items": {
             "type": "string"
           },
@@ -4664,6 +4733,10 @@
       "description": "Read-replica configuration for connecting to the primary instance.",
       "id": "ReplicaConfiguration",
       "properties": {
+        "cascadableReplica": {
+          "description": "Optional. Specifies if a SQL Server replica is a cascadable replica. A cascadable replica is a SQL Server cross region replica that supports replica(s) under it.",
+          "type": "boolean"
+        },
         "failoverTarget": {
           "description": "Specifies if the replica is the failover target. If the field is set to `true`, the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance.",
           "type": "boolean"

googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json

@@ -753,7 +753,7 @@
           ],
           "parameters": {
             "instance": {
-              "description": "Cloud SQL instance ID. This does not include the project ID.",
+              "description": "The Cloud SQL instance ID. This doesn't include the project ID.",
               "location": "path",
               "required": true,
               "type": "string"
@@ -1023,6 +1023,11 @@
             "instance"
           ],
           "parameters": {
+            "failover": {
+              "description": "Set to true if the promote operation should attempt to re-add the original primary as a replica when it comes back online. Otherwise, if this value is false or not set, the original primary will be a standalone instance.",
+              "location": "query",
+              "type": "boolean"
+            },
             "instance": {
               "description": "Cloud SQL read replica instance name.",
               "location": "path",
@@ -1278,6 +1283,44 @@
             "https://www.googleapis.com/auth/sqlservice.admin"
           ]
         },
+        "switchover": {
+          "description": "Switches over from the primary instance to a replica instance.",
+          "flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/switchover",
+          "httpMethod": "POST",
+          "id": "sql.instances.switchover",
+          "parameterOrder": [
+            "project",
+            "instance"
+          ],
+          "parameters": {
+            "dbTimeout": {
+              "description": "Optional. (MySQL only) Cloud SQL instance operations timeout, which is a sum of all database operations. Default value is 10 minutes and can be modified to a maximum value of 24 hours.",
+              "format": "google-duration",
+              "location": "query",
+              "type": "string"
+            },
+            "instance": {
+              "description": "Cloud SQL read replica instance name.",
+              "location": "path",
+              "required": true,
+              "type": "string"
+            },
+            "project": {
+              "description": "ID of the project that contains the replica.",
+              "location": "path",
+              "required": true,
+              "type": "string"
+            }
+          },
+          "path": "sql/v1beta4/projects/{project}/instances/{instance}/switchover",
+          "response": {
+            "$ref": "Operation"
+          },
+          "scopes": [
+            "https://www.googleapis.com/auth/cloud-platform",
+            "https://www.googleapis.com/auth/sqlservice.admin"
+          ]
+        },
         "truncateLog": {
           "description": "Truncate MySQL general and slow query log tables MySQL only.",
           "flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/truncateLog",
@@ -2122,7 +2165,7 @@
       }
     }
   },
-  "revision": "20230928",
+  "revision": "20231011",
   "rootUrl": "https://sqladmin.googleapis.com/",
   "schemas": {
     "AclEntry": {
@@ -3025,7 +3068,8 @@
           "description": "This field represents the report generated by the proactive database wellness job for OutOfDisk issues. * Writers: * the proactive database wellness job for OOD. * Readers: * the proactive database wellness job"
         },
         "primaryDnsName": {
-          "description": "Output only. The dns name of the primary instance in a replication group.",
+          "deprecated": true,
+          "description": "Output only. DEPRECATED: please use write_endpoint instead.",
           "readOnly": true,
           "type": "string"
         },
@@ -3139,6 +3183,11 @@
             "type": "string"
           },
           "type": "array"
+        },
+        "writeEndpoint": {
+          "description": "Output only. The dns name of the primary instance in a replication group.",
+          "readOnly": true,
+          "type": "string"
         }
       },
       "type": "object"
@@ -4052,14 +4101,30 @@
           "description": "PSC settings for this instance."
         },
         "requireSsl": {
-          "description": "Whether SSL connections over IP are enforced or not.",
+          "description": "LINT.IfChange(require_ssl_deprecate) Whether SSL/TLS connections over IP are enforced or not. If set to false, allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate will not be verified. If set to true, only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, use the `ssl_mode` flag instead of the legacy `require_ssl` flag. LINT.ThenChange(//depot/google3/java/com/google/storage/speckle/boss/admin/actions/InstanceUpdateAction.java:update_api_temp_fix)",
           "type": "boolean"
+        },
+        "sslMode": {
+          "description": "Specify how SSL/TLS will be enforced in database connections. This flag is only supported for PostgreSQL. Use the legacy `require_ssl` flag for enforcing SSL/TLS in MySQL and SQL Server. But, for PostgreSQL, it is recommended to use the `ssl_mode` flag instead of the legacy `require_ssl` flag. To avoid the conflict between those flags in PostgreSQL, only the following value pairs are valid: ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED, require_ssl=false; ssl_mode=ENCRYPTED_ONLY, require_ssl=false; ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED, require_ssl=true; Note that the value of `ssl_mode` gets priority over the value of the legacy `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY, require_ssl=false`, the `ssl_mode=ENCRYPTED_ONLY` means \"only accepts SSL connection\", while the `require_ssl=false` means \"both non-SSL and SSL connections are allowed\". The database will respect `ssl_mode` in this case and only accept SSL connections.",
+          "enum": [
+            "SSL_MODE_UNSPECIFIED",
+            "ALLOW_UNENCRYPTED_AND_ENCRYPTED",
+            "ENCRYPTED_ONLY",
+            "TRUSTED_CLIENT_CERTIFICATE_REQUIRED"
+          ],
+          "enumDescriptions": [
+            "SSL mode is unknown.",
+            "Allow non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate will not be verified. When this value is used, legacy `require_ssl` flag must be false or unset to avoid the conflict between values of two flags.",
+            "Only allow connections encrypted with SSL/TLS. When this value is used, legacy `require_ssl` flag must be false or unset to avoid the conflict between values of two flags.",
+            "Only allow connections encrypted with SSL/TLS and with valid client certificates. When this value is used, legacy `require_ssl` flag must be true or unset to avoid the conflict between values of two flags."
+          ],
+          "type": "string"
         }
       },
       "type": "object"
     },
     "IpMapping": {
-      "description": "Database instance IP Mapping.",
+      "description": "Database instance IP mapping",
       "id": "IpMapping",
       "properties": {
         "ipAddress": {
@@ -4604,6 +4669,10 @@
           ],
           "type": "string"
         },
+        "disallowCompromisedCredentials": {
+          "description": "Disallow credentials that have been previously compromised by a public data breach.",
+          "type": "boolean"
+        },
         "disallowUsernameSubstring": {
           "description": "Disallow username as a part of the password.",
           "type": "boolean"
@@ -4647,7 +4716,7 @@
       "id": "PscConfig",
       "properties": {
         "allowedConsumerProjects": {
-          "description": "List of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric).",
+          "description": "Optional. The list of consumer projects that are allow-listed for PSC connections to this instance. This instance can be connected to with PSC from any network in these projects. Each consumer project in this list may be represented by a project number (numeric) or by a project id (alphanumeric).",
           "items": {
             "type": "string"
           },
@@ -4664,6 +4733,10 @@
       "description": "Read-replica configuration for connecting to the primary instance.",
       "id": "ReplicaConfiguration",
       "properties": {
+        "cascadableReplica": {
+          "description": "Optional. Specifies if a SQL Server replica is a cascadable replica. A cascadable replica is a SQL Server cross region replica that supports replica(s) under it.",
+          "type": "boolean"
+        },
         "failoverTarget": {
           "description": "Specifies if the replica is the failover target. If the field is set to `true` the replica will be designated as a failover replica. In case the primary instance fails, the replica instance will be promoted as the new primary instance. Only one replica can be specified as failover target, and the replica has to be in different zone with the primary instance.",
           "type": "boolean"