GoogleApi.SQLAdmin.V1beta4.Api.Connect (google_api_sql_admin v0.71.0)

View Source

API calls for all endpoints tagged Connect.

Summary

Functions

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

Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.

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

Retrieves connect settings about a Cloud SQL instance.

Functions

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

@spec sql_connect_generate_ephemeral(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.GenerateEphemeralCertResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.

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").
    • :body (type: GoogleApi.SQLAdmin.V1beta4.Model.GenerateEphemeralCertRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

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

@spec sql_connect_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.ConnectSettings.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves connect settings 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) - 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").
    • :readTime (type: DateTime.t) - Optional. Optional snapshot read timestamp to trade freshness for performance.
  • opts (type: keyword()) - Call options

Returns

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