happygapi.cloudtasks.projects — happygapi 0.4.8

Cloud Tasks API: projects. Manages the execution of large numbers of distributed requests. See: https://cloud.google.com/tasks/api/reference/rest/v2/projects

locations-get$ clj

(locations-get$ auth parameters)

https://cloud.google.com/tasks/api/reference/rest/v2/projects/locations/get

Required parameters: name

Optional parameters: none

Gets information about a location.

locations-list$ clj

(locations-list$ auth parameters)

https://cloud.google.com/tasks/api/reference/rest/v2/projects/locations/list

Required parameters: name

Optional parameters: pageToken, filter, pageSize

Lists information about the supported locations for this service.

locations-queues-create$ clj

(locations-queues-create$ auth parameters body)

https://cloud.google.com/tasks/api/reference/rest/v2/projects/locations/queues/create

Required parameters: parent

Optional parameters: none

Body:

{:stackdriverLoggingConfig {:samplingRatio number}, :rateLimits {:maxDispatchesPerSecond number, :maxConcurrentDispatches integer, :maxBurstSize integer}, :name string, :purgeTime string, :retryConfig {:maxDoublings integer, :maxAttempts integer, :maxBackoff string, :minBackoff string, :maxRetryDuration string}, :appEngineRoutingOverride {:instance string, :version string, :host string, :service string}, :state string}

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.

locations-queues-delete$ clj

(locations-queues-delete$ auth parameters)

https://cloud.google.com/tasks/api/reference/rest/v2/projects/locations/queues/delete

Required parameters: name

Optional parameters: none

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.

locations-queues-get$ clj

(locations-queues-get$ auth parameters)

https://cloud.google.com/tasks/api/reference/rest/v2/projects/locations/queues/get

Required parameters: name

Optional parameters: none

Gets a queue.

locations-queues-getIamPolicy$ clj

(locations-queues-getIamPolicy$ auth parameters body)

https://cloud.google.com/tasks/api/reference/rest/v2/projects/locations/queues/getIamPolicy

Required parameters: resource

Optional parameters: none

Body:

{:options {:requestedPolicyVersion integer}}

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

locations-queues-list$ clj

(locations-queues-list$ auth parameters)

https://cloud.google.com/tasks/api/reference/rest/v2/projects/locations/queues/list

Required parameters: parent

Optional parameters: pageSize, pageToken, filter

Lists queues. Queues are returned in lexicographical order.

locations-queues-patch$ clj

(locations-queues-patch$ auth parameters body)

https://cloud.google.com/tasks/api/reference/rest/v2/projects/locations/queues/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:stackdriverLoggingConfig {:samplingRatio number}, :rateLimits {:maxDispatchesPerSecond number, :maxConcurrentDispatches integer, :maxBurstSize integer}, :name string, :purgeTime string, :retryConfig {:maxDoublings integer, :maxAttempts integer, :maxBackoff string, :minBackoff string, :maxRetryDuration string}, :appEngineRoutingOverride {:instance string, :version string, :host string, :service string}, :state string}

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.

locations-queues-pause$ clj

(locations-queues-pause$ auth parameters body)

https://cloud.google.com/tasks/api/reference/rest/v2/projects/locations/queues/pause

Required parameters: name

Optional parameters: none

Body:

{}

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.

locations-queues-purge$ clj

(locations-queues-purge$ auth parameters body)

https://cloud.google.com/tasks/api/reference/rest/v2/projects/locations/queues/purge

Required parameters: name

Optional parameters: none

Body:

{}

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.

locations-queues-resume$ clj

(locations-queues-resume$ auth parameters body)

https://cloud.google.com/tasks/api/reference/rest/v2/projects/locations/queues/resume

Required parameters: name

Optional parameters: none

Body:

{}

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.

locations-queues-setIamPolicy$ clj

(locations-queues-setIamPolicy$ auth parameters body)

https://cloud.google.com/tasks/api/reference/rest/v2/projects/locations/queues/setIamPolicy

Required parameters: resource

Optional parameters: none

Body:

{:policy {:etag string, :bindings [Binding], :version integer}}

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

locations-queues-tasks-create$ clj

(locations-queues-tasks-create$ auth parameters body)

https://cloud.google.com/tasks/api/reference/rest/v2/projects/locations/queues/tasks/create

Required parameters: parent

Optional parameters: none

Body:

{:responseView string, :task {:responseCount integer, :dispatchCount integer, :name string, :scheduleTime string, :createTime string, :firstAttempt Attempt, :dispatchDeadline string, :httpRequest HttpRequest, :appEngineHttpRequest AppEngineHttpRequest, :view string, :lastAttempt Attempt}}

Creates a task and adds it to a queue. Tasks cannot be updated after creation; there is no UpdateTask command. * The maximum task size is 100KB.

locations-queues-tasks-delete$ clj

(locations-queues-tasks-delete$ auth parameters)

https://cloud.google.com/tasks/api/reference/rest/v2/projects/locations/queues/tasks/delete

Required parameters: name

Optional parameters: none

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

locations-queues-tasks-get$ clj

(locations-queues-tasks-get$ auth parameters)

https://cloud.google.com/tasks/api/reference/rest/v2/projects/locations/queues/tasks/get

Required parameters: name

Optional parameters: responseView

Gets a task.

locations-queues-tasks-list$ clj

(locations-queues-tasks-list$ auth parameters)

https://cloud.google.com/tasks/api/reference/rest/v2/projects/locations/queues/tasks/list

Required parameters: parent

Optional parameters: pageToken, responseView, pageSize

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.

locations-queues-tasks-run$ clj

(locations-queues-tasks-run$ auth parameters body)

https://cloud.google.com/tasks/api/reference/rest/v2/projects/locations/queues/tasks/run

Required parameters: name

Optional parameters: none

Body:

{:responseView string}

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.

locations-queues-testIamPermissions$ clj

(locations-queues-testIamPermissions$ auth parameters body)

https://cloud.google.com/tasks/api/reference/rest/v2/projects/locations/queues/testIamPermissions

Required parameters: resource

Optional parameters: none

Body:

{:permissions [string]}

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.