Struct google_storage1::ObjectWatchAllCall

pub struct ObjectWatchAllCall<'a, C, A> where
    C: 'a,
    A: 'a,  { /* fields omitted */ }

Watch for changes on all objects in a bucket.

A builder for the watchAll method supported by a object resource. It is not used directly, but through a ObjectMethods instance.

Example

Instantiate a resource method builder

use storage1::Channel;
 
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = Channel::default();
 
// 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.objects().watch_all(req, "bucket")
             .versions(true)
             .user_project("ut")
             .projection("dolores")
             .prefix("eos")
             .page_token("voluptua.")
             .max_results(82)
             .include_trailing_delimiter(false)
             .delimiter("aliquyam")
             .doit();

Methods

impl<'a, C, A> ObjectWatchAllCall<'a, C, A> where     C: BorrowMut<Client>,     A: GetToken,

pub fn doit(self) -> Result<(Response, Channel)>

Perform the operation you have build so far.

pub fn request(self, new_value: Channel) -> ObjectWatchAllCall<'a, C, A>

Sets the request property to the given value.

Even though the property as already been set when instantiating this call, we provide this method for API completeness.

pub fn bucket(self, new_value: &str) -> ObjectWatchAllCall<'a, C, A>

Name of the bucket in which to look for objects.

Sets the bucket 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.

pub fn versions(self, new_value: bool) -> ObjectWatchAllCall<'a, C, A>

If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.

Sets the versions query property to the given value.

pub fn user_project(self, new_value: &str) -> ObjectWatchAllCall<'a, C, A>

The project to be billed for this request. Required for Requester Pays buckets.

Sets the user project query property to the given value.

pub fn projection(self, new_value: &str) -> ObjectWatchAllCall<'a, C, A>

Set of properties to return. Defaults to noAcl.

Sets the projection query property to the given value.

pub fn prefix(self, new_value: &str) -> ObjectWatchAllCall<'a, C, A>

Filter results to objects whose names begin with this prefix.

Sets the prefix query property to the given value.

pub fn page_token(self, new_value: &str) -> ObjectWatchAllCall<'a, C, A>

A previously-returned page token representing part of the larger set of results to view.

Sets the page token query property to the given value.

pub fn max_results(self, new_value: u32) -> ObjectWatchAllCall<'a, C, A>

Maximum number of items plus prefixes to return in a single page of responses. As duplicate prefixes are omitted, fewer total results may be returned than requested. The service will use this parameter or 1,000 items, whichever is smaller.

Sets the max results query property to the given value.

pub fn include_trailing_delimiter(     self,     new_value: bool ) -> ObjectWatchAllCall<'a, C, A>

If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes.

Sets the include trailing delimiter query property to the given value.

pub fn delimiter(self, new_value: &str) -> ObjectWatchAllCall<'a, C, A>

Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted.

Sets the delimiter query property to the given value.

pub fn delegate(     self,     new_value: &'a mut Delegate ) -> ObjectWatchAllCall<'a, C, A>

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.

pub fn param<T>(self, name: T, value: T) -> ObjectWatchAllCall<'a, C, A> where     T: AsRef<str>,

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 paramters which have their own setter method. If done anyway, the request will fail.

Additional Parameters

• quotaUser (query-string) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
• oauth_token (query-string) - OAuth 2.0 token for the current user.
• 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.
• prettyPrint (query-boolean) - Returns response with indentations and line breaks.
• userIp (query-string) - Deprecated. Please use quotaUser instead.
• fields (query-string) - Selector specifying which fields to include in a partial response.
• alt (query-string) - Data format for the response.

pub fn add_scope<T, S>(self, scope: T) -> ObjectWatchAllCall<'a, C, A> where     T: Into<Option<S>>,     S: AsRef<str>,

Identifies the authorization scope for the method you are building.

Use this method to actively specify which scope should be used, instead the default Scope variant Scope::CloudPlatform.

The scope will be added to a set of scopes. This is important as one can maintain access tokens for more than one scope. If None is specified, then all scopes will be removed and no default scope will be used either. In that case, you have to specify your API-key using the key parameter (see the param() function for details).

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.

Trait Implementations

impl<'a, C, A> CallBuilder for ObjectWatchAllCall<'a, C, A>