GoogleApi.BigtableAdmin.V2.Api.Projects.bigtableadmin_projects_instances_clusters_backups_list
You're seeing just the function
bigtableadmin_projects_instances_clusters_backups_list
, go back to GoogleApi.BigtableAdmin.V2.Api.Projects module for more information.
Link to this function
bigtableadmin_projects_instances_clusters_backups_list(connection, projects_id, instances_id, clusters_id, optional_params \\ [], opts \\ [])
View SourceSpecs
bigtableadmin_projects_instances_clusters_backups_list( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.BigtableAdmin.V2.Model.ListBackupsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists Cloud Bigtable backups. Returns both completed and pending backups.
Parameters
-
connection
(type:GoogleApi.BigtableAdmin.V2.Connection.t
) - Connection to server -
projects_id
(type:String.t
) - Part ofparent
. Required. The cluster to list backups from. Values are of the formprojects/{project}/instances/{instance}/clusters/{cluster}
. Use{cluster} = '-'
to list backups for all clusters in an instance, e.g.,projects/{project}/instances/{instance}/clusters/-
. -
instances_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
clusters_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
. -
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 backups listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be <, >, <=, >=, !=, =, or :. Colon ':' represents a HAS operator which is roughly synonymous with equality. Filter rules are case insensitive. The fields eligible for filtering are:name
source_table
state
start_time
(and values are of the format YYYY-MM-DDTHH:MM:SSZ)end_time
(and values are of the format YYYY-MM-DDTHH:MM:SSZ)expire_time
(and values are of the format YYYY-MM-DDTHH:MM:SSZ)size_bytes
To filter on multiple expressions, provide each separate expression within parentheses. By default, each expression is an AND expression. However, you can include AND, OR, and NOT expressions explicitly. Some examples of using filters are:name:"exact"
--> The backup's name is the string "exact".name:howl
--> The backup's name contains the string "howl".source_table:prod
--> The source_table's name contains the string "prod".state:CREATING
--> The backup is pending creation.state:READY
--> The backup is fully created and ready for use.(name:howl) AND (start_time < \"2018-03-28T14:50:00Z\")
--> The backup name contains the string "howl" and start_time of the backup is before 2018-03-28T14:50:00Z.size_bytes > 10000000000
--> The backup's size is greater than 10GB -
:orderBy
(type:String.t
) - An expression for specifying the sort order of the results of the request. The string value should specify one or more fields in Backup. The full syntax is described at https://aip.dev/132#ordering. Fields supported are: name source_table expire_time start_time end_time size_bytes * state For example, "start_time". The default sorting order is ascending. To specify descending order for the field, a suffix " desc" should be appended to the field name. For example, "start_time desc". Redundant space characters in the syntax are insigificant. If order_by is empty, results will be sorted bystart_time
in descending order starting from the most recently created backup. -
:pageSize
(type:integer()
) - Number of backups to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. -
:pageToken
(type:String.t
) - If non-empty,page_token
should contain a next_page_token from a previous ListBackupsResponse to the sameparent
and with the samefilter
.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.BigtableAdmin.V2.Model.ListBackupsResponse{}}
on success -
{:error, info}
on failure