[][src]Struct google_cloudtasks2_beta3::ProjectLocationQueuePatchCall

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

Updates a queue.

This method creates the queue if it does not exist and updates the queue if it does exist.

Queues created with this method allow tasks to live for a maximum of 31 days. After a task is 31 days old, the task will be deleted regardless of whether it was dispatched or not.

WARNING: Using this method may have unintended side effects if you are using an App Engine queue.yaml or queue.xml file to manage your queues. Read Overview of Queue Management and queue.yaml before using this method.

A builder for the locations.queues.patch method supported by a project resource. It is not used directly, but through a ProjectMethods instance.

Example

Instantiate a resource method builder

use cloudtasks2_beta3::Queue;
 
// 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 = Queue::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.projects().locations_queues_patch(req, "name")
             .update_mask("sadipscing")
             .doit();

Implementations

impl<'a, C, A> ProjectLocationQueuePatchCall<'a, C, A> where
    C: BorrowMut<Client>,
    A: GetToken
[src]

pub fn doit(self) -> Result<(Response, Queue)>[src]

Perform the operation you have build so far.

pub fn request(
    self,
    new_value: Queue
) -> ProjectLocationQueuePatchCall<'a, C, A>
[src]

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 name(self, new_value: &str) -> ProjectLocationQueuePatchCall<'a, C, A>[src]

Caller-specified and required in CreateQueue, after which it becomes output only.

The queue name.

The queue name must have the following format: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

  • PROJECT_ID can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see Identifying projects
  • LOCATION_ID is the canonical ID for the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/.
  • QUEUE_ID can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters.

Sets the name 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 update_mask(
    self,
    new_value: &str
) -> ProjectLocationQueuePatchCall<'a, C, A>
[src]

A mask used to specify which fields of the queue are being updated.

If empty, then all fields will be updated.

Sets the update mask query property to the given value.

pub fn delegate(
    self,
    new_value: &'a mut dyn Delegate
) -> ProjectLocationQueuePatchCall<'a, C, A>
[src]

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
) -> ProjectLocationQueuePatchCall<'a, C, A> where
    T: AsRef<str>, 
[src]

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

  • upload_protocol (query-string) - Upload protocol for media (e.g. "raw", "multipart").
  • prettyPrint (query-boolean) - Returns response with indentations and line breaks.
  • access_token (query-string) - OAuth access token.
  • fields (query-string) - Selector specifying which fields to include in a partial response.
  • 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.
  • callback (query-string) - JSONP
  • 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.
  • uploadType (query-string) - Legacy upload protocol for media (e.g. "media", "multipart").
  • alt (query-string) - Data format for response.
  • $.xgafv (query-string) - V1 error format.

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

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 ProjectLocationQueuePatchCall<'a, C, A>[src]

Auto Trait Implementations

impl<'a, C, A> !RefUnwindSafe for ProjectLocationQueuePatchCall<'a, C, A>

impl<'a, C, A> !Send for ProjectLocationQueuePatchCall<'a, C, A>

impl<'a, C, A> !Sync for ProjectLocationQueuePatchCall<'a, C, A>

impl<'a, C, A> Unpin for ProjectLocationQueuePatchCall<'a, C, A>

impl<'a, C, A> !UnwindSafe for ProjectLocationQueuePatchCall<'a, C, A>

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> Typeable for T where
    T: Any