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

View Source

API calls for all endpoints tagged Projects.

Summary

Functions

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

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

Get Disk Shrink Config for a given 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.SqlInstancesGetDiskShrinkConfigResponse{}} on success
  • {:error, info} on failure

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

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

Get Latest Recovery Time for a given 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.SqlInstancesGetLatestRecoveryTimeResponse{}} on success
  • {:error, info} on failure

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

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

Perform Disk Shrink on primary 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").
    • :body (type: GoogleApi.SQLAdmin.V1.Model.PerformDiskShrinkContext.t) -
  • opts (type: keyword()) - Call options

Returns

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

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

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

Reschedules the maintenance on the given instance.

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.SqlInstancesRescheduleMaintenanceRequestBody.t) -
  • opts (type: keyword()) - Call options

Returns

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

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

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

Reset Replica Size to primary instance disk size.

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

Returns

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

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

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

Start External primary instance migration.

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.SqlInstancesStartExternalSyncRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

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

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

Verify External primary instance external sync settings.

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.SqlInstancesVerifyExternalSyncSettingsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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