GoogleApi.BigtableAdmin.V2.Api.Projects.bigtableadmin_projects_instances_clusters_backups_create

You're seeing just the function bigtableadmin_projects_instances_clusters_backups_create, go back to GoogleApi.BigtableAdmin.V2.Api.Projects module for more information.
Link to this function

bigtableadmin_projects_instances_clusters_backups_create(connection, projects_id, instances_id, clusters_id, optional_params \\ [], opts \\ [])

View Source

Specs

bigtableadmin_projects_instances_clusters_backups_create(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.BigtableAdmin.V2.Model.Operation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Starts creating a new Cloud Bigtable Backup. The returned backup long-running operation can be used to track creation of the backup. The metadata field type is CreateBackupMetadata. The response field type is Backup, if successful. Cancelling the returned operation will stop the creation and delete the backup.

Parameters

  • connection (type: GoogleApi.BigtableAdmin.V2.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of parent. Required. This must be one of the clusters in the instance in which this table is located. The backup will be stored in this cluster. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}.
  • instances_id (type: String.t) - Part of parent. See documentation of projectsId.
  • clusters_id (type: String.t) - Part of parent. See documentation of projectsId.
  • 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").
    • :backupId (type: String.t) - Required. The id of the backup to be created. The backup_id along with the parent parent are combined as {parent}/backups/{backup_id} to create the full backup name, of the form: projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}. This string must be between 1 and 50 characters in length and match the regex _a-zA-Z0-9*.
    • :body (type: GoogleApi.BigtableAdmin.V2.Model.Backup.t) -
  • opts (type: keyword()) - Call options

Returns

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