google_api_sql_admin

v0.0.1

google_api_sql_admin v0.0.1 GoogleApi.SQLAdmin.V1beta4.Api.SslCerts View Source

API calls for all endpoints tagged SslCerts.

Link to this section Summary

Functions

sql_ssl_certs_create_ephemeral(connection, project, instance, 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_ssl_certs_delete(connection, project, instance, sha1_fingerprint, opts \\ [])

Deletes the SSL certificate. The change will not take effect until the instance is restarted

sql_ssl_certs_get(connection, project, instance, sha1_fingerprint, opts \\ [])

Retrieves a particular SSL certificate. Does not include the private key (required for usage). The private key must be saved from the response to initial creation

sql_ssl_certs_insert(connection, project, instance, opts \\ [])

Creates an SSL certificate and returns it along with the private key and server certificate authority. The new certificate will not be usable until the instance is restarted

sql_ssl_certs_list(connection, project, instance, opts \\ [])

Lists all of the current SSL certificates for the instance

Link to this section Functions

Link to this function sql_ssl_certs_create_ephemeral(connection, project, instance, opts \\ []) View Source 
sql_ssl_certs_create_ephemeral(Tesla.Env.client, String.t, String.t, keyword) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.SslCert.t} |
  {:error, Tesla.Env.t}

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 (GoogleApi.SQLAdmin.V1beta4.Connection): Connection to server
  • project (String): Project ID of the Cloud SQL project.
  • instance (String): Cloud SQL instance ID. This does not include the project ID.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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 (String): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :body (SslCertsCreateEphemeralRequest):

Returns

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

Link to this function sql_ssl_certs_delete(connection, project, instance, sha1_fingerprint, opts \\ []) View Source 
sql_ssl_certs_delete(Tesla.Env.client, String.t, String.t, String.t, keyword) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.Operation.t} |
  {:error, Tesla.Env.t}

Deletes the SSL certificate. The change will not take effect until the instance is restarted.

Parameters

  • connection (GoogleApi.SQLAdmin.V1beta4.Connection): Connection to server
  • project (String): Project ID of the project that contains the instance to be deleted.
  • instance (String): Cloud SQL instance ID. This does not include the project ID.
  • sha1_fingerprint (String): Sha1 FingerPrint.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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 (String): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns

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

Link to this function sql_ssl_certs_get(connection, project, instance, sha1_fingerprint, opts \\ []) View Source 
sql_ssl_certs_get(Tesla.Env.client, String.t, String.t, String.t, keyword) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.SslCert.t} |
  {:error, Tesla.Env.t}

Retrieves a particular SSL certificate. Does not include the private key (required for usage). The private key must be saved from the response to initial creation.

Parameters

  • connection (GoogleApi.SQLAdmin.V1beta4.Connection): Connection to server
  • project (String): Project ID of the project that contains the instance.
  • instance (String): Cloud SQL instance ID. This does not include the project ID.
  • sha1_fingerprint (String): Sha1 FingerPrint.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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 (String): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns

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

Link to this function sql_ssl_certs_insert(connection, project, instance, opts \\ []) View Source 
sql_ssl_certs_insert(Tesla.Env.client, String.t, String.t, keyword) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.SslCertsInsertResponse.t} |
  {:error, Tesla.Env.t}

Creates an SSL certificate and returns it along with the private key and server certificate authority. The new certificate will not be usable until the instance is restarted.

Parameters

  • connection (GoogleApi.SQLAdmin.V1beta4.Connection): Connection to server
  • project (String): Project ID of the project to which the newly created Cloud SQL instances should belong.
  • instance (String): Cloud SQL instance ID. This does not include the project ID.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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 (String): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :body (SslCertsInsertRequest):

Returns

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

Link to this function sql_ssl_certs_list(connection, project, instance, opts \\ []) View Source 
sql_ssl_certs_list(Tesla.Env.client, String.t, String.t, keyword) ::
  {:ok, GoogleApi.SQLAdmin.V1beta4.Model.SslCertsListResponse.t} |
  {:error, Tesla.Env.t}

Lists all of the current SSL certificates for the instance.

Parameters

  • connection (GoogleApi.SQLAdmin.V1beta4.Connection): Connection to server
  • project (String): Project ID of the project for which to list Cloud SQL instances.
  • instance (String): Cloud SQL instance ID. This does not include the project ID.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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 (String): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns

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