pub struct ProjectInstanceClusterBackupListCall<'a, S>where
S: 'a,{ /* private fields */ }
Expand description
Lists Cloud Bigtable backups. Returns both completed and pending backups.
A builder for the instances.clusters.backups.list method supported by a project resource.
It is not used directly, but through a ProjectMethods
instance.
§Example
Instantiate a resource method builder
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.projects().instances_clusters_backups_list("parent")
.page_token("labore")
.page_size(-43)
.order_by("duo")
.filter("sed")
.doit().await;
Implementations§
source§impl<'a, S> ProjectInstanceClusterBackupListCall<'a, S>
impl<'a, S> ProjectInstanceClusterBackupListCall<'a, S>
sourcepub async fn doit(self) -> Result<(Response<Body>, ListBackupsResponse)>
pub async fn doit(self) -> Result<(Response<Body>, ListBackupsResponse)>
Perform the operation you have build so far.
sourcepub fn parent(
self,
new_value: &str
) -> ProjectInstanceClusterBackupListCall<'a, S>
pub fn parent( self, new_value: &str ) -> ProjectInstanceClusterBackupListCall<'a, S>
Required. The cluster to list backups from. Values are of the form projects/{project}/instances/{instance}/clusters/{cluster}
. Use {cluster} = '-'
to list backups for all clusters in an instance, e.g., projects/{project}/instances/{instance}/clusters/-
.
Sets the parent path property to the given value.
Even though the property as already been set when instantiating this call, we provide this method for API completeness.
sourcepub fn page_token(
self,
new_value: &str
) -> ProjectInstanceClusterBackupListCall<'a, S>
pub fn page_token( self, new_value: &str ) -> ProjectInstanceClusterBackupListCall<'a, S>
If non-empty, page_token
should contain a next_page_token from a previous ListBackupsResponse to the same parent
and with the same filter
.
Sets the page token query property to the given value.
sourcepub fn page_size(
self,
new_value: i32
) -> ProjectInstanceClusterBackupListCall<'a, S>
pub fn page_size( self, new_value: i32 ) -> ProjectInstanceClusterBackupListCall<'a, S>
Number of backups to be returned in the response. If 0 or less, defaults to the server’s maximum allowed page size.
Sets the page size query property to the given value.
sourcepub fn order_by(
self,
new_value: &str
) -> ProjectInstanceClusterBackupListCall<'a, S>
pub fn order_by( self, new_value: &str ) -> ProjectInstanceClusterBackupListCall<'a, S>
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 by start_time
in descending order starting from the most recently created backup.
Sets the order by query property to the given value.
sourcepub fn filter(
self,
new_value: &str
) -> ProjectInstanceClusterBackupListCall<'a, S>
pub fn filter( self, new_value: &str ) -> ProjectInstanceClusterBackupListCall<'a, S>
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
Sets the filter query property to the given value.
sourcepub fn delegate(
self,
new_value: &'a mut dyn Delegate
) -> ProjectInstanceClusterBackupListCall<'a, S>
pub fn delegate( self, new_value: &'a mut dyn Delegate ) -> ProjectInstanceClusterBackupListCall<'a, S>
The delegate implementation is consulted whenever there is an intermediate result, or if something goes wrong while executing the actual API request.
It should be used to handle progress information, and to implement a certain level of resilience.
Sets the delegate property to the given value.
sourcepub fn param<T>(
self,
name: T,
value: T
) -> ProjectInstanceClusterBackupListCall<'a, S>
pub fn param<T>( self, name: T, value: T ) -> ProjectInstanceClusterBackupListCall<'a, S>
Set any additional parameter of the query string used in the request. It should be used to set parameters which are not yet available through their own setters.
Please note that this method must not be used to set any of the known parameters which have their own setter method. If done anyway, the request will fail.
§Additional Parameters
- $.xgafv (query-string) - V1 error format.
- access_token (query-string) - OAuth access token.
- alt (query-string) - Data format for response.
- callback (query-string) - JSONP
- fields (query-string) - Selector specifying which fields to include in a partial response.
- key (query-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 (query-string) - OAuth 2.0 token for the current user.
- prettyPrint (query-boolean) - Returns response with indentations and line breaks.
- quotaUser (query-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.
- uploadType (query-string) - Legacy upload protocol for media (e.g. “media”, “multipart”).
- upload_protocol (query-string) - Upload protocol for media (e.g. “raw”, “multipart”).
sourcepub fn add_scope<St>(
self,
scope: St
) -> ProjectInstanceClusterBackupListCall<'a, S>
pub fn add_scope<St>( self, scope: St ) -> ProjectInstanceClusterBackupListCall<'a, S>
Identifies the authorization scope for the method you are building.
Use this method to actively specify which scope should be used, instead of the default Scope
variant
Scope::BigtableAdmin
.
The scope
will be added to a set of scopes. This is important as one can maintain access
tokens for more than one scope.
Usually there is more than one suitable scope to authorize an operation, some of which may encompass more rights than others. For example, for listing resources, a read-only scope will be sufficient, a read-write scope will do as well.
sourcepub fn add_scopes<I, St>(
self,
scopes: I
) -> ProjectInstanceClusterBackupListCall<'a, S>
pub fn add_scopes<I, St>( self, scopes: I ) -> ProjectInstanceClusterBackupListCall<'a, S>
Identifies the authorization scope(s) for the method you are building.
See Self::add_scope()
for details.
sourcepub fn clear_scopes(self) -> ProjectInstanceClusterBackupListCall<'a, S>
pub fn clear_scopes(self) -> ProjectInstanceClusterBackupListCall<'a, S>
Removes all scopes, and no default scope will be used either.
In this case, you have to specify your API-key using the key
parameter (see Self::param()
for details).