Struct google_cloudtasks2_beta2::ProjectMethods[−][src]

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

A builder providing access to all methods supported on project resources. It is not used directly, but through the CloudTasks hub.

Example

Instantiate a resource builder

extern crate hyper;
extern crate hyper_rustls;
extern crate yup_oauth2 as oauth2;
extern crate google_cloudtasks2_beta2 as cloudtasks2_beta2;
 
use std::default::Default;
use oauth2::{Authenticator, DefaultAuthenticatorDelegate, ApplicationSecret, MemoryStorage};
use cloudtasks2_beta2::CloudTasks;
 
let secret: ApplicationSecret = Default::default();
let auth = Authenticator::new(&secret, DefaultAuthenticatorDelegate,
                              hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())),
                              <MemoryStorage as Default>::default(), None);
let mut hub = CloudTasks::new(hyper::Client::with_connector(hyper::net::HttpsConnector::new(hyper_rustls::TlsClient::new())), auth);
// Usually you wouldn't bind this to a variable, but keep calling *CallBuilders*
// like `locations_get(...)`, `locations_list(...)`, `locations_queues_create(...)`, `locations_queues_delete(...)`, `locations_queues_get(...)`, `locations_queues_get_iam_policy(...)`, `locations_queues_list(...)`, `locations_queues_patch(...)`, `locations_queues_pause(...)`, `locations_queues_purge(...)`, `locations_queues_resume(...)`, `locations_queues_set_iam_policy(...)`, `locations_queues_tasks_acknowledge(...)`, `locations_queues_tasks_cancel_lease(...)`, `locations_queues_tasks_create(...)`, `locations_queues_tasks_delete(...)`, `locations_queues_tasks_get(...)`, `locations_queues_tasks_lease(...)`, `locations_queues_tasks_list(...)`, `locations_queues_tasks_renew_lease(...)`, `locations_queues_tasks_run(...)` and `locations_queues_test_iam_permissions(...)`
// to build up your call.
let rb = hub.projects();

Methods

`impl<'a, C, A> ProjectMethods<'a, C, A>`
[src]

`pub fn locations_queues_tasks_get( &self, name: &str ) -> ProjectLocationQueueTaskGetCall<'a, C, A>`
[src]

Create a builder to help you perform the following task:

Gets a task.

Arguments

name - Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID

`pub fn locations_queues_tasks_list( &self, parent: &str ) -> ProjectLocationQueueTaskListCall<'a, C, A>`
[src]

Create a builder to help you perform the following task:

Lists the tasks in a queue.

By default, only the BASIC view is retrieved due to performance considerations; response_view controls the subset of information which is returned.

The tasks may be returned in any order. The ordering may change at any time.

Arguments

parent - Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

`pub fn locations_queues_delete( &self, name: &str ) -> ProjectLocationQueueDeleteCall<'a, C, A>`
[src]

Create a builder to help you perform the following task:

Deletes a queue.

This command will delete the queue even if it has tasks in it.

Note: If you delete a queue, a queue with the same name can't be created for 7 days.

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.

Arguments

name - Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

`pub fn locations_queues_set_iam_policy( &self, request: SetIamPolicyRequest, resource: &str ) -> ProjectLocationQueueSetIamPolicyCall<'a, C, A>`
[src]

Create a builder to help you perform the following task:

Sets the access control policy for a Queue. Replaces any existing policy.

Note: The Cloud Console does not check queue-level IAM permissions yet. Project-level permissions are required to use the Cloud Console.

Authorization requires the following Google IAM permission on the specified resource parent:

cloudtasks.queues.setIamPolicy

Arguments

request - No description provided.
resource - REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

`pub fn locations_queues_patch( &self, request: Queue, name: &str ) -> ProjectLocationQueuePatchCall<'a, C, A>`
[src]

Create a builder to help you perform the following task:

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.

Arguments

request - No description provided.
name - 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.

`pub fn locations_queues_create( &self, request: Queue, parent: &str ) -> ProjectLocationQueueCreateCall<'a, C, A>`
[src]

Create a builder to help you perform the following task:

Creates a queue.

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.

Arguments

request - No description provided.
parent - Required. The location name in which the queue will be created. For example: projects/PROJECT_ID/locations/LOCATION_ID The list of allowed locations can be obtained by calling Cloud Tasks' implementation of ListLocations.

`pub fn locations_queues_get( &self, name: &str ) -> ProjectLocationQueueGetCall<'a, C, A>`
[src]

Create a builder to help you perform the following task:

Gets a queue.

Arguments

name - Required. The resource name of the queue. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

`pub fn locations_queues_tasks_create( &self, request: CreateTaskRequest, parent: &str ) -> ProjectLocationQueueTaskCreateCall<'a, C, A>`
[src]

Create a builder to help you perform the following task:

Creates a task and adds it to a queue.

Tasks cannot be updated after creation; there is no UpdateTask command.

For App Engine queues, the maximum task size is 100KB.
For pull queues, the maximum task size is 1MB.

Arguments

request - No description provided.
parent - Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID The queue must already exist.

`pub fn locations_queues_tasks_delete( &self, name: &str ) -> ProjectLocationQueueTaskDeleteCall<'a, C, A>`
[src]

Create a builder to help you perform the following task:

Deletes a task.

A task can be deleted if it is scheduled or dispatched. A task cannot be deleted if it has completed successfully or permanently failed.

Arguments

name - Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID

`pub fn locations_queues_tasks_acknowledge( &self, request: AcknowledgeTaskRequest, name: &str ) -> ProjectLocationQueueTaskAcknowledgeCall<'a, C, A>`
[src]

Create a builder to help you perform the following task:

Acknowledges a pull task.

The worker, that is, the entity that leased this task must call this method to indicate that the work associated with the task has finished.

The worker must acknowledge a task within the lease_duration or the lease will expire and the task will become available to be leased again. After the task is acknowledged, it will not be returned by a later LeaseTasks, GetTask, or ListTasks.

Arguments

request - No description provided.
name - Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID

`pub fn locations_queues_resume( &self, request: ResumeQueueRequest, name: &str ) -> ProjectLocationQueueResumeCall<'a, C, A>`
[src]

Create a builder to help you perform the following task:

Resume a queue.

This method resumes a queue after it has been PAUSED or DISABLED. The state of a queue is stored in the queue's state; after calling this method it will be set to RUNNING.

WARNING: Resuming many high-QPS queues at the same time can lead to target overloading. If you are resuming high-QPS queues, follow the 500/50/5 pattern described in Managing Cloud Tasks Scaling Risks.

Arguments

request - No description provided.
name - Required. The queue name. For example: projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID

`pub fn locations_queues_tasks_cancel_lease( &self, request: CancelLeaseRequest, name: &str ) -> ProjectLocationQueueTaskCancelLeaseCall<'a, C, A>`
[src]

Create a builder to help you perform the following task:

Cancel a pull task's lease.

The worker can use this method to cancel a task's lease by setting its schedule_time to now. This will make the task available to be leased to the next caller of LeaseTasks.

Arguments

request - No description provided.
name - Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID

`pub fn locations_queues_list( &self, parent: &str ) -> ProjectLocationQueueListCall<'a, C, A>`
[src]

Create a builder to help you perform the following task:

Lists queues.

Queues are returned in lexicographical order.

Arguments

parent - Required. The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID

`pub fn locations_queues_tasks_run( &self, request: RunTaskRequest, name: &str ) -> ProjectLocationQueueTaskRunCall<'a, C, A>`
[src]

Create a builder to help you perform the following task:

Forces a task to run now.

When this method is called, Cloud Tasks will dispatch the task, even if the task is already running, the queue has reached its RateLimits or is PAUSED.

This command is meant to be used for manual debugging. For example, RunTask can be used to retry a failed task after a fix has been made or to manually force a task to be dispatched now.

The dispatched task is returned. That is, the task that is returned contains the status after the task is dispatched but before the task is received by its target.

If Cloud Tasks receives a successful response from the task's target, then the task will be deleted; otherwise the task's schedule_time will be reset to the time that RunTask was called plus the retry delay specified in the queue's RetryConfig.

RunTask returns NOT_FOUND when it is called on a task that has already succeeded or permanently failed.

RunTask cannot be called on a pull task.

Arguments

request - No description provided.
name - Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID

`pub fn locations_queues_pause( &self, request: PauseQueueRequest, name: &str ) -> ProjectLocationQueuePauseCall<'a, C, A>`
[src]

Create a builder to help you perform the following task:

Pauses the queue.

If a queue is paused then the system will stop dispatching tasks until the queue is resumed via ResumeQueue. Tasks can still be added when the queue is paused. A queue is paused if its state is PAUSED.

Arguments

request - No description provided.
name - Required. The queue name. For example: projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID

`pub fn locations_queues_get_iam_policy( &self, request: GetIamPolicyRequest, resource: &str ) -> ProjectLocationQueueGetIamPolicyCall<'a, C, A>`
[src]

Create a builder to help you perform the following task:

Gets the access control policy for a Queue. Returns an empty policy if the resource exists and does not have a policy set.

Authorization requires the following Google IAM permission on the specified resource parent:

cloudtasks.queues.getIamPolicy

Arguments

request - No description provided.
resource - REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

`pub fn locations_get(&self, name: &str) -> ProjectLocationGetCall<'a, C, A>`
[src]

Create a builder to help you perform the following task:

Gets information about a location.

Arguments

name - Resource name for the location.

`pub fn locations_queues_tasks_renew_lease( &self, request: RenewLeaseRequest, name: &str ) -> ProjectLocationQueueTaskRenewLeaseCall<'a, C, A>`
[src]

Create a builder to help you perform the following task:

Renew the current lease of a pull task.

The worker can use this method to extend the lease by a new duration, starting from now. The new task lease will be returned in the task's schedule_time.

Arguments

request - No description provided.
name - Required. The task name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID

`pub fn locations_queues_tasks_lease( &self, request: LeaseTasksRequest, parent: &str ) -> ProjectLocationQueueTaskLeaseCall<'a, C, A>`
[src]

Create a builder to help you perform the following task:

Leases tasks from a pull queue for lease_duration.

This method is invoked by the worker to obtain a lease. The worker must acknowledge the task via AcknowledgeTask after they have performed the work associated with the task.

The payload is intended to store data that the worker needs to perform the work associated with the task. To return the payloads in the response, set response_view to FULL.

A maximum of 10 qps of LeaseTasks requests are allowed per queue. RESOURCE_EXHAUSTED is returned when this limit is exceeded. RESOURCE_EXHAUSTED is also returned when max_tasks_dispatched_per_second is exceeded.

Arguments

request - No description provided.
parent - Required. The queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID

`pub fn locations_list(&self, name: &str) -> ProjectLocationListCall<'a, C, A>`
[src]

Create a builder to help you perform the following task:

Lists information about the supported locations for this service.

Arguments

name - The resource that owns the locations collection, if applicable.

`pub fn locations_queues_test_iam_permissions( &self, request: TestIamPermissionsRequest, resource: &str ) -> ProjectLocationQueueTestIamPermissionCall<'a, C, A>`
[src]

Create a builder to help you perform the following task:

Returns permissions that a caller has on a Queue. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Arguments

request - No description provided.
resource - REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

`pub fn locations_queues_purge( &self, request: PurgeQueueRequest, name: &str ) -> ProjectLocationQueuePurgeCall<'a, C, A>`
[src]

Create a builder to help you perform the following task:

Purges a queue by deleting all of its tasks.

All tasks created before this method is called are permanently deleted.

Purge operations can take up to one minute to take effect. Tasks might be dispatched before the purge takes effect. A purge is irreversible.

Arguments

request - No description provided.
name - Required. The queue name. For example: projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID

Struct google_cloudtasks2_beta2::ProjectMethods[−][src]

Methods

impl<'a, C, A> ProjectMethods<'a, C, A>[src]

pub fn locations_queues_tasks_get( &self, name: &str) -> ProjectLocationQueueTaskGetCall<'a, C, A>[src]

pub fn locations_queues_tasks_list( &self, parent: &str) -> ProjectLocationQueueTaskListCall<'a, C, A>[src]

pub fn locations_queues_delete( &self, name: &str) -> ProjectLocationQueueDeleteCall<'a, C, A>[src]

pub fn locations_queues_set_iam_policy( &self, request: SetIamPolicyRequest, resource: &str) -> ProjectLocationQueueSetIamPolicyCall<'a, C, A>[src]

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

pub fn locations_queues_create( &self, request: Queue, parent: &str) -> ProjectLocationQueueCreateCall<'a, C, A>[src]

pub fn locations_queues_get( &self, name: &str) -> ProjectLocationQueueGetCall<'a, C, A>[src]

pub fn locations_queues_tasks_create( &self, request: CreateTaskRequest, parent: &str) -> ProjectLocationQueueTaskCreateCall<'a, C, A>[src]

pub fn locations_queues_tasks_delete( &self, name: &str) -> ProjectLocationQueueTaskDeleteCall<'a, C, A>[src]

pub fn locations_queues_tasks_acknowledge( &self, request: AcknowledgeTaskRequest, name: &str) -> ProjectLocationQueueTaskAcknowledgeCall<'a, C, A>[src]

pub fn locations_queues_resume( &self, request: ResumeQueueRequest, name: &str) -> ProjectLocationQueueResumeCall<'a, C, A>[src]

pub fn locations_queues_tasks_cancel_lease( &self, request: CancelLeaseRequest, name: &str) -> ProjectLocationQueueTaskCancelLeaseCall<'a, C, A>[src]

pub fn locations_queues_list( &self, parent: &str) -> ProjectLocationQueueListCall<'a, C, A>[src]

pub fn locations_queues_tasks_run( &self, request: RunTaskRequest, name: &str) -> ProjectLocationQueueTaskRunCall<'a, C, A>[src]

pub fn locations_queues_pause( &self, request: PauseQueueRequest, name: &str) -> ProjectLocationQueuePauseCall<'a, C, A>[src]

pub fn locations_queues_get_iam_policy( &self, request: GetIamPolicyRequest, resource: &str) -> ProjectLocationQueueGetIamPolicyCall<'a, C, A>[src]

pub fn locations_get(&self, name: &str) -> ProjectLocationGetCall<'a, C, A>[src]

pub fn locations_queues_tasks_renew_lease( &self, request: RenewLeaseRequest, name: &str) -> ProjectLocationQueueTaskRenewLeaseCall<'a, C, A>[src]

pub fn locations_queues_tasks_lease( &self, request: LeaseTasksRequest, parent: &str) -> ProjectLocationQueueTaskLeaseCall<'a, C, A>[src]

pub fn locations_list(&self, name: &str) -> ProjectLocationListCall<'a, C, A>[src]

pub fn locations_queues_test_iam_permissions( &self, request: TestIamPermissionsRequest, resource: &str) -> ProjectLocationQueueTestIamPermissionCall<'a, C, A>[src]

pub fn locations_queues_purge( &self, request: PurgeQueueRequest, name: &str) -> ProjectLocationQueuePurgeCall<'a, C, A>[src]

Trait Implementations

impl<'a, C, A> MethodsBuilder for ProjectMethods<'a, C, A>[src]

Auto Trait Implementations

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

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

`impl<'a, C, A> ProjectMethods<'a, C, A>`
[src]

`pub fn locations_queues_tasks_get( &self, name: &str ) -> ProjectLocationQueueTaskGetCall<'a, C, A>`
[src]

`pub fn locations_queues_tasks_list( &self, parent: &str ) -> ProjectLocationQueueTaskListCall<'a, C, A>`
[src]

`pub fn locations_queues_delete( &self, name: &str ) -> ProjectLocationQueueDeleteCall<'a, C, A>`
[src]

`pub fn locations_queues_set_iam_policy( &self, request: SetIamPolicyRequest, resource: &str ) -> ProjectLocationQueueSetIamPolicyCall<'a, C, A>`
[src]

`pub fn locations_queues_patch( &self, request: Queue, name: &str ) -> ProjectLocationQueuePatchCall<'a, C, A>`
[src]

`pub fn locations_queues_create( &self, request: Queue, parent: &str ) -> ProjectLocationQueueCreateCall<'a, C, A>`
[src]

`pub fn locations_queues_get( &self, name: &str ) -> ProjectLocationQueueGetCall<'a, C, A>`
[src]

`pub fn locations_queues_tasks_create( &self, request: CreateTaskRequest, parent: &str ) -> ProjectLocationQueueTaskCreateCall<'a, C, A>`
[src]

`pub fn locations_queues_tasks_delete( &self, name: &str ) -> ProjectLocationQueueTaskDeleteCall<'a, C, A>`
[src]

`pub fn locations_queues_tasks_acknowledge( &self, request: AcknowledgeTaskRequest, name: &str ) -> ProjectLocationQueueTaskAcknowledgeCall<'a, C, A>`
[src]

`pub fn locations_queues_resume( &self, request: ResumeQueueRequest, name: &str ) -> ProjectLocationQueueResumeCall<'a, C, A>`
[src]

`pub fn locations_queues_tasks_cancel_lease( &self, request: CancelLeaseRequest, name: &str ) -> ProjectLocationQueueTaskCancelLeaseCall<'a, C, A>`
[src]

`pub fn locations_queues_list( &self, parent: &str ) -> ProjectLocationQueueListCall<'a, C, A>`
[src]

`pub fn locations_queues_tasks_run( &self, request: RunTaskRequest, name: &str ) -> ProjectLocationQueueTaskRunCall<'a, C, A>`
[src]

`pub fn locations_queues_pause( &self, request: PauseQueueRequest, name: &str ) -> ProjectLocationQueuePauseCall<'a, C, A>`
[src]

`pub fn locations_queues_get_iam_policy( &self, request: GetIamPolicyRequest, resource: &str ) -> ProjectLocationQueueGetIamPolicyCall<'a, C, A>`
[src]

`pub fn locations_get(&self, name: &str) -> ProjectLocationGetCall<'a, C, A>`
[src]

`pub fn locations_queues_tasks_renew_lease( &self, request: RenewLeaseRequest, name: &str ) -> ProjectLocationQueueTaskRenewLeaseCall<'a, C, A>`
[src]

`pub fn locations_queues_tasks_lease( &self, request: LeaseTasksRequest, parent: &str ) -> ProjectLocationQueueTaskLeaseCall<'a, C, A>`
[src]

`pub fn locations_list(&self, name: &str) -> ProjectLocationListCall<'a, C, A>`
[src]

`pub fn locations_queues_test_iam_permissions( &self, request: TestIamPermissionsRequest, resource: &str ) -> ProjectLocationQueueTestIamPermissionCall<'a, C, A>`
[src]

`pub fn locations_queues_purge( &self, request: PurgeQueueRequest, name: &str ) -> ProjectLocationQueuePurgeCall<'a, C, A>`
[src]

`impl<'a, C, A> MethodsBuilder for ProjectMethods<'a, C, A>`
[src]

`impl<'a, C, A> !Send for ProjectMethods<'a, C, A>`

`impl<'a, C, A> !Sync for ProjectMethods<'a, C, A>`