google_api_sql_admin v0.24.0 GoogleApi.SQLAdmin.V1beta4.Api.Instances View Source

API calls for all endpoints tagged Instances.

Link to this section Summary

Functions

Add 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.

Creates a Cloud SQL instance as a clone of the source instance.

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

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

Retrieves a resource containing information about a Cloud SQL instance.

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

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.

Updates settings of a Cloud SQL instance. This method supports patch semantics.

Promotes the read replica instance to be a stand-alone Cloud SQL instance.

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

Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.

Link to this section Functions

Link to this function

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

View Source
sql_instances_add_server_ca(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Add 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.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1beta4.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").
    • :parent (type: String.t) - The parent resource where Cloud SQL should add this server CA. Format: projects/{project}/locations/{location}/instances/{instance}
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1beta4.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
sql_instances_clone(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Creates a Cloud SQL instance as a clone of the source instance.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1beta4.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").
    • :parent (type: String.t) - The parent resource where Cloud SQL should clone this instance. Format: projects/{project}/locations/{location}/instances/{instance}
    • :body (type: GoogleApi.SQLAdmin.V1beta4.Model.InstancesCloneRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1beta4.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
sql_instances_delete(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Deletes a Cloud SQL instance.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1beta4.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").
    • :resourceName (type: String.t) - The name of database instance to delete. Format: projects/{project}/locations/{location}/instances/{instance}
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1beta4.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
sql_instances_demote_master(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1beta4.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").
    • :parent (type: String.t) - The parent resource where Cloud SQL demotes this master database instance. Format: projects/{project}/locations/{location}/instances/{instance}
    • :body (type: GoogleApi.SQLAdmin.V1beta4.Model.InstancesDemoteMasterRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1beta4.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
sql_instances_export(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1beta4.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").
    • :parent (type: String.t) - The parent resource where Cloud SQL exports this database instance. Format: projects/{project}/locations/{location}/instances/{instance}
    • :body (type: GoogleApi.SQLAdmin.V1beta4.Model.InstancesExportRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1beta4.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
sql_instances_failover(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Failover the instance to its failover replica instance.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1beta4.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").
    • :parent (type: String.t) - The parent resource where Cloud SQL sends this database instance during a failover. Format: projects/{project}/locations/{location}/instances/{instance}
    • :body (type: GoogleApi.SQLAdmin.V1beta4.Model.InstancesFailoverRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1beta4.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
sql_instances_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.DatabaseInstance.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Retrieves a resource containing information about a Cloud SQL instance.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1beta4.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").
    • :resourceName (type: String.t) - Name of the resource database instance. Format: projects/{project}/locations/{location}/instances/{instance}
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1beta4.Model.DatabaseInstance{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
sql_instances_import(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1beta4.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").
    • :parent (type: String.t) - The parent resource where Cloud SQL imports this database instance. Format: projects/{project}/locations/{location}/instances/{instance}
    • :body (type: GoogleApi.SQLAdmin.V1beta4.Model.InstancesImportRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1beta4.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
sql_instances_insert(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Creates a new Cloud SQL instance.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1beta4.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").
    • :parent (type: String.t) - The parent resource where Cloud SQL creates this database instance. Format: projects/{project}/locations/{location}
    • :body (type: GoogleApi.SQLAdmin.V1beta4.Model.DatabaseInstance.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1beta4.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

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

View Source

Lists instances under a given project.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1beta4.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 results to return per response.

    • :pageToken (type: String.t) - A previously-returned page token representing part of the larger set of results to view.

    • :parent (type: String.t) - The parent, which owns this collection of database instances. Format: projects/{project}/locations/{location}

  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1beta4.Model.InstancesListResponse{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
sql_instances_list_server_cas(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.InstancesListServerCasResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

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.V1beta4.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").
    • :parent (type: String.t) - The parent, which owns this collection of server CAs. Format: projects/{project}/locations/{location}/instances/{instance}
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1beta4.Model.InstancesListServerCasResponse{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
sql_instances_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Updates settings of a Cloud SQL instance. This method supports patch semantics.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1beta4.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").
    • :resourceName (type: String.t) - The name of the database instance for Cloud SQL to update. Format: projects/{project}/locations/{location}/instances/{instance}
    • :body (type: GoogleApi.SQLAdmin.V1beta4.Model.DatabaseInstance.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1beta4.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
sql_instances_promote_replica(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Promotes the read replica instance to be a stand-alone Cloud SQL instance.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1beta4.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").
    • :parent (type: String.t) - The parent resource where Cloud SQL promotes this replica database instance. Format: projects/{project}/locations/{location}
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1beta4.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
sql_instances_reset_ssl_config(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1beta4.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").
    • :parent (type: String.t) - The parent resource where Cloud SQL resets this SSL config. Format: projects/{project}/locations/{location}/instances/{instance}
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1beta4.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
sql_instances_restart(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Restarts a Cloud SQL instance.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1beta4.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").
    • :parent (type: String.t) - The parent resource where Cloud SQL restarts this database instance. Format: projects/{project}/locations/{location}/instances/{instance}
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1beta4.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
sql_instances_restore_backup(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Restores a backup of a Cloud SQL instance.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1beta4.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").
    • :parent (type: String.t) - The parent resource where Cloud SQL restores this database instance from backup. Format: projects/{project}/locations/{location}/instances/{instance}
    • :body (type: GoogleApi.SQLAdmin.V1beta4.Model.InstancesRestoreBackupRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1beta4.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
sql_instances_rotate_server_ca(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1beta4.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").
    • :parent (type: String.t) - The parent resource where Cloud SQL rotates these server CAs. Format: projects/{project}/locations/{location}/instances/{instance}
    • :body (type: GoogleApi.SQLAdmin.V1beta4.Model.InstancesRotateServerCaRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1beta4.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
sql_instances_start_replica(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Starts the replication in the read replica instance.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1beta4.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").
    • :parent (type: String.t) - The parent resource where Cloud SQL starts this database instance replication. Format: projects/{project}/locations/{location}/instances/{instance}
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1beta4.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
sql_instances_stop_replica(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Stops the replication in the read replica instance.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1beta4.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").
    • :parent (type: String.t) - The parent resource where Cloud SQL stops this database instance replication. Format: projects/{project}/locations/{location}/instances/{instance}
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1beta4.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
sql_instances_truncate_log(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Truncate MySQL general and slow query log tables

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1beta4.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").
    • :parent (type: String.t) - The parent resource where Cloud SQL truncates this log. Format: projects/{project}/locations/{location}/instances/{instance}
    • :body (type: GoogleApi.SQLAdmin.V1beta4.Model.InstancesTruncateLogRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SQLAdmin.V1beta4.Model.Operation{}} on success
  • {:error, info} on failure
Link to this function

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

View Source
sql_instances_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Updates settings of a Cloud SQL instance.

Parameters

  • connection (type: GoogleApi.SQLAdmin.V1beta4.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").
    • :resourceName (type: String.t) - The name of the database instance for Cloud SQL to update. Format: projects/{project}/locations/{location}/instances/{instance}
    • :body (type: GoogleApi.SQLAdmin.V1beta4.Model.DatabaseInstance.t) -
  • opts (type: keyword()) - Call options

Returns

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