+ instances()
+
Returns the instances Resource.
+ +
+ projects()
+
Returns the projects Resource.
+ +
+ close()
Close httplib2 connections.
+ +Create a BatchHttpRequest object based on the discovery document.
+close()
+ Close httplib2 connections.+
new_batch_http_request()
+ Create a BatchHttpRequest object based on the discovery document. + + Args: + callback: callable, A callback to be called for each response, of the + form callback(id, response, exception). The first parameter is the + request id, and the second is the deserialized response object. The + third is an apiclient.errors.HttpError exception object if an HTTP + error occurred while processing the request, or None if no error + occurred. + + Returns: + A BatchHttpRequest object based on the discovery document. ++
+ close()
Close httplib2 connections.
+
+ list(project, filter=None, maxResults=None, pageToken=None, x__xgafv=None)
Lists instances under a given project.
+
+ list_next(previous_request, previous_response)
Retrieves the next page of results.
+close()
+ Close httplib2 connections.+
list(project, filter=None, maxResults=None, pageToken=None, x__xgafv=None)
+ Lists instances under a given project.
+
+Args:
+ project: string, Project ID of the project for which to list Cloud SQL instances. (required)
+ filter: string, A filter expression that filters resources listed in the response. The expression is in the form of field:value. For example, 'instanceType:CLOUD_SQL_INSTANCE'. Fields can be nested as needed as per their JSON representation, such as 'settings.userLabels.auto_start:true'. Multiple filter queries are space-separated. For example. 'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'. By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly.
+ maxResults: integer, The maximum number of results to return per response.
+ pageToken: string, A previously-returned page token representing part of the larger set of results to view.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Database instances list response.
+ "items": [ # List of database instance resources.
+ { # A Cloud SQL instance resource.
+ "backendType": "A String", # *SECOND_GEN*: Cloud SQL database instance. *EXTERNAL*: A database server that is not managed by Google. This property is read-only; use the *tier* property in the *settings* object to determine the database type.
+ "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
+ "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see this announcement for details.
+ "databaseVersion": "A String", # The database engine type and version. The *databaseVersion* field cannot be changed after instance creation. MySQL instances: *MYSQL_8_0*, *MYSQL_5_7* (default), or *MYSQL_5_6*. PostgreSQL instances: *POSTGRES_9_6*, *POSTGRES_10*, *POSTGRES_11*, *POSTGRES_12*, or *POSTGRES_13* (default). SQL Server instances: *SQLSERVER_2017_STANDARD* (default), *SQLSERVER_2017_ENTERPRISE*, *SQLSERVER_2017_EXPRESS*, or *SQLSERVER_2017_WEB*.
+ "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. Applies only to Second Generation instances.
+ "kind": "A String", # This is always **sql#diskEncryptionConfiguration**.
+ "kmsKeyName": "A String", # Resource name of KMS key for disk encryption
+ },
+ "diskEncryptionStatus": { # Disk encryption status for an instance. # Disk encryption status specific to an instance. Applies only to Second Generation instances.
+ "kind": "A String", # This is always **sql#diskEncryptionStatus**.
+ "kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource
+ },
+ "encryptedRootPassword": "A String", # For internal usage only. The encrypted password.
+ "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the *settings.settingsVersion* field instead.
+ "failoverReplica": { # The name and status of the failover replica. This property is applicable only to Second Generation instances.
+ "available": True or False, # The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true.
+ "failoverInstance": { # Reference to another Cloud SQL instance. # A reference to the failover replica. If specified at instance creation, a failover replica is created for the instance. Currently, the failover replica can only be created in the same region as the primary instance.
+ "name": "A String", # The name of the Cloud SQL instance being referenced.
+ "region": "A String", # The region of the Cloud SQL instance being referenced.
+ },
+ "name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. This property is applicable only to Second Generation instances.
+ },
+ "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone.
+ "installedVersion": "A String", # installed_version stores the current fully resolved database version including minor version such as MySQL_5.6.50
+ "instanceType": "A String", # The instance type. This can be one of the following. *CLOUD_SQL_INSTANCE*: A Cloud SQL instance that is not replicating from a primary instance. *ON_PREMISES_INSTANCE*: An instance running on the customer's premises. *READ_REPLICA_INSTANCE*: A Cloud SQL instance configured as a read-replica.
+ "instanceUid": "A String", # Uid of the Cloud SQL instance. Used by Pantheon to check instance is created
+ "ipAddresses": [ # The assigned IP addresses for the instance.
+ { # Database instance IP Mapping.
+ "ipAddress": "A String", # The IP address assigned.
+ "timeToRetire": "A String", # The due time for this IP to be retired in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. This field is only available when the IP is scheduled to be retired.
+ "type": "A String", # The type of this IP address. A **PRIMARY** address is a public address that can accept incoming connections. A **PRIVATE** address is a private address that can accept incoming connections. An **OUTGOING** address is the source address of connections originating from the instance, if supported.
+ },
+ ],
+ "ipv6Address": "A String", # The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.
+ "kind": "A String", # This is always *sql#instance*.
+ "masterInstance": { # Reference to another Cloud SQL instance. # The reference to the instance which will act as primary in the replication setup.
+ "name": "A String", # The name of the Cloud SQL instance being referenced.
+ "region": "A String", # The region of the Cloud SQL instance being referenced.
+ },
+ "masterInstanceName": "A String", # The name of the instance which will act as primary in the replication setup.
+ "maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
+ "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
+ "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.
+ "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
+ "clientCertificate": "A String", # PEM representation of the replica's x509 certificate.
+ "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
+ "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica.
+ "hostPort": "A String", # The host and port of the on-premises instance in host:port format
+ "kind": "A String", # This is always *sql#onPremisesConfiguration*.
+ "password": "A String", # The password for connecting to on-premises instance.
+ "username": "A String", # The username for connecting to on-premises instance.
+ },
+ "outOfDiskReport": { # This message wraps up the information written by out-of-disk detection job. # 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 Pantheon frontend -- the proactive database wellness job
+ "sqlMinRecommendedIncreaseSizeGb": 42, # The minimum recommended increase size in GigaBytes This field is consumed by the frontend Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend
+ "sqlOutOfDiskState": "A String", # This field represents the state generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend -- the proactive database wellness job
+ },
+ "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
+ "region": "A String", # The geographical region. Can be *us-central* (*FIRST_GEN* instances only) *us-central1* (*SECOND_GEN* instances only) *asia-east1* or *europe-west1*. Defaults to *us-central* or *us-central1* depending on the instance type. The region cannot be changed after instance creation.
+ "replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas.
+ "failoverTarget": True or False, # 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.
+ "kind": "A String", # This is always *sql#replicaConfiguration*.
+ "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata.The configuration information is used only to set up the replication connection and is stored by MySQL in a file named *master.info* in the data directory.
+ "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
+ "clientCertificate": "A String", # PEM representation of the replica's x509 certificate.
+ "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
+ "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.
+ "dumpFilePath": "A String", # Path to a SQL dump file in Google Cloud Storage from which the replica instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps have the binlog co-ordinates from which replication begins. This can be accomplished by setting --master-data to 1 when using mysqldump.
+ "kind": "A String", # This is always **sql#mysqlReplicaConfiguration**.
+ "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.
+ "password": "A String", # The password for the replication connection.
+ "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.
+ "username": "A String", # The username for the replication connection.
+ "verifyServerCertificate": True or False, # Whether or not to check the primary instance's Common Name value in the certificate that it sends during the SSL handshake.
+ },
+ },
+ "replicaInstances": [ # The replicas of the instance.
+ { # Reference to another Cloud SQL instance.
+ "name": "A String", # The name of the Cloud SQL instance being referenced.
+ "region": "A String", # The region of the Cloud SQL instance being referenced.
+ },
+ ],
+ "replicaNames": [ # The replicas of the instance.
+ "A String",
+ ],
+ "rootPassword": "A String", # Initial root password. Use only on creation.
+ "satisfiesPzs": True or False, # The status indicating if instance satisfiesPzs. Reserved for future use.
+ "scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance.
+ "canDefer": True or False,
+ "canReschedule": True or False, # If the scheduled maintenance can be rescheduled.
+ "scheduleDeadlineTime": "A String", # Maintenance cannot be rescheduled to start beyond this deadline.
+ "startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance.
+ },
+ "secondaryGceZone": "A String", # The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. Reserved for future use.
+ "selfLink": "A String", # The URI of this resource.
+ "serverCaCert": { # SslCerts Resource # SSL configuration.
+ "cert": "A String", # PEM representation.
+ "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
+ "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
+ "createTime": "A String", # The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**
+ "expirationTime": "A String", # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
+ "instance": "A String", # Name of the database instance.
+ "kind": "A String", # This is always sql#sslCert.
+ "sha1Fingerprint": "A String", # Sha1 Fingerprint.
+ },
+ "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property is read-only.
+ "settings": { # Database instance settings. # The user settings.
+ "activationPolicy": "A String", # The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. Valid values: **ALWAYS**: The instance is on, and remains so even in the absence of connection requests. **NEVER**: The instance is off; it is not activated, even if a connection request arrives.
+ "activeDirectoryConfig": { # Active Directory configuration, relevant only for Cloud SQL for SQL Server. # Active Directory configuration, relevant only for Cloud SQL for SQL Server.
+ "domain": "A String", # The name of the domain (e.g., mydomain.com).
+ "kind": "A String", # This is always sql#activeDirectoryConfig.
+ },
+ "availabilityType": "A String", # 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](/sql/docs/postgres/high-availability).
+ "backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance.
+ "backupRetentionSettings": { # We currently only support backup retention by specifying the number of backups we will retain. # Backup retention settings.
+ "retainedBackups": 42, # Depending on the value of retention_unit, this is used to determine if a backup needs to be deleted. If retention_unit is 'COUNT', we will retain this many backups.
+ "retentionUnit": "A String", # The unit that 'retained_backups' represents.
+ },
+ "binaryLogEnabled": True or False, # (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.
+ "enabled": True or False, # Whether this configuration is enabled.
+ "kind": "A String", # This is always **sql#backupConfiguration**.
+ "location": "A String", # Location of the backup
+ "pointInTimeRecoveryEnabled": True or False, # (Postgres only) Whether point in time recovery is enabled.
+ "replicationLogArchivingEnabled": True or False, # Reserved for future use.
+ "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - **HH:MM**.
+ "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7.
+ },
+ "collation": "A String", # The name of server Instance collation.
+ "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
+ "dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB.
+ "dataDiskType": "A String", # The type of data disk: **PD_SSD** (default) or **PD_HDD**.
+ "databaseFlags": [ # The database flags passed to the instance at startup.
+ { # Database flags for Cloud SQL instances.
+ "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both server options and system variables for MySQL. Flags are specified with underscores, not hyphens. For more information, see [Configuring Database Flags](/sql/docs/mysql/flags) in the Cloud SQL documentation.
+ "value": "A String", # The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value.
+ },
+ ],
+ "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.
+ "denyMaintenancePeriods": [ # Deny maintenance periods
+ { # Deny maintenance Periods. This specifies a date range during when all CSA rollout will be denied.
+ "endDate": "A String", # "deny maintenance period" end date. If the year of the end date is empty, the year of the start date also must be empty. In this case, it means the no maintenance interval recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
+ "startDate": "A String", # "deny maintenance period" start date. If the year of the start date is empty, the year of the end date also must be empty. In this case, it means the no maintenance interval recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
+ "time": "A String", # Time in UTC when the "deny maintenance period" starts on start_date and ends on end_date. The time is in format: HH:mm:SS, i.e., 00:00:00
+ },
+ ],
+ "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres.
+ "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled.
+ "queryPlansPerMinute": 42, # Number of query plans generated by Insights per minute. Default is 5. Changing this will restart the database.
+ "queryStringLength": 42, # Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query length more than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database.
+ "recordApplicationTags": True or False, # Whether Query Insights will record application tags from query when enabled.
+ "recordClientAddress": True or False, # Whether Query Insights will record client address when enabled.
+ },
+ "ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances.
+ "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: **192.168.100.0/24**).
+ { # An entry for an Access Control list.
+ "expirationTime": "A String", # The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
+ "kind": "A String", # This is always **sql#aclEntry**.
+ "name": "A String", # Optional. A label to identify this entry.
+ "value": "A String", # The allowlisted value for the access control list.
+ },
+ ],
+ "ipv4Enabled": True or False, # Whether the instance is assigned a public IP address or not.
+ "privateNetwork": "A String", # The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, **/projects/myProject/global/networks/default**. This setting can be updated, but it cannot be removed after it is set.
+ "requireSsl": True or False, # Whether SSL connections over IP are enforced or not.
+ },
+ "kind": "A String", # This is always **sql#settings**.
+ "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to Compute Engine zone for better performance.
+ "kind": "A String", # This is always **sql#locationPreference**.
+ "secondaryZone": "A String", # The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). Reserved for future use.
+ "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).
+ },
+ "maintenanceWindow": { # Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes. # The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes.
+ "day": 42, # day of week (1-7), starting on Monday.
+ "hour": 42, # hour of day - 0 to 23.
+ "kind": "A String", # This is always **sql#maintenanceWindow**.
+ "updateTrack": "A String", # Maintenance timing setting: **canary** (Earlier) or **stable** (Later). [Learn more] (https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/instance-settings#maintenance-timing-2ndgen).
+ },
+ "pricingPlan": "A String", # The pricing plan for this instance. This can be either **PER_USE** or **PACKAGE**. Only **PER_USE** is supported for Second Generation instances.
+ "replicationType": "A String", # The type of replication this instance uses. This can be either **ASYNCHRONOUS** or **SYNCHRONOUS**. (Deprecated) This property was only applicable to First Generation instances.
+ "settingsVersion": "A String", # The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
+ "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true.
+ "storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.
+ "tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**.
+ "userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair.
+ "a_key": "A String",
+ },
+ },
+ "state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following. *SQL_INSTANCE_STATE_UNSPECIFIED*: The state of the instance is unknown. *RUNNABLE*: The instance is running, or has been stopped by owner. *SUSPENDED*: The instance is not available, for example due to problems with billing. *PENDING_DELETE*: The instance is being deleted. *PENDING_CREATE*: The instance is being created. *MAINTENANCE*: The instance is down for maintenance. *FAILED*: The instance creation failed.
+ "suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension.
+ "A String",
+ ],
+ },
+ ],
+ "kind": "A String", # This is always *sql#instancesList*.
+ "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
+ "warnings": [ # List of warnings that occurred while handling the request.
+ { # An Admin API warning message.
+ "code": "A String", # Code to uniquely identify the warning type.
+ "message": "A String", # The warning message.
+ "region": "A String", # The region name for REGION_UNREACHABLE warning.
+ },
+ ],
+}
+list_next(previous_request, previous_response)
+ 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. ++
+ instances()
+
Returns the instances Resource.
+ +
+ close()
Close httplib2 connections.
+close()
+ Close httplib2 connections.+
+ close()
Close httplib2 connections.
+
+ create(project, instance, body=None, x__xgafv=None)
Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.
+close()
+ Close httplib2 connections.+
create(project, instance, body=None, x__xgafv=None)
+ Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.
+
+Args:
+ project: string, Project ID of the Cloud SQL project. (required)
+ instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # SslCerts create ephemeral certificate request.
+ "access_token": "A String", # Access token to include in the signed certificate.
+ "public_key": "A String", # PEM encoded public key to include in the signed certificate.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # SslCerts Resource
+ "cert": "A String", # PEM representation.
+ "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
+ "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
+ "createTime": "A String", # The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**
+ "expirationTime": "A String", # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
+ "instance": "A String", # Name of the database instance.
+ "kind": "A String", # This is always sql#sslCert.
+ "sha1Fingerprint": "A String", # Sha1 Fingerprint.
+}
+Returns the createEphemeral Resource.
+ +
+ close()
Close httplib2 connections.
+
+ generateEphemeralCert(project, instance, body=None, x__xgafv=None)
Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.
+
+ get(project, instance, x__xgafv=None)
Retrieves a resource containing information about a Cloud SQL instance.
+
+ getConnectSettings(project, instance, readTime=None, x__xgafv=None)
Retrieves connect settings about a Cloud SQL instance.
+close()
+ Close httplib2 connections.+
generateEphemeralCert(project, instance, body=None, x__xgafv=None)
+ Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.
+
+Args:
+ project: string, Project ID of the project that contains the instance. (required)
+ instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Ephemeral certificate creation request.
+ "access_token": "A String", # Optional. Access token to include in the signed certificate.
+ "public_key": "A String", # PEM encoded public key to include in the signed certificate.
+ "readTime": "A String", # Optional. Optional snapshot read timestamp to trade freshness for performance.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Ephemeral certificate creation request.
+ "ephemeralCert": { # SslCerts Resource # Generated cert
+ "cert": "A String", # PEM representation.
+ "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
+ "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
+ "createTime": "A String", # The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**
+ "expirationTime": "A String", # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
+ "instance": "A String", # Name of the database instance.
+ "kind": "A String", # This is always sql#sslCert.
+ "sha1Fingerprint": "A String", # Sha1 Fingerprint.
+ },
+}
+get(project, instance, x__xgafv=None)
+ Retrieves a resource containing information about a Cloud SQL instance.
+
+Args:
+ project: string, Project ID of the project that contains the instance. (required)
+ instance: string, Database instance ID. This does not include the project ID. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A Cloud SQL instance resource.
+ "backendType": "A String", # *SECOND_GEN*: Cloud SQL database instance. *EXTERNAL*: A database server that is not managed by Google. This property is read-only; use the *tier* property in the *settings* object to determine the database type.
+ "connectionName": "A String", # Connection name of the Cloud SQL instance used in connection strings.
+ "currentDiskSize": "A String", # The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see this announcement for details.
+ "databaseVersion": "A String", # The database engine type and version. The *databaseVersion* field cannot be changed after instance creation. MySQL instances: *MYSQL_8_0*, *MYSQL_5_7* (default), or *MYSQL_5_6*. PostgreSQL instances: *POSTGRES_9_6*, *POSTGRES_10*, *POSTGRES_11*, *POSTGRES_12*, or *POSTGRES_13* (default). SQL Server instances: *SQLSERVER_2017_STANDARD* (default), *SQLSERVER_2017_ENTERPRISE*, *SQLSERVER_2017_EXPRESS*, or *SQLSERVER_2017_WEB*.
+ "diskEncryptionConfiguration": { # Disk encryption configuration for an instance. # Disk encryption configuration specific to an instance. Applies only to Second Generation instances.
+ "kind": "A String", # This is always **sql#diskEncryptionConfiguration**.
+ "kmsKeyName": "A String", # Resource name of KMS key for disk encryption
+ },
+ "diskEncryptionStatus": { # Disk encryption status for an instance. # Disk encryption status specific to an instance. Applies only to Second Generation instances.
+ "kind": "A String", # This is always **sql#diskEncryptionStatus**.
+ "kmsKeyVersionName": "A String", # KMS key version used to encrypt the Cloud SQL instance resource
+ },
+ "encryptedRootPassword": "A String", # For internal usage only. The encrypted password.
+ "etag": "A String", # This field is deprecated and will be removed from a future version of the API. Use the *settings.settingsVersion* field instead.
+ "failoverReplica": { # The name and status of the failover replica. This property is applicable only to Second Generation instances.
+ "available": True or False, # The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true.
+ "failoverInstance": { # Reference to another Cloud SQL instance. # A reference to the failover replica. If specified at instance creation, a failover replica is created for the instance. Currently, the failover replica can only be created in the same region as the primary instance.
+ "name": "A String", # The name of the Cloud SQL instance being referenced.
+ "region": "A String", # The region of the Cloud SQL instance being referenced.
+ },
+ "name": "A String", # The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. This property is applicable only to Second Generation instances.
+ },
+ "gceZone": "A String", # The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone.
+ "installedVersion": "A String", # installed_version stores the current fully resolved database version including minor version such as MySQL_5.6.50
+ "instanceType": "A String", # The instance type. This can be one of the following. *CLOUD_SQL_INSTANCE*: A Cloud SQL instance that is not replicating from a primary instance. *ON_PREMISES_INSTANCE*: An instance running on the customer's premises. *READ_REPLICA_INSTANCE*: A Cloud SQL instance configured as a read-replica.
+ "instanceUid": "A String", # Uid of the Cloud SQL instance. Used by Pantheon to check instance is created
+ "ipAddresses": [ # The assigned IP addresses for the instance.
+ { # Database instance IP Mapping.
+ "ipAddress": "A String", # The IP address assigned.
+ "timeToRetire": "A String", # The due time for this IP to be retired in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. This field is only available when the IP is scheduled to be retired.
+ "type": "A String", # The type of this IP address. A **PRIMARY** address is a public address that can accept incoming connections. A **PRIVATE** address is a private address that can accept incoming connections. An **OUTGOING** address is the source address of connections originating from the instance, if supported.
+ },
+ ],
+ "ipv6Address": "A String", # The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.
+ "kind": "A String", # This is always *sql#instance*.
+ "masterInstance": { # Reference to another Cloud SQL instance. # The reference to the instance which will act as primary in the replication setup.
+ "name": "A String", # The name of the Cloud SQL instance being referenced.
+ "region": "A String", # The region of the Cloud SQL instance being referenced.
+ },
+ "masterInstanceName": "A String", # The name of the instance which will act as primary in the replication setup.
+ "maxDiskSize": "A String", # The maximum disk size of the instance in bytes.
+ "name": "A String", # Name of the Cloud SQL instance. This does not include the project ID.
+ "onPremisesConfiguration": { # On-premises instance configuration. # Configuration specific to on-premises instances.
+ "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
+ "clientCertificate": "A String", # PEM representation of the replica's x509 certificate.
+ "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
+ "dumpFilePath": "A String", # The dump file to create the Cloud SQL replica.
+ "hostPort": "A String", # The host and port of the on-premises instance in host:port format
+ "kind": "A String", # This is always *sql#onPremisesConfiguration*.
+ "password": "A String", # The password for connecting to on-premises instance.
+ "username": "A String", # The username for connecting to on-premises instance.
+ },
+ "outOfDiskReport": { # This message wraps up the information written by out-of-disk detection job. # 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 Pantheon frontend -- the proactive database wellness job
+ "sqlMinRecommendedIncreaseSizeGb": 42, # The minimum recommended increase size in GigaBytes This field is consumed by the frontend Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend
+ "sqlOutOfDiskState": "A String", # This field represents the state generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend -- the proactive database wellness job
+ },
+ "project": "A String", # The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.
+ "region": "A String", # The geographical region. Can be *us-central* (*FIRST_GEN* instances only) *us-central1* (*SECOND_GEN* instances only) *asia-east1* or *europe-west1*. Defaults to *us-central* or *us-central1* depending on the instance type. The region cannot be changed after instance creation.
+ "replicaConfiguration": { # Read-replica configuration for connecting to the primary instance. # Configuration specific to failover replicas and read replicas.
+ "failoverTarget": True or False, # 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.
+ "kind": "A String", # This is always *sql#replicaConfiguration*.
+ "mysqlReplicaConfiguration": { # Read-replica configuration specific to MySQL databases. # MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata.The configuration information is used only to set up the replication connection and is stored by MySQL in a file named *master.info* in the data directory.
+ "caCertificate": "A String", # PEM representation of the trusted CA's x509 certificate.
+ "clientCertificate": "A String", # PEM representation of the replica's x509 certificate.
+ "clientKey": "A String", # PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.
+ "connectRetryInterval": 42, # Seconds to wait between connect retries. MySQL's default is 60 seconds.
+ "dumpFilePath": "A String", # Path to a SQL dump file in Google Cloud Storage from which the replica instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps have the binlog co-ordinates from which replication begins. This can be accomplished by setting --master-data to 1 when using mysqldump.
+ "kind": "A String", # This is always **sql#mysqlReplicaConfiguration**.
+ "masterHeartbeatPeriod": "A String", # Interval in milliseconds between replication heartbeats.
+ "password": "A String", # The password for the replication connection.
+ "sslCipher": "A String", # A list of permissible ciphers to use for SSL encryption.
+ "username": "A String", # The username for the replication connection.
+ "verifyServerCertificate": True or False, # Whether or not to check the primary instance's Common Name value in the certificate that it sends during the SSL handshake.
+ },
+ },
+ "replicaInstances": [ # The replicas of the instance.
+ { # Reference to another Cloud SQL instance.
+ "name": "A String", # The name of the Cloud SQL instance being referenced.
+ "region": "A String", # The region of the Cloud SQL instance being referenced.
+ },
+ ],
+ "replicaNames": [ # The replicas of the instance.
+ "A String",
+ ],
+ "rootPassword": "A String", # Initial root password. Use only on creation.
+ "satisfiesPzs": True or False, # The status indicating if instance satisfiesPzs. Reserved for future use.
+ "scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance.
+ "canDefer": True or False,
+ "canReschedule": True or False, # If the scheduled maintenance can be rescheduled.
+ "scheduleDeadlineTime": "A String", # Maintenance cannot be rescheduled to start beyond this deadline.
+ "startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance.
+ },
+ "secondaryGceZone": "A String", # The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. Reserved for future use.
+ "selfLink": "A String", # The URI of this resource.
+ "serverCaCert": { # SslCerts Resource # SSL configuration.
+ "cert": "A String", # PEM representation.
+ "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
+ "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
+ "createTime": "A String", # The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**
+ "expirationTime": "A String", # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
+ "instance": "A String", # Name of the database instance.
+ "kind": "A String", # This is always sql#sslCert.
+ "sha1Fingerprint": "A String", # Sha1 Fingerprint.
+ },
+ "serviceAccountEmailAddress": "A String", # The service account email address assigned to the instance. This property is read-only.
+ "settings": { # Database instance settings. # The user settings.
+ "activationPolicy": "A String", # The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. Valid values: **ALWAYS**: The instance is on, and remains so even in the absence of connection requests. **NEVER**: The instance is off; it is not activated, even if a connection request arrives.
+ "activeDirectoryConfig": { # Active Directory configuration, relevant only for Cloud SQL for SQL Server. # Active Directory configuration, relevant only for Cloud SQL for SQL Server.
+ "domain": "A String", # The name of the domain (e.g., mydomain.com).
+ "kind": "A String", # This is always sql#activeDirectoryConfig.
+ },
+ "availabilityType": "A String", # 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](/sql/docs/postgres/high-availability).
+ "backupConfiguration": { # Database instance backup configuration. # The daily backup configuration for the instance.
+ "backupRetentionSettings": { # We currently only support backup retention by specifying the number of backups we will retain. # Backup retention settings.
+ "retainedBackups": 42, # Depending on the value of retention_unit, this is used to determine if a backup needs to be deleted. If retention_unit is 'COUNT', we will retain this many backups.
+ "retentionUnit": "A String", # The unit that 'retained_backups' represents.
+ },
+ "binaryLogEnabled": True or False, # (MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.
+ "enabled": True or False, # Whether this configuration is enabled.
+ "kind": "A String", # This is always **sql#backupConfiguration**.
+ "location": "A String", # Location of the backup
+ "pointInTimeRecoveryEnabled": True or False, # (Postgres only) Whether point in time recovery is enabled.
+ "replicationLogArchivingEnabled": True or False, # Reserved for future use.
+ "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - **HH:MM**.
+ "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7.
+ },
+ "collation": "A String", # The name of server Instance collation.
+ "crashSafeReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.
+ "dataDiskSizeGb": "A String", # The size of data disk, in GB. The data disk size minimum is 10GB.
+ "dataDiskType": "A String", # The type of data disk: **PD_SSD** (default) or **PD_HDD**.
+ "databaseFlags": [ # The database flags passed to the instance at startup.
+ { # Database flags for Cloud SQL instances.
+ "name": "A String", # The name of the flag. These flags are passed at instance startup, so include both server options and system variables for MySQL. Flags are specified with underscores, not hyphens. For more information, see [Configuring Database Flags](/sql/docs/mysql/flags) in the Cloud SQL documentation.
+ "value": "A String", # The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value.
+ },
+ ],
+ "databaseReplicationEnabled": True or False, # Configuration specific to read replica instances. Indicates whether replication is enabled or not.
+ "denyMaintenancePeriods": [ # Deny maintenance periods
+ { # Deny maintenance Periods. This specifies a date range during when all CSA rollout will be denied.
+ "endDate": "A String", # "deny maintenance period" end date. If the year of the end date is empty, the year of the start date also must be empty. In this case, it means the no maintenance interval recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
+ "startDate": "A String", # "deny maintenance period" start date. If the year of the start date is empty, the year of the end date also must be empty. In this case, it means the no maintenance interval recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01
+ "time": "A String", # Time in UTC when the "deny maintenance period" starts on start_date and ends on end_date. The time is in format: HH:mm:SS, i.e., 00:00:00
+ },
+ ],
+ "insightsConfig": { # Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration. # Insights configuration, for now relevant only for Postgres.
+ "queryInsightsEnabled": True or False, # Whether Query Insights feature is enabled.
+ "queryPlansPerMinute": 42, # Number of query plans generated by Insights per minute. Default is 5. Changing this will restart the database.
+ "queryStringLength": 42, # Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query length more than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database.
+ "recordApplicationTags": True or False, # Whether Query Insights will record application tags from query when enabled.
+ "recordClientAddress": True or False, # Whether Query Insights will record client address when enabled.
+ },
+ "ipConfiguration": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances.
+ "authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: **192.168.100.0/24**).
+ { # An entry for an Access Control list.
+ "expirationTime": "A String", # The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
+ "kind": "A String", # This is always **sql#aclEntry**.
+ "name": "A String", # Optional. A label to identify this entry.
+ "value": "A String", # The allowlisted value for the access control list.
+ },
+ ],
+ "ipv4Enabled": True or False, # Whether the instance is assigned a public IP address or not.
+ "privateNetwork": "A String", # The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, **/projects/myProject/global/networks/default**. This setting can be updated, but it cannot be removed after it is set.
+ "requireSsl": True or False, # Whether SSL connections over IP are enforced or not.
+ },
+ "kind": "A String", # This is always **sql#settings**.
+ "locationPreference": { # Preferred location. This specifies where a Cloud SQL instance is located. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified. # The location preference settings. This allows the instance to be located as near as possible to Compute Engine zone for better performance.
+ "kind": "A String", # This is always **sql#locationPreference**.
+ "secondaryZone": "A String", # The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). Reserved for future use.
+ "zone": "A String", # The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).
+ },
+ "maintenanceWindow": { # Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes. # The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes.
+ "day": 42, # day of week (1-7), starting on Monday.
+ "hour": 42, # hour of day - 0 to 23.
+ "kind": "A String", # This is always **sql#maintenanceWindow**.
+ "updateTrack": "A String", # Maintenance timing setting: **canary** (Earlier) or **stable** (Later). [Learn more] (https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/instance-settings#maintenance-timing-2ndgen).
+ },
+ "pricingPlan": "A String", # The pricing plan for this instance. This can be either **PER_USE** or **PACKAGE**. Only **PER_USE** is supported for Second Generation instances.
+ "replicationType": "A String", # The type of replication this instance uses. This can be either **ASYNCHRONOUS** or **SYNCHRONOUS**. (Deprecated) This property was only applicable to First Generation instances.
+ "settingsVersion": "A String", # The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.
+ "storageAutoResize": True or False, # Configuration to increase storage size automatically. The default value is true.
+ "storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.
+ "tier": "A String", # The tier (or machine type) for this instance, for example **db-custom-1-3840**.
+ "userLabels": { # User-provided labels, represented as a dictionary where each label is a single key value pair.
+ "a_key": "A String",
+ },
+ },
+ "state": "A String", # The current serving state of the Cloud SQL instance. This can be one of the following. *SQL_INSTANCE_STATE_UNSPECIFIED*: The state of the instance is unknown. *RUNNABLE*: The instance is running, or has been stopped by owner. *SUSPENDED*: The instance is not available, for example due to problems with billing. *PENDING_DELETE*: The instance is being deleted. *PENDING_CREATE*: The instance is being created. *MAINTENANCE*: The instance is down for maintenance. *FAILED*: The instance creation failed.
+ "suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension.
+ "A String",
+ ],
+}
+getConnectSettings(project, instance, readTime=None, x__xgafv=None)
+ Retrieves connect settings about a Cloud SQL instance.
+
+Args:
+ project: string, Project ID of the project that contains the instance. (required)
+ instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
+ readTime: string, Optional. Optional snapshot read timestamp to trade freshness for performance.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Connect settings retrieval response.
+ "backendType": "A String", # **SECOND_GEN**: Cloud SQL database instance. **EXTERNAL**: A database server that is not managed by Google. This property is read-only; use the **tier** property in the **settings** object to determine the database type.
+ "databaseVersion": "A String", # The database engine type and version. The **databaseVersion** field cannot be changed after instance creation. MySQL instances: **MYSQL_8_0**, **MYSQL_5_7** (default), or **MYSQL_5_6**. PostgreSQL instances: **POSTGRES_9_6**, **POSTGRES_10**, **POSTGRES_11** or **POSTGRES_12** (default). SQL Server instances: **SQLSERVER_2017_STANDARD** (default), **SQLSERVER_2017_ENTERPRISE**, **SQLSERVER_2017_EXPRESS**, or **SQLSERVER_2017_WEB**.
+ "ipAddresses": [ # The assigned IP addresses for the instance.
+ { # Database instance IP Mapping.
+ "ipAddress": "A String", # The IP address assigned.
+ "timeToRetire": "A String", # The due time for this IP to be retired in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. This field is only available when the IP is scheduled to be retired.
+ "type": "A String", # The type of this IP address. A **PRIMARY** address is a public address that can accept incoming connections. A **PRIVATE** address is a private address that can accept incoming connections. An **OUTGOING** address is the source address of connections originating from the instance, if supported.
+ },
+ ],
+ "kind": "A String", # This is always `sql#connectSettings`.
+ "serverCaCert": { # SslCerts Resource # SSL configuration.
+ "cert": "A String", # PEM representation.
+ "certSerialNumber": "A String", # Serial number, as extracted from the certificate.
+ "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+.
+ "createTime": "A String", # The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**
+ "expirationTime": "A String", # The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.
+ "instance": "A String", # Name of the database instance.
+ "kind": "A String", # This is always sql#sslCert.
+ "sha1Fingerprint": "A String", # Sha1 Fingerprint.
+ },
+}
+Creates a new backup run on demand. This method is applicable only to Second Generation instances.
list(project, instance, maxResults=None, pageToken=None, x__xgafv=None)
Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the backup initiation time.
+Lists all backup runs associated with the project or a given instance and configuration in the reverse chronological order of the backup initiation time.
list_next(previous_request, previous_response)
Retrieves the next page of results.
@@ -351,11 +351,11 @@list(project, instance, maxResults=None, pageToken=None, x__xgafv=None)
- Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the backup initiation time. +Lists all backup runs associated with the project or a given instance and configuration in the reverse chronological order of the backup initiation time. Args: project: string, Project ID of the project that contains the instance. (required) - instance: string, Cloud SQL instance ID. This does not include the project ID. (required) + instance: string, Cloud SQL instance ID, or "-" for all instances. This does not include the project ID. (required) maxResults: integer, Maximum number of backup runs per response. pageToken: string, A previously-returned page token representing part of the larger set of results to view. x__xgafv: string, V1 error format. diff --git a/docs/dyn/sqladmin_v1beta4.connect.html b/docs/dyn/sqladmin_v1beta4.connect.html new file mode 100644 index 00000000000..afd10a491fa --- /dev/null +++ b/docs/dyn/sqladmin_v1beta4.connect.html @@ -0,0 +1,172 @@ + + + +Cloud SQL Admin API . connect
+Instance Methods
++
+close()Close httplib2 connections.
++
+generateEphemeralCert(project, instance, body=None, x__xgafv=None)Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.
++
+get(project, instance, readTime=None, x__xgafv=None)Retrieves connect settings about a Cloud SQL instance.
+Method Details
+++ +close()+Close httplib2 connections.+++ +generateEphemeralCert(project, instance, body=None, x__xgafv=None)+Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database. + +Args: + project: string, Project ID of the project that contains the instance. (required) + instance: string, Cloud SQL instance ID. This does not include the project ID. (required) + body: object, The request body. + The object takes the form of: + +{ # Ephemeral certificate creation request. + "access_token": "A String", # Optional. Access token to include in the signed certificate. + "public_key": "A String", # PEM encoded public key to include in the signed certificate. + "readTime": "A String", # Optional. Optional snapshot read timestamp to trade freshness for performance. +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Ephemeral certificate creation request. + "ephemeralCert": { # SslCerts Resource # Generated cert + "cert": "A String", # PEM representation. + "certSerialNumber": "A String", # Serial number, as extracted from the certificate. + "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+. + "createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example *2012-11-15T16:19:00.094Z* + "expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*. + "instance": "A String", # Name of the database instance. + "kind": "A String", # This is always *sql#sslCert*. + "selfLink": "A String", # The URI of this resource. + "sha1Fingerprint": "A String", # Sha1 Fingerprint. + }, +}+++ + \ No newline at end of file diff --git a/docs/dyn/sqladmin_v1beta4.html b/docs/dyn/sqladmin_v1beta4.html index 9d0a7a458e1..cd707003e65 100644 --- a/docs/dyn/sqladmin_v1beta4.html +++ b/docs/dyn/sqladmin_v1beta4.html @@ -79,6 +79,11 @@get(project, instance, readTime=None, x__xgafv=None)+Retrieves connect settings about a Cloud SQL instance. + +Args: + project: string, Project ID of the project that contains the instance. (required) + instance: string, Cloud SQL instance ID. This does not include the project ID. (required) + readTime: string, Optional. Optional snapshot read timestamp to trade freshness for performance. + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Connect settings retrieval response. + "backendType": "A String", # **SECOND_GEN**: Cloud SQL database instance. **EXTERNAL**: A database server that is not managed by Google. This property is read-only; use the **tier** property in the **settings** object to determine the database type. + "databaseVersion": "A String", # The database engine type and version. The **databaseVersion** field cannot be changed after instance creation. MySQL instances: **MYSQL_8_0**, **MYSQL_5_7** (default), or **MYSQL_5_6**. PostgreSQL instances: **POSTGRES_9_6**, **POSTGRES_10**, **POSTGRES_11** or **POSTGRES_12** (default). SQL Server instances: **SQLSERVER_2017_STANDARD** (default), **SQLSERVER_2017_ENTERPRISE**, **SQLSERVER_2017_EXPRESS**, or **SQLSERVER_2017_WEB**. + "ipAddresses": [ # The assigned IP addresses for the instance. + { # Database instance IP Mapping. + "ipAddress": "A String", # The IP address assigned. + "timeToRetire": "A String", # The due time for this IP to be retired in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*. This field is only available when the IP is scheduled to be retired. + "type": "A String", # The type of this IP address. A *PRIMARY* address is a public address that can accept incoming connections. A *PRIVATE* address is a private address that can accept incoming connections. An *OUTGOING* address is the source address of connections originating from the instance, if supported. + }, + ], + "kind": "A String", # This is always `sql#connectSettings`. + "serverCaCert": { # SslCerts Resource # SSL configuration. + "cert": "A String", # PEM representation. + "certSerialNumber": "A String", # Serial number, as extracted from the certificate. + "commonName": "A String", # User supplied name. Constrained to [a-zA-Z.-_ ]+. + "createTime": "A String", # The time when the certificate was created in RFC 3339 format, for example *2012-11-15T16:19:00.094Z* + "expirationTime": "A String", # The time when the certificate expires in RFC 3339 format, for example *2012-11-15T16:19:00.094Z*. + "instance": "A String", # Name of the database instance. + "kind": "A String", # This is always *sql#sslCert*. + "selfLink": "A String", # The URI of this resource. + "sha1Fingerprint": "A String", # Sha1 Fingerprint. + }, +}+Instance Methods
Returns the backupRuns Resource.
++
+connect()+Returns the connect Resource.
+ diff --git a/docs/dyn/sqladmin_v1beta4.instances.html b/docs/dyn/sqladmin_v1beta4.instances.html index cb13f5d9fb2..051036d52a0 100644 --- a/docs/dyn/sqladmin_v1beta4.instances.html +++ b/docs/dyn/sqladmin_v1beta4.instances.html @@ -250,7 +250,7 @@Method Details
"destinationInstanceName": "A String", # Name of the Cloud SQL instance to be created as a clone. "kind": "A String", # This is always *sql#cloneContext*. "pitrTimestampMs": "A String", # Reserved for future use. - "pointInTime": "A String", # Reserved for future use. + "pointInTime": "A String", # Timestamp, if specified, identifies the time to which the source instance is cloned. }, } @@ -829,6 +829,7 @@Method Details
"scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance. "canDefer": True or False, "canReschedule": True or False, # If the scheduled maintenance can be rescheduled. + "scheduleDeadlineTime": "A String", # Maintenance cannot be rescheduled to start beyond this deadline. "startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance. }, "secondaryGceZone": "A String", # The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. Reserved for future use. @@ -864,7 +865,7 @@Method Details
"enabled": True or False, # Whether this configuration is enabled. "kind": "A String", # This is always *sql#backupConfiguration*. "location": "A String", # Location of the backup - "pointInTimeRecoveryEnabled": True or False, # Reserved for future use. + "pointInTimeRecoveryEnabled": True or False, # (Postgres only) Whether point in time recovery is enabled. "replicationLogArchivingEnabled": True or False, # Reserved for future use. "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - *HH:MM*. "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. @@ -1131,6 +1132,7 @@Method Details
"scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance. "canDefer": True or False, "canReschedule": True or False, # If the scheduled maintenance can be rescheduled. + "scheduleDeadlineTime": "A String", # Maintenance cannot be rescheduled to start beyond this deadline. "startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance. }, "secondaryGceZone": "A String", # The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. Reserved for future use. @@ -1166,7 +1168,7 @@Method Details
"enabled": True or False, # Whether this configuration is enabled. "kind": "A String", # This is always *sql#backupConfiguration*. "location": "A String", # Location of the backup - "pointInTimeRecoveryEnabled": True or False, # Reserved for future use. + "pointInTimeRecoveryEnabled": True or False, # (Postgres only) Whether point in time recovery is enabled. "replicationLogArchivingEnabled": True or False, # Reserved for future use. "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - *HH:MM*. "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. @@ -1409,6 +1411,7 @@Method Details
"scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance. "canDefer": True or False, "canReschedule": True or False, # If the scheduled maintenance can be rescheduled. + "scheduleDeadlineTime": "A String", # Maintenance cannot be rescheduled to start beyond this deadline. "startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance. }, "secondaryGceZone": "A String", # The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. Reserved for future use. @@ -1444,7 +1447,7 @@Method Details
"enabled": True or False, # Whether this configuration is enabled. "kind": "A String", # This is always *sql#backupConfiguration*. "location": "A String", # Location of the backup - "pointInTimeRecoveryEnabled": True or False, # Reserved for future use. + "pointInTimeRecoveryEnabled": True or False, # (Postgres only) Whether point in time recovery is enabled. "replicationLogArchivingEnabled": True or False, # Reserved for future use. "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - *HH:MM*. "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. @@ -1659,6 +1662,7 @@Method Details
"scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance. "canDefer": True or False, "canReschedule": True or False, # If the scheduled maintenance can be rescheduled. + "scheduleDeadlineTime": "A String", # Maintenance cannot be rescheduled to start beyond this deadline. "startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance. }, "secondaryGceZone": "A String", # The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. Reserved for future use. @@ -1694,7 +1698,7 @@Method Details
"enabled": True or False, # Whether this configuration is enabled. "kind": "A String", # This is always *sql#backupConfiguration*. "location": "A String", # Location of the backup - "pointInTimeRecoveryEnabled": True or False, # Reserved for future use. + "pointInTimeRecoveryEnabled": True or False, # (Postgres only) Whether point in time recovery is enabled. "replicationLogArchivingEnabled": True or False, # Reserved for future use. "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - *HH:MM*. "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. @@ -2648,6 +2652,7 @@Method Details
"scheduledMaintenance": { # Any scheduled maintenancce for this instance. # The start time of any upcoming scheduled maintenance for this instance. "canDefer": True or False, "canReschedule": True or False, # If the scheduled maintenance can be rescheduled. + "scheduleDeadlineTime": "A String", # Maintenance cannot be rescheduled to start beyond this deadline. "startTime": "A String", # The start time of any upcoming scheduled maintenance for this instance. }, "secondaryGceZone": "A String", # The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. Reserved for future use. @@ -2683,7 +2688,7 @@Method Details
"enabled": True or False, # Whether this configuration is enabled. "kind": "A String", # This is always *sql#backupConfiguration*. "location": "A String", # Location of the backup - "pointInTimeRecoveryEnabled": True or False, # Reserved for future use. + "pointInTimeRecoveryEnabled": True or False, # (Postgres only) Whether point in time recovery is enabled. "replicationLogArchivingEnabled": True or False, # Reserved for future use. "startTime": "A String", # Start time for the daily backup configuration in UTC timezone in the 24 hour format - *HH:MM*. "transactionLogRetentionDays": 42, # The number of days of transaction logs we retain for point in time restore, from 1-7. diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1.json b/googleapiclient/discovery_cache/documents/sqladmin.v1.json new file mode 100644 index 00000000000..3efd399d396 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/sqladmin.v1.json @@ -0,0 +1,1518 @@ +{ + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "See, edit, configure, and delete your Google Cloud Platform data" + }, + "https://www.googleapis.com/auth/sqlservice.admin": { + "description": "Manage your Google SQL Service instances" + } + } + } + }, + "basePath": "", + "baseUrl": "https://sqladmin.googleapis.com/", + "batchPath": "batch", + "canonicalName": "SQL Admin", + "description": "API for Cloud SQL database instance management", + "discoveryVersion": "v1", + "documentationLink": "https://developers.google.com/cloud-sql/", + "fullyEncodeReservedExpansion": true, + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "id": "sqladmin:v1", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://sqladmin.mtls.googleapis.com/", + "name": "sqladmin", + "ownerDomain": "google.com", + "ownerName": "Google", + "parameters": { + "$.xgafv": { + "description": "V1 error format.", + "enum": [ + "1", + "2" + ], + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "location": "query", + "type": "string" + }, + "alt": { + "default": "json", + "description": "Data format for response.", + "enum": [ + "json", + "media", + "proto" + ], + "enumDescriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ], + "location": "query", + "type": "string" + }, + "callback": { + "description": "JSONP", + "location": "query", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "location": "query", + "type": "string" + }, + "key": { + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", + "location": "query", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "location": "query", + "type": "string" + }, + "prettyPrint": { + "default": "true", + "description": "Returns response with indentations and line breaks.", + "location": "query", + "type": "boolean" + }, + "quotaUser": { + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", + "location": "query", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "location": "query", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "location": "query", + "type": "string" + } + }, + "protocol": "rest", + "resources": { + "instances": { + "methods": { + "list": { + "description": "Lists instances under a given project.", + "flatPath": "v1/projects/{project}/instances", + "httpMethod": "GET", + "id": "sqladmin.instances.list", + "parameterOrder": [ + "project" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. The expression is in the form of field:value. For example, 'instanceType:CLOUD_SQL_INSTANCE'. Fields can be nested as needed as per their JSON representation, such as 'settings.userLabels.auto_start:true'. Multiple filter queries are space-separated. For example. 'state:RUNNABLE instanceType:CLOUD_SQL_INSTANCE'. By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly.", + "location": "query", + "type": "string" + }, + "maxResults": { + "description": "The maximum number of results to return per response.", + "format": "uint32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A previously-returned page token representing part of the larger set of results to view.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID of the project for which to list Cloud SQL instances.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/projects/{project}/instances", + "response": { + "$ref": "InstancesListResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sqlservice.admin" + ] + } + } + }, + "projects": { + "resources": { + "instances": { + "methods": { + "generateEphemeralCert": { + "description": "Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.", + "flatPath": "v1/projects/{project}/instances/{instance}:generateEphemeralCert", + "httpMethod": "POST", + "id": "sqladmin.projects.instances.generateEphemeralCert", + "parameterOrder": [ + "project", + "instance" + ], + "parameters": { + "instance": { + "description": "Cloud SQL 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.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/projects/{project}/instances/{instance}:generateEphemeralCert", + "request": { + "$ref": "GenerateEphemeralCertRequest" + }, + "response": { + "$ref": "GenerateEphemeralCertResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sqlservice.admin" + ] + }, + "get": { + "description": "Retrieves a resource containing information about a Cloud SQL instance.", + "flatPath": "v1/projects/{project}/instances/{instance}", + "httpMethod": "GET", + "id": "sqladmin.projects.instances.get", + "parameterOrder": [ + "project", + "instance" + ], + "parameters": { + "instance": { + "description": "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.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/projects/{project}/instances/{instance}", + "response": { + "$ref": "DatabaseInstance" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sqlservice.admin" + ] + }, + "getConnectSettings": { + "description": "Retrieves connect settings about a Cloud SQL instance.", + "flatPath": "v1/projects/{project}/instances/{instance}/connectSettings", + "httpMethod": "GET", + "id": "sqladmin.projects.instances.getConnectSettings", + "parameterOrder": [ + "project", + "instance" + ], + "parameters": { + "instance": { + "description": "Cloud SQL 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.", + "location": "path", + "required": true, + "type": "string" + }, + "readTime": { + "description": "Optional. Optional snapshot read timestamp to trade freshness for performance.", + "format": "google-datetime", + "location": "query", + "type": "string" + } + }, + "path": "v1/projects/{project}/instances/{instance}/connectSettings", + "response": { + "$ref": "ConnectSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sqlservice.admin" + ] + } + }, + "resources": { + "createEphemeral": { + "methods": { + "create": { + "description": "Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.", + "flatPath": "v1/projects/{project}/instances/{instance}/createEphemeral", + "httpMethod": "POST", + "id": "sqladmin.projects.instances.createEphemeral.create", + "parameterOrder": [ + "project", + "instance" + ], + "parameters": { + "instance": { + "description": "Cloud SQL instance ID. This does not include the project ID.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID of the Cloud SQL project.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/projects/{project}/instances/{instance}/createEphemeral", + "request": { + "$ref": "SslCertsCreateEphemeralRequest" + }, + "response": { + "$ref": "SslCert" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sqlservice.admin" + ] + } + } + } + } + } + } + } + }, + "revision": "20210627", + "rootUrl": "https://sqladmin.googleapis.com/", + "schemas": { + "AclEntry": { + "description": "An entry for an Access Control list.", + "id": "AclEntry", + "properties": { + "expirationTime": { + "description": "The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.", + "format": "google-datetime", + "type": "string" + }, + "kind": { + "description": "This is always **sql#aclEntry**.", + "type": "string" + }, + "name": { + "description": "Optional. A label to identify this entry.", + "type": "string" + }, + "value": { + "description": "The allowlisted value for the access control list.", + "type": "string" + } + }, + "type": "object" + }, + "ApiWarning": { + "description": "An Admin API warning message.", + "id": "ApiWarning", + "properties": { + "code": { + "description": "Code to uniquely identify the warning type.", + "enum": [ + "SQL_API_WARNING_CODE_UNSPECIFIED", + "REGION_UNREACHABLE" + ], + "enumDescriptions": [ + "An unknown or unset warning type from Cloud SQL API.", + "Warning when one or more regions are not reachable. The returned result set may be incomplete." + ], + "type": "string" + }, + "message": { + "description": "The warning message.", + "type": "string" + }, + "region": { + "description": "The region name for REGION_UNREACHABLE warning.", + "type": "string" + } + }, + "type": "object" + }, + "BackupConfiguration": { + "description": "Database instance backup configuration.", + "id": "BackupConfiguration", + "properties": { + "backupRetentionSettings": { + "$ref": "BackupRetentionSettings", + "description": "Backup retention settings." + }, + "binaryLogEnabled": { + "description": "(MySQL only) Whether binary log is enabled. If backup configuration is disabled, binarylog must be disabled as well.", + "type": "boolean" + }, + "enabled": { + "description": "Whether this configuration is enabled.", + "type": "boolean" + }, + "kind": { + "description": "This is always **sql#backupConfiguration**.", + "type": "string" + }, + "location": { + "description": "Location of the backup", + "type": "string" + }, + "pointInTimeRecoveryEnabled": { + "description": "(Postgres only) Whether point in time recovery is enabled.", + "type": "boolean" + }, + "replicationLogArchivingEnabled": { + "description": "Reserved for future use.", + "type": "boolean" + }, + "startTime": { + "description": "Start time for the daily backup configuration in UTC timezone in the 24 hour format - **HH:MM**.", + "type": "string" + }, + "transactionLogRetentionDays": { + "description": "The number of days of transaction logs we retain for point in time restore, from 1-7.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "BackupRetentionSettings": { + "description": "We currently only support backup retention by specifying the number of backups we will retain.", + "id": "BackupRetentionSettings", + "properties": { + "retainedBackups": { + "description": "Depending on the value of retention_unit, this is used to determine if a backup needs to be deleted. If retention_unit is 'COUNT', we will retain this many backups.", + "format": "int32", + "type": "integer" + }, + "retentionUnit": { + "description": "The unit that 'retained_backups' represents.", + "enum": [ + "RETENTION_UNIT_UNSPECIFIED", + "COUNT" + ], + "enumDescriptions": [ + "Backup retention unit is unspecified, will be treated as COUNT.", + "Retention will be by count, eg. \"retain the most recent 7 backups\"." + ], + "type": "string" + } + }, + "type": "object" + }, + "ConnectSettings": { + "description": "Connect settings retrieval response.", + "id": "ConnectSettings", + "properties": { + "backendType": { + "description": "**SECOND_GEN**: Cloud SQL database instance. **EXTERNAL**: A database server that is not managed by Google. This property is read-only; use the **tier** property in the **settings** object to determine the database type.", + "enum": [ + "SQL_BACKEND_TYPE_UNSPECIFIED", + "FIRST_GEN", + "SECOND_GEN", + "EXTERNAL" + ], + "enumDescriptions": [ + "This is an unknown backend type for instance.", + "V1 speckle instance.", + "V2 speckle instance.", + "On premises instance." + ], + "type": "string" + }, + "databaseVersion": { + "description": "The database engine type and version. The **databaseVersion** field cannot be changed after instance creation. MySQL instances: **MYSQL_8_0**, **MYSQL_5_7** (default), or **MYSQL_5_6**. PostgreSQL instances: **POSTGRES_9_6**, **POSTGRES_10**, **POSTGRES_11** or **POSTGRES_12** (default). SQL Server instances: **SQLSERVER_2017_STANDARD** (default), **SQLSERVER_2017_ENTERPRISE**, **SQLSERVER_2017_EXPRESS**, or **SQLSERVER_2017_WEB**.", + "enum": [ + "SQL_DATABASE_VERSION_UNSPECIFIED", + "MYSQL_5_1", + "MYSQL_5_5", + "MYSQL_5_6", + "MYSQL_5_7", + "POSTGRES_9_6", + "POSTGRES_11", + "SQLSERVER_2017_STANDARD", + "SQLSERVER_2017_ENTERPRISE", + "SQLSERVER_2017_EXPRESS", + "SQLSERVER_2017_WEB", + "POSTGRES_10", + "POSTGRES_12", + "POSTGRES_13", + "SQLSERVER_2019_STANDARD", + "SQLSERVER_2019_ENTERPRISE", + "SQLSERVER_2019_EXPRESS", + "SQLSERVER_2019_WEB" + ], + "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 PostgreSQL 9.6.", + "The database version is PostgreSQL 11.", + "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 10.", + "The database version is PostgreSQL 12.", + "The database version is PostgreSQL 13.", + "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." + ], + "type": "string" + }, + "ipAddresses": { + "description": "The assigned IP addresses for the instance.", + "items": { + "$ref": "IpMapping" + }, + "type": "array" + }, + "kind": { + "description": "This is always `sql#connectSettings`.", + "type": "string" + }, + "serverCaCert": { + "$ref": "SslCert", + "description": "SSL configuration." + } + }, + "type": "object" + }, + "DatabaseFlags": { + "description": "Database flags for Cloud SQL instances.", + "id": "DatabaseFlags", + "properties": { + "name": { + "description": "The name of the flag. These flags are passed at instance startup, so include both server options and system variables for MySQL. Flags are specified with underscores, not hyphens. For more information, see [Configuring Database Flags](/sql/docs/mysql/flags) in the Cloud SQL documentation.", + "type": "string" + }, + "value": { + "description": "The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value.", + "type": "string" + } + }, + "type": "object" + }, + "DatabaseInstance": { + "description": "A Cloud SQL instance resource.", + "id": "DatabaseInstance", + "properties": { + "backendType": { + "description": " *SECOND_GEN*: Cloud SQL database instance. *EXTERNAL*: A database server that is not managed by Google. This property is read-only; use the *tier* property in the *settings* object to determine the database type.", + "enum": [ + "SQL_BACKEND_TYPE_UNSPECIFIED", + "FIRST_GEN", + "SECOND_GEN", + "EXTERNAL" + ], + "enumDescriptions": [ + "This is an unknown backend type for instance.", + "V1 speckle instance.", + "V2 speckle instance.", + "On premises instance." + ], + "type": "string" + }, + "connectionName": { + "description": "Connection name of the Cloud SQL instance used in connection strings.", + "type": "string" + }, + "currentDiskSize": { + "description": "The current disk usage of the instance in bytes. This property has been deprecated. Use the \"cloudsql.googleapis.com/database/disk/bytes_used\" metric in Cloud Monitoring API instead. Please see this announcement for details.", + "format": "int64", + "type": "string" + }, + "databaseVersion": { + "description": "The database engine type and version. The *databaseVersion* field cannot be changed after instance creation. MySQL instances: *MYSQL_8_0*, *MYSQL_5_7* (default), or *MYSQL_5_6*. PostgreSQL instances: *POSTGRES_9_6*, *POSTGRES_10*, *POSTGRES_11*, *POSTGRES_12*, or *POSTGRES_13* (default). SQL Server instances: *SQLSERVER_2017_STANDARD* (default), *SQLSERVER_2017_ENTERPRISE*, *SQLSERVER_2017_EXPRESS*, or *SQLSERVER_2017_WEB*.", + "enum": [ + "SQL_DATABASE_VERSION_UNSPECIFIED", + "MYSQL_5_1", + "MYSQL_5_5", + "MYSQL_5_6", + "MYSQL_5_7", + "POSTGRES_9_6", + "POSTGRES_11", + "SQLSERVER_2017_STANDARD", + "SQLSERVER_2017_ENTERPRISE", + "SQLSERVER_2017_EXPRESS", + "SQLSERVER_2017_WEB", + "POSTGRES_10", + "POSTGRES_12", + "POSTGRES_13", + "SQLSERVER_2019_STANDARD", + "SQLSERVER_2019_ENTERPRISE", + "SQLSERVER_2019_EXPRESS", + "SQLSERVER_2019_WEB" + ], + "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 PostgreSQL 9.6.", + "The database version is PostgreSQL 11.", + "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 10.", + "The database version is PostgreSQL 12.", + "The database version is PostgreSQL 13.", + "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." + ], + "type": "string" + }, + "diskEncryptionConfiguration": { + "$ref": "DiskEncryptionConfiguration", + "description": "Disk encryption configuration specific to an instance. Applies only to Second Generation instances." + }, + "diskEncryptionStatus": { + "$ref": "DiskEncryptionStatus", + "description": "Disk encryption status specific to an instance. Applies only to Second Generation instances." + }, + "encryptedRootPassword": { + "description": "For internal usage only. The encrypted password.", + "format": "byte", + "type": "string" + }, + "etag": { + "description": "This field is deprecated and will be removed from a future version of the API. Use the *settings.settingsVersion* field instead.", + "type": "string" + }, + "failoverReplica": { + "description": "The name and status of the failover replica. This property is applicable only to Second Generation instances.", + "properties": { + "available": { + "description": "The availability status of the failover replica. A false status indicates that the failover replica is out of sync. The primary instance can only failover to the failover replica when the status is true.", + "type": "boolean" + }, + "failoverInstance": { + "$ref": "InstanceReference", + "description": "A reference to the failover replica. If specified at instance creation, a failover replica is created for the instance. Currently, the failover replica can only be created in the same region as the primary instance." + }, + "name": { + "description": "The name of the failover replica. If specified at instance creation, a failover replica is created for the instance. The name doesn't include the project ID. This property is applicable only to Second Generation instances.", + "type": "string" + } + }, + "type": "object" + }, + "gceZone": { + "description": "The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone.", + "type": "string" + }, + "installedVersion": { + "description": "installed_version stores the current fully resolved database version including minor version such as MySQL_5.6.50", + "enum": [ + "SQL_DATABASE_VERSION_UNSPECIFIED", + "MYSQL_5_1", + "MYSQL_5_5", + "MYSQL_5_6", + "MYSQL_5_7", + "POSTGRES_9_6", + "POSTGRES_11", + "SQLSERVER_2017_STANDARD", + "SQLSERVER_2017_ENTERPRISE", + "SQLSERVER_2017_EXPRESS", + "SQLSERVER_2017_WEB", + "POSTGRES_10", + "POSTGRES_12", + "POSTGRES_13", + "SQLSERVER_2019_STANDARD", + "SQLSERVER_2019_ENTERPRISE", + "SQLSERVER_2019_EXPRESS", + "SQLSERVER_2019_WEB" + ], + "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 PostgreSQL 9.6.", + "The database version is PostgreSQL 11.", + "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 10.", + "The database version is PostgreSQL 12.", + "The database version is PostgreSQL 13.", + "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." + ], + "type": "string" + }, + "instanceType": { + "description": "The instance type. This can be one of the following. *CLOUD_SQL_INSTANCE*: A Cloud SQL instance that is not replicating from a primary instance. *ON_PREMISES_INSTANCE*: An instance running on the customer's premises. *READ_REPLICA_INSTANCE*: A Cloud SQL instance configured as a read-replica.", + "enum": [ + "SQL_INSTANCE_TYPE_UNSPECIFIED", + "CLOUD_SQL_INSTANCE", + "ON_PREMISES_INSTANCE", + "READ_REPLICA_INSTANCE" + ], + "enumDescriptions": [ + "This is an unknown Cloud SQL instance type.", + "A regular Cloud SQL instance.", + "An instance running on the customer's premises that is not managed by Cloud SQL.", + "A Cloud SQL instance acting as a read-replica." + ], + "type": "string" + }, + "instanceUid": { + "description": "Uid of the Cloud SQL instance. Used by Pantheon to check instance is created", + "type": "string" + }, + "ipAddresses": { + "description": "The assigned IP addresses for the instance.", + "items": { + "$ref": "IpMapping" + }, + "type": "array" + }, + "ipv6Address": { + "description": "The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances.", + "type": "string" + }, + "kind": { + "description": "This is always *sql#instance*.", + "type": "string" + }, + "masterInstance": { + "$ref": "InstanceReference", + "description": "The reference to the instance which will act as primary in the replication setup." + }, + "masterInstanceName": { + "description": "The name of the instance which will act as primary in the replication setup.", + "type": "string" + }, + "maxDiskSize": { + "description": "The maximum disk size of the instance in bytes.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Name of the Cloud SQL instance. This does not include the project ID.", + "type": "string" + }, + "onPremisesConfiguration": { + "$ref": "OnPremisesConfiguration", + "description": "Configuration specific to on-premises instances." + }, + "outOfDiskReport": { + "$ref": "SqlOutOfDiskReport", + "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 Pantheon frontend -- the proactive database wellness job" + }, + "project": { + "description": "The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable.", + "type": "string" + }, + "region": { + "description": "The geographical region. Can be *us-central* (*FIRST_GEN* instances only) *us-central1* (*SECOND_GEN* instances only) *asia-east1* or *europe-west1*. Defaults to *us-central* or *us-central1* depending on the instance type. The region cannot be changed after instance creation.", + "type": "string" + }, + "replicaConfiguration": { + "$ref": "ReplicaConfiguration", + "description": "Configuration specific to failover replicas and read replicas." + }, + "replicaInstances": { + "description": "The replicas of the instance.", + "items": { + "$ref": "InstanceReference" + }, + "type": "array" + }, + "replicaNames": { + "description": "The replicas of the instance.", + "items": { + "type": "string" + }, + "type": "array" + }, + "rootPassword": { + "description": "Initial root password. Use only on creation.", + "type": "string" + }, + "satisfiesPzs": { + "description": "The status indicating if instance satisfiesPzs. Reserved for future use.", + "type": "boolean" + }, + "scheduledMaintenance": { + "$ref": "SqlScheduledMaintenance", + "description": "The start time of any upcoming scheduled maintenance for this instance." + }, + "secondaryGceZone": { + "description": "The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. Reserved for future use.", + "type": "string" + }, + "selfLink": { + "description": "The URI of this resource.", + "type": "string" + }, + "serverCaCert": { + "$ref": "SslCert", + "description": "SSL configuration." + }, + "serviceAccountEmailAddress": { + "description": "The service account email address assigned to the instance. This property is read-only.", + "type": "string" + }, + "settings": { + "$ref": "Settings", + "description": "The user settings." + }, + "state": { + "description": "The current serving state of the Cloud SQL instance. This can be one of the following. *SQL_INSTANCE_STATE_UNSPECIFIED*: The state of the instance is unknown. *RUNNABLE*: The instance is running, or has been stopped by owner. *SUSPENDED*: The instance is not available, for example due to problems with billing. *PENDING_DELETE*: The instance is being deleted. *PENDING_CREATE*: The instance is being created. *MAINTENANCE*: The instance is down for maintenance. *FAILED*: The instance creation failed.", + "enum": [ + "SQL_INSTANCE_STATE_UNSPECIFIED", + "RUNNABLE", + "SUSPENDED", + "PENDING_DELETE", + "PENDING_CREATE", + "MAINTENANCE", + "FAILED" + ], + "enumDescriptions": [ + "The state of the instance is unknown.", + "The instance is running, or has been stopped by owner.", + "The instance is not available, for example due to problems with billing.", + "The instance is being deleted.", + "The instance is being created.", + "The instance is down for maintenance.", + "The creation of the instance failed or a fatal error occurred during maintenance." + ], + "type": "string" + }, + "suspensionReason": { + "description": "If the instance state is SUSPENDED, the reason for the suspension.", + "items": { + "enum": [ + "SQL_SUSPENSION_REASON_UNSPECIFIED", + "BILLING_ISSUE", + "LEGAL_ISSUE", + "OPERATIONAL_ISSUE", + "KMS_KEY_ISSUE" + ], + "enumDescriptions": [ + "This is an unknown suspension reason.", + "The instance is suspended due to billing issues (for example:, GCP account issue)", + "The instance is suspended due to illegal content (for example:, child pornography, copyrighted material, etc.).", + "The instance is causing operational issues (for example:, causing the database to crash).", + "The KMS key used by the instance is either revoked or denied access to" + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "DenyMaintenancePeriod": { + "description": "Deny maintenance Periods. This specifies a date range during when all CSA rollout will be denied.", + "id": "DenyMaintenancePeriod", + "properties": { + "endDate": { + "description": "\"deny maintenance period\" end date. If the year of the end date is empty, the year of the start date also must be empty. In this case, it means the no maintenance interval recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01", + "type": "string" + }, + "startDate": { + "description": "\"deny maintenance period\" start date. If the year of the start date is empty, the year of the end date also must be empty. In this case, it means the no maintenance interval recurs every year. The date is in format yyyy-mm-dd i.e., 2020-11-01, or mm-dd, i.e., 11-01", + "type": "string" + }, + "time": { + "description": "Time in UTC when the \"deny maintenance period\" starts on start_date and ends on end_date. The time is in format: HH:mm:SS, i.e., 00:00:00", + "type": "string" + } + }, + "type": "object" + }, + "DiskEncryptionConfiguration": { + "description": "Disk encryption configuration for an instance.", + "id": "DiskEncryptionConfiguration", + "properties": { + "kind": { + "description": "This is always **sql#diskEncryptionConfiguration**.", + "type": "string" + }, + "kmsKeyName": { + "description": "Resource name of KMS key for disk encryption", + "type": "string" + } + }, + "type": "object" + }, + "DiskEncryptionStatus": { + "description": "Disk encryption status for an instance.", + "id": "DiskEncryptionStatus", + "properties": { + "kind": { + "description": "This is always **sql#diskEncryptionStatus**.", + "type": "string" + }, + "kmsKeyVersionName": { + "description": "KMS key version used to encrypt the Cloud SQL instance resource", + "type": "string" + } + }, + "type": "object" + }, + "GenerateEphemeralCertRequest": { + "description": "Ephemeral certificate creation request.", + "id": "GenerateEphemeralCertRequest", + "properties": { + "access_token": { + "description": "Optional. Access token to include in the signed certificate.", + "type": "string" + }, + "public_key": { + "description": "PEM encoded public key to include in the signed certificate.", + "type": "string" + }, + "readTime": { + "description": "Optional. Optional snapshot read timestamp to trade freshness for performance.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GenerateEphemeralCertResponse": { + "description": "Ephemeral certificate creation request.", + "id": "GenerateEphemeralCertResponse", + "properties": { + "ephemeralCert": { + "$ref": "SslCert", + "description": "Generated cert" + } + }, + "type": "object" + }, + "InsightsConfig": { + "description": "Insights configuration. This specifies when Cloud SQL Insights feature is enabled and optional configuration.", + "id": "InsightsConfig", + "properties": { + "queryInsightsEnabled": { + "description": "Whether Query Insights feature is enabled.", + "type": "boolean" + }, + "queryPlansPerMinute": { + "description": "Number of query plans generated by Insights per minute. Default is 5. Changing this will restart the database.", + "format": "int32", + "type": "integer" + }, + "queryStringLength": { + "description": "Maximum query length stored in bytes. Default value: 1024 bytes. Range: 256-4500 bytes. Query length more than this field value will be truncated to this value. When unset, query length will be the default value. Changing query length will restart the database.", + "format": "int32", + "type": "integer" + }, + "recordApplicationTags": { + "description": "Whether Query Insights will record application tags from query when enabled.", + "type": "boolean" + }, + "recordClientAddress": { + "description": "Whether Query Insights will record client address when enabled.", + "type": "boolean" + } + }, + "type": "object" + }, + "InstanceReference": { + "description": "Reference to another Cloud SQL instance.", + "id": "InstanceReference", + "properties": { + "name": { + "description": "The name of the Cloud SQL instance being referenced.", + "type": "string" + }, + "region": { + "description": "The region of the Cloud SQL instance being referenced.", + "type": "string" + } + }, + "type": "object" + }, + "InstancesListResponse": { + "description": "Database instances list response.", + "id": "InstancesListResponse", + "properties": { + "items": { + "description": "List of database instance resources.", + "items": { + "$ref": "DatabaseInstance" + }, + "type": "array" + }, + "kind": { + "description": "This is always *sql#instancesList*.", + "type": "string" + }, + "nextPageToken": { + "description": "The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.", + "type": "string" + }, + "warnings": { + "description": "List of warnings that occurred while handling the request.", + "items": { + "$ref": "ApiWarning" + }, + "type": "array" + } + }, + "type": "object" + }, + "IpConfiguration": { + "description": "IP Management configuration.", + "id": "IpConfiguration", + "properties": { + "authorizedNetworks": { + "description": "The list of external networks that are allowed to connect to the instance using the IP. In 'CIDR' notation, also known as 'slash' notation (for example: **192.168.100.0/24**).", + "items": { + "$ref": "AclEntry" + }, + "type": "array" + }, + "ipv4Enabled": { + "description": "Whether the instance is assigned a public IP address or not.", + "type": "boolean" + }, + "privateNetwork": { + "description": "The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, **/projects/myProject/global/networks/default**. This setting can be updated, but it cannot be removed after it is set.", + "type": "string" + }, + "requireSsl": { + "description": "Whether SSL connections over IP are enforced or not.", + "type": "boolean" + } + }, + "type": "object" + }, + "IpMapping": { + "description": "Database instance IP Mapping.", + "id": "IpMapping", + "properties": { + "ipAddress": { + "description": "The IP address assigned.", + "type": "string" + }, + "timeToRetire": { + "description": "The due time for this IP to be retired in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**. This field is only available when the IP is scheduled to be retired.", + "format": "google-datetime", + "type": "string" + }, + "type": { + "description": "The type of this IP address. A **PRIMARY** address is a public address that can accept incoming connections. A **PRIVATE** address is a private address that can accept incoming connections. An **OUTGOING** address is the source address of connections originating from the instance, if supported.", + "enum": [ + "SQL_IP_ADDRESS_TYPE_UNSPECIFIED", + "PRIMARY", + "OUTGOING", + "PRIVATE", + "MIGRATED_1ST_GEN" + ], + "enumDescriptions": [ + "This is an unknown IP address type.", + "IP address the customer is supposed to connect to. Usually this is the load balancer's IP address", + "Source IP address of the connection a read replica establishes to its external primary instance. This IP address can be allowlisted by the customer in case it has a firewall that filters incoming connection to its on premises primary instance.", + "Private IP used when using private IPs and network peering.", + "V1 IP of a migrated instance. We want the user to decommission this IP as soon as the migration is complete. Note: V1 instances with V1 ip addresses will be counted as PRIMARY." + ], + "type": "string" + } + }, + "type": "object" + }, + "LocationPreference": { + "description": "Preferred location. This specifies where a Cloud SQL instance is located. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified.", + "id": "LocationPreference", + "properties": { + "kind": { + "description": "This is always **sql#locationPreference**.", + "type": "string" + }, + "secondaryZone": { + "description": "The preferred Compute Engine zone for the secondary/failover (for example: us-central1-a, us-central1-b, etc.). Reserved for future use.", + "type": "string" + }, + "zone": { + "description": "The preferred Compute Engine zone (for example: us-central1-a, us-central1-b, etc.).", + "type": "string" + } + }, + "type": "object" + }, + "MaintenanceWindow": { + "description": "Maintenance window. This specifies when a Cloud SQL instance is restarted for system maintenance purposes.", + "id": "MaintenanceWindow", + "properties": { + "day": { + "description": "day of week (1-7), starting on Monday.", + "format": "int32", + "type": "integer" + }, + "hour": { + "description": "hour of day - 0 to 23.", + "format": "int32", + "type": "integer" + }, + "kind": { + "description": "This is always **sql#maintenanceWindow**.", + "type": "string" + }, + "updateTrack": { + "description": "Maintenance timing setting: **canary** (Earlier) or **stable** (Later). [Learn more] (https://cloud.google.com/sql/docs/mysql/admin-api/rest/v1/instance-settings#maintenance-timing-2ndgen).", + "enum": [ + "SQL_UPDATE_TRACK_UNSPECIFIED", + "canary", + "stable" + ], + "enumDescriptions": [ + "This is an unknown maintenance timing preference.", + "For instance update that requires a restart, this update track indicates your instance prefer to restart for new version early in maintenance window.", + "For instance update that requires a restart, this update track indicates your instance prefer to let Cloud SQL choose the timing of restart (within its Maintenance window, if applicable)." + ], + "type": "string" + } + }, + "type": "object" + }, + "MySqlReplicaConfiguration": { + "description": "Read-replica configuration specific to MySQL databases.", + "id": "MySqlReplicaConfiguration", + "properties": { + "caCertificate": { + "description": "PEM representation of the trusted CA's x509 certificate.", + "type": "string" + }, + "clientCertificate": { + "description": "PEM representation of the replica's x509 certificate.", + "type": "string" + }, + "clientKey": { + "description": "PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.", + "type": "string" + }, + "connectRetryInterval": { + "description": "Seconds to wait between connect retries. MySQL's default is 60 seconds.", + "format": "int32", + "type": "integer" + }, + "dumpFilePath": { + "description": "Path to a SQL dump file in Google Cloud Storage from which the replica instance is to be created. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are also supported. Dumps have the binlog co-ordinates from which replication begins. This can be accomplished by setting --master-data to 1 when using mysqldump.", + "type": "string" + }, + "kind": { + "description": "This is always **sql#mysqlReplicaConfiguration**.", + "type": "string" + }, + "masterHeartbeatPeriod": { + "description": "Interval in milliseconds between replication heartbeats.", + "format": "int64", + "type": "string" + }, + "password": { + "description": "The password for the replication connection.", + "type": "string" + }, + "sslCipher": { + "description": "A list of permissible ciphers to use for SSL encryption.", + "type": "string" + }, + "username": { + "description": "The username for the replication connection.", + "type": "string" + }, + "verifyServerCertificate": { + "description": "Whether or not to check the primary instance's Common Name value in the certificate that it sends during the SSL handshake.", + "type": "boolean" + } + }, + "type": "object" + }, + "OnPremisesConfiguration": { + "description": "On-premises instance configuration.", + "id": "OnPremisesConfiguration", + "properties": { + "caCertificate": { + "description": "PEM representation of the trusted CA's x509 certificate.", + "type": "string" + }, + "clientCertificate": { + "description": "PEM representation of the replica's x509 certificate.", + "type": "string" + }, + "clientKey": { + "description": "PEM representation of the replica's private key. The corresponsing public key is encoded in the client's certificate.", + "type": "string" + }, + "dumpFilePath": { + "description": "The dump file to create the Cloud SQL replica.", + "type": "string" + }, + "hostPort": { + "description": "The host and port of the on-premises instance in host:port format", + "type": "string" + }, + "kind": { + "description": "This is always *sql#onPremisesConfiguration*.", + "type": "string" + }, + "password": { + "description": "The password for connecting to on-premises instance.", + "type": "string" + }, + "username": { + "description": "The username for connecting to on-premises instance.", + "type": "string" + } + }, + "type": "object" + }, + "ReplicaConfiguration": { + "description": "Read-replica configuration for connecting to the primary instance.", + "id": "ReplicaConfiguration", + "properties": { + "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" + }, + "kind": { + "description": "This is always *sql#replicaConfiguration*.", + "type": "string" + }, + "mysqlReplicaConfiguration": { + "$ref": "MySqlReplicaConfiguration", + "description": "MySQL specific configuration when replicating from a MySQL on-premises primary instance. Replication configuration information such as the username, password, certificates, and keys are not stored in the instance metadata.The configuration information is used only to set up the replication connection and is stored by MySQL in a file named *master.info* in the data directory." + } + }, + "type": "object" + }, + "Settings": { + "description": "Database instance settings.", + "id": "Settings", + "properties": { + "activationPolicy": { + "description": "The activation policy specifies when the instance is activated; it is applicable only when the instance state is RUNNABLE. Valid values: **ALWAYS**: The instance is on, and remains so even in the absence of connection requests. **NEVER**: The instance is off; it is not activated, even if a connection request arrives.", + "enum": [ + "SQL_ACTIVATION_POLICY_UNSPECIFIED", + "ALWAYS", + "NEVER", + "ON_DEMAND" + ], + "enumDescriptions": [ + "Unknown activation plan.", + "The instance is always up and running.", + "The instance never starts.", + "The instance starts upon receiving requests." + ], + "type": "string" + }, + "activeDirectoryConfig": { + "$ref": "SqlActiveDirectoryConfig", + "description": "Active Directory configuration, relevant only for Cloud SQL for SQL Server." + }, + "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](/sql/docs/postgres/high-availability).", + "enum": [ + "SQL_AVAILABILITY_TYPE_UNSPECIFIED", + "ZONAL", + "REGIONAL" + ], + "enumDescriptions": [ + "This is an unknown Availability type.", + "Zonal available instance.", + "Regional available instance." + ], + "type": "string" + }, + "backupConfiguration": { + "$ref": "BackupConfiguration", + "description": "The daily backup configuration for the instance." + }, + "collation": { + "description": "The name of server Instance collation.", + "type": "string" + }, + "crashSafeReplicationEnabled": { + "description": "Configuration specific to read replica instances. Indicates whether database flags for crash-safe replication are enabled. This property was only applicable to First Generation instances.", + "type": "boolean" + }, + "dataDiskSizeGb": { + "description": "The size of data disk, in GB. The data disk size minimum is 10GB.", + "format": "int64", + "type": "string" + }, + "dataDiskType": { + "description": "The type of data disk: **PD_SSD** (default) or **PD_HDD**.", + "enum": [ + "SQL_DATA_DISK_TYPE_UNSPECIFIED", + "PD_SSD", + "PD_HDD", + "OBSOLETE_LOCAL_SSD" + ], + "enumDescriptions": [ + "This is an unknown data disk type.", + "An SSD data disk.", + "An HDD data disk.", + "This field is deprecated and will be removed from a future version of the API." + ], + "type": "string" + }, + "databaseFlags": { + "description": "The database flags passed to the instance at startup.", + "items": { + "$ref": "DatabaseFlags" + }, + "type": "array" + }, + "databaseReplicationEnabled": { + "description": "Configuration specific to read replica instances. Indicates whether replication is enabled or not.", + "type": "boolean" + }, + "denyMaintenancePeriods": { + "description": "Deny maintenance periods", + "items": { + "$ref": "DenyMaintenancePeriod" + }, + "type": "array" + }, + "insightsConfig": { + "$ref": "InsightsConfig", + "description": "Insights configuration, for now relevant only for Postgres." + }, + "ipConfiguration": { + "$ref": "IpConfiguration", + "description": "The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled for Second Generation instances." + }, + "kind": { + "description": "This is always **sql#settings**.", + "type": "string" + }, + "locationPreference": { + "$ref": "LocationPreference", + "description": "The location preference settings. This allows the instance to be located as near as possible to Compute Engine zone for better performance." + }, + "maintenanceWindow": { + "$ref": "MaintenanceWindow", + "description": "The maintenance window for this instance. This specifies when the instance can be restarted for maintenance purposes." + }, + "pricingPlan": { + "description": "The pricing plan for this instance. This can be either **PER_USE** or **PACKAGE**. Only **PER_USE** is supported for Second Generation instances.", + "enum": [ + "SQL_PRICING_PLAN_UNSPECIFIED", + "PACKAGE", + "PER_USE" + ], + "enumDescriptions": [ + "This is an unknown pricing plan for this instance.", + "The instance is billed at a monthly flat rate.", + "The instance is billed per usage." + ], + "type": "string" + }, + "replicationType": { + "description": "The type of replication this instance uses. This can be either **ASYNCHRONOUS** or **SYNCHRONOUS**. (Deprecated) This property was only applicable to First Generation instances.", + "enum": [ + "SQL_REPLICATION_TYPE_UNSPECIFIED", + "SYNCHRONOUS", + "ASYNCHRONOUS" + ], + "enumDescriptions": [ + "This is an unknown replication type for a Cloud SQL instance.", + "The synchronous replication mode for First Generation instances. It is the default value.", + "The asynchronous replication mode for First Generation instances. It provides a slight performance gain, but if an outage occurs while this option is set to asynchronous, you can lose up to a few seconds of updates to your data." + ], + "type": "string" + }, + "settingsVersion": { + "description": "The version of instance settings. This is a required field for update method to make sure concurrent updates are handled properly. During update, use the most recent settingsVersion value for this instance and do not try to update this value.", + "format": "int64", + "type": "string" + }, + "storageAutoResize": { + "description": "Configuration to increase storage size automatically. The default value is true.", + "type": "boolean" + }, + "storageAutoResizeLimit": { + "description": "The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.", + "format": "int64", + "type": "string" + }, + "tier": { + "description": "The tier (or machine type) for this instance, for example **db-custom-1-3840**.", + "type": "string" + }, + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "User-provided labels, represented as a dictionary where each label is a single key value pair.", + "type": "object" + } + }, + "type": "object" + }, + "SqlActiveDirectoryConfig": { + "description": "Active Directory configuration, relevant only for Cloud SQL for SQL Server.", + "id": "SqlActiveDirectoryConfig", + "properties": { + "domain": { + "description": "The name of the domain (e.g., mydomain.com).", + "type": "string" + }, + "kind": { + "description": "This is always sql#activeDirectoryConfig.", + "type": "string" + } + }, + "type": "object" + }, + "SqlOutOfDiskReport": { + "description": "This message wraps up the information written by out-of-disk detection job.", + "id": "SqlOutOfDiskReport", + "properties": { + "sqlMinRecommendedIncreaseSizeGb": { + "description": "The minimum recommended increase size in GigaBytes This field is consumed by the frontend Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend", + "format": "int32", + "type": "integer" + }, + "sqlOutOfDiskState": { + "description": "This field represents the state generated by the proactive database wellness job for OutOfDisk issues. Writers: -- the proactive database wellness job for OOD. Readers: -- the Pantheon frontend -- the proactive database wellness job", + "enum": [ + "SQL_OUT_OF_DISK_STATE_UNSPECIFIED", + "NORMAL", + "SOFT_SHUTDOWN" + ], + "enumDescriptions": [ + "Unspecified state", + "The instance has plenty space on data disk", + "Data disk is almost used up. It is shutdown to prevent data corruption." + ], + "type": "string" + } + }, + "type": "object" + }, + "SqlScheduledMaintenance": { + "description": "Any scheduled maintenancce for this instance.", + "id": "SqlScheduledMaintenance", + "properties": { + "canDefer": { + "type": "boolean" + }, + "canReschedule": { + "description": "If the scheduled maintenance can be rescheduled.", + "type": "boolean" + }, + "scheduleDeadlineTime": { + "description": "Maintenance cannot be rescheduled to start beyond this deadline.", + "format": "google-datetime", + "type": "string" + }, + "startTime": { + "description": "The start time of any upcoming scheduled maintenance for this instance.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "SslCert": { + "description": "SslCerts Resource", + "id": "SslCert", + "properties": { + "cert": { + "description": "PEM representation.", + "type": "string" + }, + "certSerialNumber": { + "description": "Serial number, as extracted from the certificate.", + "type": "string" + }, + "commonName": { + "description": "User supplied name. Constrained to [a-zA-Z.-_ ]+.", + "type": "string" + }, + "createTime": { + "description": "The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**", + "format": "google-datetime", + "type": "string" + }, + "expirationTime": { + "description": "The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example **2012-11-15T16:19:00.094Z**.", + "format": "google-datetime", + "type": "string" + }, + "instance": { + "description": "Name of the database instance.", + "type": "string" + }, + "kind": { + "description": "This is always sql#sslCert.", + "type": "string" + }, + "sha1Fingerprint": { + "description": "Sha1 Fingerprint.", + "type": "string" + } + }, + "type": "object" + }, + "SslCertsCreateEphemeralRequest": { + "description": "SslCerts create ephemeral certificate request.", + "id": "SslCertsCreateEphemeralRequest", + "properties": { + "access_token": { + "description": "Access token to include in the signed certificate.", + "type": "string" + }, + "public_key": { + "description": "PEM encoded public key to include in the signed certificate.", + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Cloud SQL Admin API", + "version": "v1" +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json index eebe6ad75dc..398f7259ded 100644 --- a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +++ b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json @@ -226,7 +226,7 @@ ] }, "list": { - "description": "Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the backup initiation time.", + "description": "Lists all backup runs associated with the project or a given instance and configuration in the reverse chronological order of the backup initiation time.", "flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/backupRuns", "httpMethod": "GET", "id": "sql.backupRuns.list", @@ -236,7 +236,7 @@ ], "parameters": { "instance": { - "description": "Cloud SQL instance ID. This does not include the project ID.", + "description": "Cloud SQL instance ID, or \"-\" for all instances. This does not include the project ID.", "location": "path", "required": true, "type": "string" @@ -270,6 +270,83 @@ } } }, + "connect": { + "methods": { + "generateEphemeralCert": { + "description": "Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.", + "flatPath": "sql/v1beta4/projects/{project}/instances/{instance}:generateEphemeralCert", + "httpMethod": "POST", + "id": "sql.connect.generateEphemeral", + "parameterOrder": [ + "project", + "instance" + ], + "parameters": { + "instance": { + "description": "Cloud SQL 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.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "sql/v1beta4/projects/{project}/instances/{instance}:generateEphemeralCert", + "request": { + "$ref": "GenerateEphemeralCertRequest" + }, + "response": { + "$ref": "GenerateEphemeralCertResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sqlservice.admin" + ] + }, + "get": { + "description": "Retrieves connect settings about a Cloud SQL instance.", + "flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/connectSettings", + "httpMethod": "GET", + "id": "sql.connect.get", + "parameterOrder": [ + "project", + "instance" + ], + "parameters": { + "instance": { + "description": "Cloud SQL 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.", + "location": "path", + "required": true, + "type": "string" + }, + "readTime": { + "description": "Optional. Optional snapshot read timestamp to trade freshness for performance.", + "format": "google-datetime", + "location": "query", + "type": "string" + } + }, + "path": "sql/v1beta4/projects/{project}/instances/{instance}/connectSettings", + "response": { + "$ref": "ConnectSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sqlservice.admin" + ] + } + } + }, "databases": { "methods": { "delete": { @@ -1834,7 +1911,7 @@ } } }, - "revision": "20210608", + "revision": "20210627", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -1913,7 +1990,7 @@ "type": "string" }, "pointInTimeRecoveryEnabled": { - "description": "Reserved for future use.", + "description": "(Postgres only) Whether point in time recovery is enabled.", "type": "boolean" }, "replicationLogArchivingEnabled": { @@ -2156,13 +2233,97 @@ "type": "string" }, "pointInTime": { - "description": "Reserved for future use.", + "description": "Timestamp, if specified, identifies the time to which the source instance is cloned.", "format": "google-datetime", "type": "string" } }, "type": "object" }, + "ConnectSettings": { + "description": "Connect settings retrieval response.", + "id": "ConnectSettings", + "properties": { + "backendType": { + "description": "**SECOND_GEN**: Cloud SQL database instance. **EXTERNAL**: A database server that is not managed by Google. This property is read-only; use the **tier** property in the **settings** object to determine the database type.", + "enum": [ + "SQL_BACKEND_TYPE_UNSPECIFIED", + "FIRST_GEN", + "SECOND_GEN", + "EXTERNAL" + ], + "enumDescriptions": [ + "This is an unknown backend type for instance.", + "V1 speckle instance.", + "V2 speckle instance.", + "On premises instance." + ], + "type": "string" + }, + "databaseVersion": { + "description": "The database engine type and version. The **databaseVersion** field cannot be changed after instance creation. MySQL instances: **MYSQL_8_0**, **MYSQL_5_7** (default), or **MYSQL_5_6**. PostgreSQL instances: **POSTGRES_9_6**, **POSTGRES_10**, **POSTGRES_11** or **POSTGRES_12** (default). SQL Server instances: **SQLSERVER_2017_STANDARD** (default), **SQLSERVER_2017_ENTERPRISE**, **SQLSERVER_2017_EXPRESS**, or **SQLSERVER_2017_WEB**.", + "enum": [ + "SQL_DATABASE_VERSION_UNSPECIFIED", + "MYSQL_5_1", + "MYSQL_5_5", + "MYSQL_5_6", + "MYSQL_5_7", + "POSTGRES_9_6", + "POSTGRES_11", + "SQLSERVER_2017_STANDARD", + "SQLSERVER_2017_ENTERPRISE", + "SQLSERVER_2017_EXPRESS", + "SQLSERVER_2017_WEB", + "POSTGRES_10", + "POSTGRES_12", + "MYSQL_8_0", + "POSTGRES_13", + "SQLSERVER_2019_STANDARD", + "SQLSERVER_2019_ENTERPRISE", + "SQLSERVER_2019_EXPRESS", + "SQLSERVER_2019_WEB" + ], + "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 PostgreSQL 9.6.", + "The database version is PostgreSQL 11.", + "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 10.", + "The database version is PostgreSQL 12.", + "The database version is MySQL 8.", + "The database version is PostgreSQL 13.", + "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." + ], + "type": "string" + }, + "ipAddresses": { + "description": "The assigned IP addresses for the instance.", + "items": { + "$ref": "IpMapping" + }, + "type": "array" + }, + "kind": { + "description": "This is always `sql#connectSettings`.", + "type": "string" + }, + "serverCaCert": { + "$ref": "SslCert", + "description": "SSL configuration." + } + }, + "type": "object" + }, "Database": { "description": "Represents a SQL database on the Cloud SQL instance.", "id": "Database", @@ -2845,6 +3006,37 @@ }, "type": "object" }, + "GenerateEphemeralCertRequest": { + "description": "Ephemeral certificate creation request.", + "id": "GenerateEphemeralCertRequest", + "properties": { + "access_token": { + "description": "Optional. Access token to include in the signed certificate.", + "type": "string" + }, + "public_key": { + "description": "PEM encoded public key to include in the signed certificate.", + "type": "string" + }, + "readTime": { + "description": "Optional. Optional snapshot read timestamp to trade freshness for performance.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "GenerateEphemeralCertResponse": { + "description": "Ephemeral certificate creation request.", + "id": "GenerateEphemeralCertResponse", + "properties": { + "ephemeralCert": { + "$ref": "SslCert", + "description": "Generated cert" + } + }, + "type": "object" + }, "ImportContext": { "description": "Database instance import context.", "id": "ImportContext", @@ -3935,6 +4127,11 @@ "description": "If the scheduled maintenance can be rescheduled.", "type": "boolean" }, + "scheduleDeadlineTime": { + "description": "Maintenance cannot be rescheduled to start beyond this deadline.", + "format": "google-datetime", + "type": "string" + }, "startTime": { "description": "The start time of any upcoming scheduled maintenance for this instance.", "format": "google-datetime",