GoogleApi.SQLAdmin.V1.Api.Instances (google_api_sql_admin v0.71.0)

View Source

API calls for all endpoints tagged Instances.

Summary

Functions

sql_instances__list_server_certificates(connection, project, instance, optional_params \\ [], opts \\ [])

Lists all versions of server certificates and certificate authorities (CAs) for the specified instance. There can be up to three sets of certs listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out. For instances not using Certificate Authority Service (CAS) server CA, use ListServerCas instead.

sql_instances__rotate_server_certificate(connection, project, instance, optional_params \\ [], opts \\ [])

Rotates the server certificate version to one previously added with the addServerCertificate method. For instances not using Certificate Authority Service (CAS) server CA, use RotateServerCa instead.

sql_instances_acquire_ssrs_lease(connection, project, instance, optional_params \\ [], opts \\ [])

Acquire a lease for the setup of SQL Server Reporting Services (SSRS).

sql_instances_add_server_ca(connection, project, instance, optional_params \\ [], opts \\ [])

Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, use AddServerCertificate to add a new server certificate.

sql_instances_add_server_certificate(connection, project, instance, optional_params \\ [], opts \\ [])

Add a new trusted server certificate version for the specified instance using Certificate Authority Service (CAS) server CA. Required to prepare for a certificate rotation. If a server certificate version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one certificate version waiting to be rotated in. For instances not using CAS server CA, use AddServerCa instead.

sql_instances_clone(connection, project, instance, optional_params \\ [], opts \\ [])

Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart.

sql_instances_delete(connection, project, instance, optional_params \\ [], opts \\ [])

Deletes a Cloud SQL instance.

sql_instances_demote(connection, project, instance, optional_params \\ [], opts \\ [])

Demotes an existing standalone instance to be a Cloud SQL read replica for an external database server.

sql_instances_demote_master(connection, project, instance, optional_params \\ [], opts \\ [])

Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server.

sql_instances_export(connection, project, instance, optional_params \\ [], opts \\ [])

Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file.

sql_instances_failover(connection, project, instance, optional_params \\ [], opts \\ [])

Initiates a manual failover of a high availability (HA) primary instance to a standby instance, which becomes the primary instance. Users are then rerouted to the new primary. For more information, see the Overview of high availability page in the Cloud SQL documentation. If using Legacy HA (MySQL only), this causes the instance to failover to its failover replica instance.

sql_instances_get(connection, project, instance, optional_params \\ [], opts \\ [])

Retrieves a resource containing information about a Cloud SQL instance.

sql_instances_import(connection, project, instance, optional_params \\ [], opts \\ [])

Imports data into a Cloud SQL instance from a SQL dump or CSV file in Cloud Storage.

sql_instances_insert(connection, project, optional_params \\ [], opts \\ [])

Creates a new Cloud SQL instance.

sql_instances_list(connection, project, optional_params \\ [], opts \\ [])

Lists instances under a given project.

sql_instances_list_server_cas(connection, project, instance, optional_params \\ [], opts \\ [])

Lists all of the trusted Certificate Authorities (CAs) for the specified instance. There can be up to three CAs listed: the CA that was used to sign the certificate that is currently in use, a CA that has been added but not yet used to sign a certificate, and a CA used to sign a certificate that has previously rotated out.

sql_instances_patch(connection, project, instance, optional_params \\ [], opts \\ [])

Partially updates settings of a Cloud SQL instance by merging the request with the current configuration. This method supports patch semantics.

sql_instances_promote_replica(connection, project, instance, optional_params \\ [], opts \\ [])

Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart.

sql_instances_reencrypt(connection, project, instance, optional_params \\ [], opts \\ [])

Reencrypt CMEK instance with latest key version.

sql_instances_release_ssrs_lease(connection, project, instance, optional_params \\ [], opts \\ [])

Release a lease for the setup of SQL Server Reporting Services (SSRS).

sql_instances_reset_ssl_config(connection, project, instance, optional_params \\ [], opts \\ [])

Deletes all client certificates and generates a new server SSL certificate for the instance.

sql_instances_restart(connection, project, instance, optional_params \\ [], opts \\ [])

Restarts a Cloud SQL instance.

sql_instances_restore_backup(connection, project, instance, optional_params \\ [], opts \\ [])

Restores a backup of a Cloud SQL instance. Using this operation might cause your instance to restart.

sql_instances_rotate_server_ca(connection, project, instance, optional_params \\ [], opts \\ [])

Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, use RotateServerCertificate to rotate the server certificate.

sql_instances_start_replica(connection, project, instance, optional_params \\ [], opts \\ [])

Starts the replication in the read replica instance.

sql_instances_stop_replica(connection, project, instance, optional_params \\ [], opts \\ [])

Stops the replication in the read replica instance.

sql_instances_switchover(connection, project, instance, optional_params \\ [], opts \\ [])

Switches over from the primary instance to the DR replica instance.

sql_instances_truncate_log(connection, project, instance, optional_params \\ [], opts \\ [])

Truncate MySQL general and slow query log tables MySQL only.

sql_instances_update(connection, project, instance, optional_params \\ [], opts \\ [])

Updates settings of a Cloud SQL instance. Using this operation might cause your instance to restart.

Functions

sql_instances__list_server_certificates(connection, project, instance, optional_params \\ [], opts \\ [])

@spec sql_instances__list_server_certificates(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1.Model.InstancesListServerCertificatesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all versions of server certificates and certificate authorities (CAs) for the specified instance. There can be up to three sets of certs listed: the certificate that is currently in use, a future that has been added but not yet used to sign a certificate, and a certificate that has been rotated out. For instances not using Certificate Authority Service (CAS) server CA, use ListServerCas instead.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - Required. Project ID of the project that contains the instance.
  • instance (type: String.t) - Required. Cloud SQL instance ID. This does not include the project ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1.Model.InstancesListServerCertificatesResponse{}} on success
  • {:error, info} on failure

sql_instances__rotate_server_certificate(connection, project, instance, optional_params \\ [], opts \\ [])

@spec sql_instances__rotate_server_certificate(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Rotates the server certificate version to one previously added with the addServerCertificate method. For instances not using Certificate Authority Service (CAS) server CA, use RotateServerCa instead.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - Required. Project ID of the project that contains the instance.
  • instance (type: String.t) - Required. Cloud SQL instance ID. This does not include the project ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.SQLAdmin.V1.Model.InstancesRotateServerCertificateRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1.Model.Operation{}} on success
  • {:error, info} on failure

sql_instances_acquire_ssrs_lease(connection, project, instance, optional_params \\ [], opts \\ [])

@spec sql_instances_acquire_ssrs_lease(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1.Model.SqlInstancesAcquireSsrsLeaseResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Acquire a lease for the setup of SQL Server Reporting Services (SSRS).

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - Required. Project ID of the project that contains the instance (Example: project-id).
  • instance (type: String.t) - Required. Cloud SQL instance ID. This doesn't include the project ID. It's composed of lowercase letters, numbers, and hyphens, and it must start with a letter. The total length must be 98 characters or less (Example: instance-id).
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.SQLAdmin.V1.Model.InstancesAcquireSsrsLeaseRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1.Model.SqlInstancesAcquireSsrsLeaseResponse{}} on success
  • {:error, info} on failure

sql_instances_add_server_ca(connection, project, instance, optional_params \\ [], opts \\ [])

@spec sql_instances_add_server_ca(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, use AddServerCertificate to add a new server certificate.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - Project ID of the project that contains the instance.
  • instance (type: String.t) - Cloud SQL instance ID. This does not include the project ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1.Model.Operation{}} on success
  • {:error, info} on failure

sql_instances_add_server_certificate(connection, project, instance, optional_params \\ [], opts \\ [])

@spec sql_instances_add_server_certificate(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Add a new trusted server certificate version for the specified instance using Certificate Authority Service (CAS) server CA. Required to prepare for a certificate rotation. If a server certificate version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one certificate version waiting to be rotated in. For instances not using CAS server CA, use AddServerCa instead.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - Project ID of the project that contains the instance.
  • instance (type: String.t) - Cloud SQL instance ID. This does not include the project ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1.Model.Operation{}} on success
  • {:error, info} on failure

sql_instances_clone(connection, project, instance, optional_params \\ [], opts \\ [])

@spec sql_instances_clone(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - Project ID of the source as well as the clone Cloud SQL instance.
  • instance (type: String.t) - The ID of the Cloud SQL instance to be cloned (source). This does not include the project ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.SQLAdmin.V1.Model.InstancesCloneRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1.Model.Operation{}} on success
  • {:error, info} on failure

sql_instances_delete(connection, project, instance, optional_params \\ [], opts \\ [])

@spec sql_instances_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes a Cloud SQL instance.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - Project ID of the project that contains the instance to be deleted.
  • instance (type: String.t) - Cloud SQL instance ID. This does not include the project ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :enableFinalBackup (type: boolean()) - Flag to opt-in for final backup. By default, it is turned off.
    • :finalBackupDescription (type: String.t) - Optional. The description of the final backup.
    • :finalBackupExpiryTime (type: DateTime.t) - Optional. Final Backup expiration time. Timestamp in UTC of when this resource is considered expired.
    • :finalBackupTtlDays (type: String.t) - Optional. Retention period of the final backup.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1.Model.Operation{}} on success
  • {:error, info} on failure

sql_instances_demote(connection, project, instance, optional_params \\ [], opts \\ [])

@spec sql_instances_demote(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Demotes an existing standalone instance to be a Cloud SQL read replica for an external database server.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - Required. ID of the project that contains the instance.
  • instance (type: String.t) - Required. Cloud SQL instance name.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.SQLAdmin.V1.Model.InstancesDemoteRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1.Model.Operation{}} on success
  • {:error, info} on failure

sql_instances_demote_master(connection, project, instance, optional_params \\ [], opts \\ [])

@spec sql_instances_demote_master(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Demotes the stand-alone instance to be a Cloud SQL read replica for an external database server.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - ID of the project that contains the instance.
  • instance (type: String.t) - Cloud SQL instance name.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.SQLAdmin.V1.Model.InstancesDemoteMasterRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1.Model.Operation{}} on success
  • {:error, info} on failure

sql_instances_export(connection, project, instance, optional_params \\ [], opts \\ [])

@spec sql_instances_export(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Exports data from a Cloud SQL instance to a Cloud Storage bucket as a SQL dump or CSV file.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - Project ID of the project that contains the instance to be exported.
  • instance (type: String.t) - Cloud SQL instance ID. This does not include the project ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.SQLAdmin.V1.Model.InstancesExportRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1.Model.Operation{}} on success
  • {:error, info} on failure

sql_instances_failover(connection, project, instance, optional_params \\ [], opts \\ [])

@spec sql_instances_failover(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Initiates a manual failover of a high availability (HA) primary instance to a standby instance, which becomes the primary instance. Users are then rerouted to the new primary. For more information, see the Overview of high availability page in the Cloud SQL documentation. If using Legacy HA (MySQL only), this causes the instance to failover to its failover replica instance.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - ID of the project that contains the read replica.
  • instance (type: String.t) - Cloud SQL instance ID. This does not include the project ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.SQLAdmin.V1.Model.InstancesFailoverRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1.Model.Operation{}} on success
  • {:error, info} on failure

sql_instances_get(connection, project, instance, optional_params \\ [], opts \\ [])

@spec sql_instances_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1.Model.DatabaseInstance.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves a resource containing information about a Cloud SQL instance.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - Project ID of the project that contains the instance.
  • instance (type: String.t) - Database instance ID. This does not include the project ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1.Model.DatabaseInstance{}} on success
  • {:error, info} on failure

sql_instances_import(connection, project, instance, optional_params \\ [], opts \\ [])

@spec sql_instances_import(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Imports data into a Cloud SQL instance from a SQL dump or CSV file in Cloud Storage.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - Project ID of the project that contains the instance.
  • instance (type: String.t) - Cloud SQL instance ID. This does not include the project ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.SQLAdmin.V1.Model.InstancesImportRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1.Model.Operation{}} on success
  • {:error, info} on failure

sql_instances_insert(connection, project, optional_params \\ [], opts \\ [])

@spec sql_instances_insert(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.SQLAdmin.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new Cloud SQL instance.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - Project ID of the project to which the newly created Cloud SQL instances should belong.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.SQLAdmin.V1.Model.DatabaseInstance.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1.Model.Operation{}} on success
  • {:error, info} on failure

sql_instances_list(connection, project, optional_params \\ [], opts \\ [])

@spec sql_instances_list(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.SQLAdmin.V1.Model.InstancesListResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists instances under a given project.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - Project ID of the project for which to list Cloud SQL instances.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - 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 (type: integer()) - The maximum number of instances to return. The service may return fewer than this value. If unspecified, at most 500 instances are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
    • :pageToken (type: String.t) - A previously-returned page token representing part of the larger set of results to view.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1.Model.InstancesListResponse{}} on success
  • {:error, info} on failure

sql_instances_list_server_cas(connection, project, instance, optional_params \\ [], opts \\ [])

@spec sql_instances_list_server_cas(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1.Model.InstancesListServerCasResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all of the trusted Certificate Authorities (CAs) for the specified instance. There can be up to three CAs listed: the CA that was used to sign the certificate that is currently in use, a CA that has been added but not yet used to sign a certificate, and a CA used to sign a certificate that has previously rotated out.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - Project ID of the project that contains the instance.
  • instance (type: String.t) - Cloud SQL instance ID. This does not include the project ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1.Model.InstancesListServerCasResponse{}} on success
  • {:error, info} on failure

sql_instances_patch(connection, project, instance, optional_params \\ [], opts \\ [])

@spec sql_instances_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Partially updates settings of a Cloud SQL instance by merging the request with the current configuration. This method supports patch semantics.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - Project ID of the project that contains the instance.
  • instance (type: String.t) - Cloud SQL instance ID. This does not include the project ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.SQLAdmin.V1.Model.DatabaseInstance.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1.Model.Operation{}} on success
  • {:error, info} on failure

sql_instances_promote_replica(connection, project, instance, optional_params \\ [], opts \\ [])

@spec sql_instances_promote_replica(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Promotes the read replica instance to be an independent Cloud SQL primary instance. Using this operation might cause your instance to restart.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - ID of the project that contains the read replica.
  • instance (type: String.t) - Cloud SQL read replica instance name.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :failover (type: boolean()) - Set to true to invoke a replica failover to the DR replica. As part of replica failover, the promote operation attempts to add the original primary instance as a replica of the promoted DR replica when the original primary instance comes back online. If set to false or not specified, then the original primary instance becomes an independent Cloud SQL primary instance.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1.Model.Operation{}} on success
  • {:error, info} on failure

sql_instances_reencrypt(connection, project, instance, optional_params \\ [], opts \\ [])

@spec sql_instances_reencrypt(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Reencrypt CMEK instance with latest key version.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - ID of the project that contains the instance.
  • instance (type: String.t) - Cloud SQL instance ID. This does not include the project ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.SQLAdmin.V1.Model.InstancesReencryptRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1.Model.Operation{}} on success
  • {:error, info} on failure

sql_instances_release_ssrs_lease(connection, project, instance, optional_params \\ [], opts \\ [])

@spec sql_instances_release_ssrs_lease(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1.Model.SqlInstancesReleaseSsrsLeaseResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Release a lease for the setup of SQL Server Reporting Services (SSRS).

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - Required. The project ID that contains the instance.
  • instance (type: String.t) - Required. The Cloud SQL instance ID. This doesn't include the project ID. The instance ID contains lowercase letters, numbers, and hyphens, and it must start with a letter. This ID can have a maximum length of 98 characters.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1.Model.SqlInstancesReleaseSsrsLeaseResponse{}} on success
  • {:error, info} on failure

sql_instances_reset_ssl_config(connection, project, instance, optional_params \\ [], opts \\ [])

@spec sql_instances_reset_ssl_config(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes all client certificates and generates a new server SSL certificate for the instance.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - Project ID of the project that contains the instance.
  • instance (type: String.t) - Cloud SQL instance ID. This does not include the project ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1.Model.Operation{}} on success
  • {:error, info} on failure

sql_instances_restart(connection, project, instance, optional_params \\ [], opts \\ [])

@spec sql_instances_restart(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Restarts a Cloud SQL instance.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - Project ID of the project that contains the instance to be restarted.
  • instance (type: String.t) - Cloud SQL instance ID. This does not include the project ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1.Model.Operation{}} on success
  • {:error, info} on failure

sql_instances_restore_backup(connection, project, instance, optional_params \\ [], opts \\ [])

@spec sql_instances_restore_backup(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Restores a backup of a Cloud SQL instance. Using this operation might cause your instance to restart.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - Project ID of the project that contains the instance.
  • instance (type: String.t) - Cloud SQL instance ID. This does not include the project ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.SQLAdmin.V1.Model.InstancesRestoreBackupRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1.Model.Operation{}} on success
  • {:error, info} on failure

sql_instances_rotate_server_ca(connection, project, instance, optional_params \\ [], opts \\ [])

@spec sql_instances_rotate_server_ca(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, use RotateServerCertificate to rotate the server certificate.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - Project ID of the project that contains the instance.
  • instance (type: String.t) - Cloud SQL instance ID. This does not include the project ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.SQLAdmin.V1.Model.InstancesRotateServerCaRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1.Model.Operation{}} on success
  • {:error, info} on failure

sql_instances_start_replica(connection, project, instance, optional_params \\ [], opts \\ [])

@spec sql_instances_start_replica(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Starts the replication in the read replica instance.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - ID of the project that contains the read replica.
  • instance (type: String.t) - Cloud SQL read replica instance name.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1.Model.Operation{}} on success
  • {:error, info} on failure

sql_instances_stop_replica(connection, project, instance, optional_params \\ [], opts \\ [])

@spec sql_instances_stop_replica(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Stops the replication in the read replica instance.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - ID of the project that contains the read replica.
  • instance (type: String.t) - Cloud SQL read replica instance name.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1.Model.Operation{}} on success
  • {:error, info} on failure

sql_instances_switchover(connection, project, instance, optional_params \\ [], opts \\ [])

@spec sql_instances_switchover(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Switches over from the primary instance to the DR replica instance.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - ID of the project that contains the replica.
  • instance (type: String.t) - Cloud SQL read replica instance name.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :dbTimeout (type: String.t) - Optional. (MySQL and PostgreSQL only) Cloud SQL instance operations timeout, which is a sum of all database operations. Default value is 10 minutes and can be modified to a maximum value of 24 hours.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1.Model.Operation{}} on success
  • {:error, info} on failure

sql_instances_truncate_log(connection, project, instance, optional_params \\ [], opts \\ [])

@spec sql_instances_truncate_log(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Truncate MySQL general and slow query log tables MySQL only.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - Project ID of the Cloud SQL project.
  • instance (type: String.t) - Cloud SQL instance ID. This does not include the project ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.SQLAdmin.V1.Model.InstancesTruncateLogRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1.Model.Operation{}} on success
  • {:error, info} on failure

sql_instances_update(connection, project, instance, optional_params \\ [], opts \\ [])

@spec sql_instances_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates settings of a Cloud SQL instance. Using this operation might cause your instance to restart.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1.Connection.t) - Connection to server
  • project (type: String.t) - Project ID of the project that contains the instance.
  • instance (type: String.t) - Cloud SQL instance ID. This does not include the project ID.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - 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.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.SQLAdmin.V1.Model.DatabaseInstance.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1.Model.Operation{}} on success
  • {:error, info} on failure