blob: 0d8a75f787047c0e4cf04effde15bd42180e7c73 [file] [log] [blame]
// This is a generated file (see the discoveryapis_generator project).
library googleapis_beta.cloudtasks.v2beta2;
import 'dart:core' as core;
import 'dart:async' as async;
import 'dart:convert' as convert;
import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons;
import 'package:http/http.dart' as http;
export 'package:_discoveryapis_commons/_discoveryapis_commons.dart'
show ApiRequestError, DetailedApiRequestError;
const core.String USER_AGENT = 'dart-api-client cloudtasks/v2beta2';
/// Manages the execution of large numbers of distributed requests. Cloud Tasks
/// is in Alpha.
class CloudtasksApi {
/// View and manage your data across Google Cloud Platform services
static const CloudPlatformScope =
"https://www.googleapis.com/auth/cloud-platform";
final commons.ApiRequester _requester;
ProjectsResourceApi get projects => new ProjectsResourceApi(_requester);
CloudtasksApi(http.Client client,
{core.String rootUrl: "https://cloudtasks.googleapis.com/",
core.String servicePath: ""})
: _requester =
new commons.ApiRequester(client, rootUrl, servicePath, USER_AGENT);
}
class ProjectsResourceApi {
final commons.ApiRequester _requester;
ProjectsLocationsResourceApi get locations =>
new ProjectsLocationsResourceApi(_requester);
ProjectsResourceApi(commons.ApiRequester client) : _requester = client;
}
class ProjectsLocationsResourceApi {
final commons.ApiRequester _requester;
ProjectsLocationsQueuesResourceApi get queues =>
new ProjectsLocationsQueuesResourceApi(_requester);
ProjectsLocationsResourceApi(commons.ApiRequester client)
: _requester = client;
/// Get information about a location.
///
/// Request parameters:
///
/// [name] - Resource name for the location.
/// Value must have pattern "^projects/[^/]+/locations/[^/]+$".
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Location].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Location> get(core.String name, {core.String $fields}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
var _uploadOptions = null;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body = null;
if (name == null) {
throw new core.ArgumentError("Parameter name is required.");
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url = 'v2beta2/' + commons.Escaper.ecapeVariableReserved('$name');
var _response = _requester.request(_url, "GET",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new Location.fromJson(data));
}
/// Lists information about the supported locations for this service.
///
/// Request parameters:
///
/// [name] - The resource that owns the locations collection, if applicable.
/// Value must have pattern "^projects/[^/]+$".
///
/// [filter] - The standard list filter.
///
/// [pageToken] - The standard list page token.
///
/// [pageSize] - The standard list page size.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [ListLocationsResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<ListLocationsResponse> list(core.String name,
{core.String filter,
core.String pageToken,
core.int pageSize,
core.String $fields}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
var _uploadOptions = null;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body = null;
if (name == null) {
throw new core.ArgumentError("Parameter name is required.");
}
if (filter != null) {
_queryParams["filter"] = [filter];
}
if (pageToken != null) {
_queryParams["pageToken"] = [pageToken];
}
if (pageSize != null) {
_queryParams["pageSize"] = ["${pageSize}"];
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url = 'v2beta2/' +
commons.Escaper.ecapeVariableReserved('$name') +
'/locations';
var _response = _requester.request(_url, "GET",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new ListLocationsResponse.fromJson(data));
}
}
class ProjectsLocationsQueuesResourceApi {
final commons.ApiRequester _requester;
ProjectsLocationsQueuesTasksResourceApi get tasks =>
new ProjectsLocationsQueuesTasksResourceApi(_requester);
ProjectsLocationsQueuesResourceApi(commons.ApiRequester client)
: _requester = client;
/// Creates a queue.
///
/// WARNING: This method is only available to whitelisted
/// users. Using this method carries some risk. Read
/// [Overview of Queue Management and
/// queue.yaml](/cloud-tasks/docs/queue-yaml)
/// carefully and then sign up for
/// [whitelist access to this method](https://goo.gl/Fe5mUy).
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [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
/// google.cloud.location.Locations.ListLocations.
/// Value must have pattern "^projects/[^/]+/locations/[^/]+$".
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Queue].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Queue> create(Queue request, core.String parent,
{core.String $fields}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
var _uploadOptions = null;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body = null;
if (request != null) {
_body = convert.JSON.encode((request).toJson());
}
if (parent == null) {
throw new core.ArgumentError("Parameter parent is required.");
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url = 'v2beta2/' +
commons.Escaper.ecapeVariableReserved('$parent') +
'/queues';
var _response = _requester.request(_url, "POST",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new Queue.fromJson(data));
}
/// 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: This method is only available to whitelisted
/// users. Using this method carries some risk. Read
/// [Overview of Queue Management and
/// queue.yaml](/cloud-tasks/docs/queue-yaml)
/// carefully and then sign up for
/// [whitelist access to this method](https://goo.gl/Fe5mUy).
///
/// Request parameters:
///
/// [name] - Required.
///
/// The queue name. For example:
/// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
/// Value must have pattern "^projects/[^/]+/locations/[^/]+/queues/[^/]+$".
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Empty].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Empty> delete(core.String name, {core.String $fields}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
var _uploadOptions = null;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body = null;
if (name == null) {
throw new core.ArgumentError("Parameter name is required.");
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url = 'v2beta2/' + commons.Escaper.ecapeVariableReserved('$name');
var _response = _requester.request(_url, "DELETE",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new Empty.fromJson(data));
}
/// Gets a queue.
///
/// Request parameters:
///
/// [name] - Required.
///
/// The resource name of the queue. For example:
/// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
/// Value must have pattern "^projects/[^/]+/locations/[^/]+/queues/[^/]+$".
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Queue].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Queue> get(core.String name, {core.String $fields}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
var _uploadOptions = null;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body = null;
if (name == null) {
throw new core.ArgumentError("Parameter name is required.");
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url = 'v2beta2/' + commons.Escaper.ecapeVariableReserved('$name');
var _response = _requester.request(_url, "GET",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new Queue.fromJson(data));
}
/// 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](/iam) permission on the
/// specified resource parent:
///
/// * `cloudtasks.queues.getIamPolicy`
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [resource] - REQUIRED: The resource for which the policy is being
/// requested.
/// See the operation documentation for the appropriate value for this field.
/// Value must have pattern "^projects/[^/]+/locations/[^/]+/queues/[^/]+$".
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Policy].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Policy> getIamPolicy(
GetIamPolicyRequest request, core.String resource,
{core.String $fields}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
var _uploadOptions = null;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body = null;
if (request != null) {
_body = convert.JSON.encode((request).toJson());
}
if (resource == null) {
throw new core.ArgumentError("Parameter resource is required.");
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url = 'v2beta2/' +
commons.Escaper.ecapeVariableReserved('$resource') +
':getIamPolicy';
var _response = _requester.request(_url, "POST",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new Policy.fromJson(data));
}
/// Lists queues.
///
/// Queues are returned in lexicographical order.
///
/// Request parameters:
///
/// [parent] - Required.
///
/// The location name.
/// For example: `projects/PROJECT_ID/locations/LOCATION_ID`
/// Value must have pattern "^projects/[^/]+/locations/[^/]+$".
///
/// [filter] - `filter` can be used to specify a subset of queues. Any Queue
/// field can be used as a filter and several operators as supported.
/// For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as
/// described in
/// [Stackdriver's Advanced Logs
/// Filters](/logging/docs/view/advanced_filters).
///
/// Sample filter "app_engine_http_target: *".
///
/// Note that using filters might cause fewer queues than the
/// requested_page size to be returned.
///
/// [pageToken] - A token identifying the page of results to return.
///
/// To request the first page results, page_token must be empty. To
/// request the next page of results, page_token must be the value of
/// ListQueuesResponse.next_page_token returned from the previous
/// call to CloudTasks.ListQueues method. It is an error to
/// switch the value of ListQueuesRequest.filter while iterating
/// through pages.
///
/// [pageSize] - Requested page size.
///
/// The maximum page size is 9800. If unspecified, the page size will
/// be the maximum. Fewer queues than requested might be returned,
/// even if more queues exist; use
/// ListQueuesResponse.next_page_token to determine if more
/// queues exist.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [ListQueuesResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<ListQueuesResponse> list(core.String parent,
{core.String filter,
core.String pageToken,
core.int pageSize,
core.String $fields}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
var _uploadOptions = null;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body = null;
if (parent == null) {
throw new core.ArgumentError("Parameter parent is required.");
}
if (filter != null) {
_queryParams["filter"] = [filter];
}
if (pageToken != null) {
_queryParams["pageToken"] = [pageToken];
}
if (pageSize != null) {
_queryParams["pageSize"] = ["${pageSize}"];
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url = 'v2beta2/' +
commons.Escaper.ecapeVariableReserved('$parent') +
'/queues';
var _response = _requester.request(_url, "GET",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new ListQueuesResponse.fromJson(data));
}
/// Updates a queue.
///
/// This method creates the queue if it does not exist and updates
/// the queue if it does exist.
///
/// WARNING: This method is only available to whitelisted
/// users. Using this method carries some risk. Read
/// [Overview of Queue Management and
/// queue.yaml](/cloud-tasks/docs/queue-yaml)
/// carefully and then sign up for
/// [whitelist access to this method](https://goo.gl/Fe5mUy).
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - The queue name.
///
/// The queue name must have the following format:
/// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
///
/// * `PROJECT_ID` can contain uppercase and lowercase letters,
/// numbers, hyphens, colons, and periods; that is, it must match
/// the regular expression: `[a-zA-Z\\d-:\\.]+`.
/// * `QUEUE_ID` can contain uppercase and lowercase letters,
/// numbers, and hyphens; that is, it must match the regular
/// expression: `[a-zA-Z\\d-]+`. The maximum length is 100
/// characters.
///
/// Caller-specified and required in CreateQueueRequest, after which
/// it becomes output only.
/// Value must have pattern "^projects/[^/]+/locations/[^/]+/queues/[^/]+$".
///
/// [updateMask] - A mask used to specify which fields of the queue are being
/// updated.
///
/// If empty, then all fields will be updated.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Queue].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Queue> patch(Queue request, core.String name,
{core.String updateMask, core.String $fields}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
var _uploadOptions = null;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body = null;
if (request != null) {
_body = convert.JSON.encode((request).toJson());
}
if (name == null) {
throw new core.ArgumentError("Parameter name is required.");
}
if (updateMask != null) {
_queryParams["updateMask"] = [updateMask];
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url = 'v2beta2/' + commons.Escaper.ecapeVariableReserved('$name');
var _response = _requester.request(_url, "PATCH",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new Queue.fromJson(data));
}
/// Pauses the queue.
///
/// If a queue is paused then the system will stop executing the
/// tasks in the queue until it is resumed via
/// CloudTasks.ResumeQueue. Tasks can still be added when the
/// queue is paused. The state of the queue is stored in
/// Queue.queue_state; if paused it will be set to
/// Queue.QueueState.PAUSED.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Required.
///
/// The queue name. For example:
/// `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
/// Value must have pattern "^projects/[^/]+/locations/[^/]+/queues/[^/]+$".
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Queue].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Queue> pause(PauseQueueRequest request, core.String name,
{core.String $fields}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
var _uploadOptions = null;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body = null;
if (request != null) {
_body = convert.JSON.encode((request).toJson());
}
if (name == null) {
throw new core.ArgumentError("Parameter name is required.");
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url =
'v2beta2/' + commons.Escaper.ecapeVariableReserved('$name') + ':pause';
var _response = _requester.request(_url, "POST",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new Queue.fromJson(data));
}
/// 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.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Required.
///
/// The queue name. For example:
/// `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
/// Value must have pattern "^projects/[^/]+/locations/[^/]+/queues/[^/]+$".
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Queue].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Queue> purge(PurgeQueueRequest request, core.String name,
{core.String $fields}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
var _uploadOptions = null;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body = null;
if (request != null) {
_body = convert.JSON.encode((request).toJson());
}
if (name == null) {
throw new core.ArgumentError("Parameter name is required.");
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url =
'v2beta2/' + commons.Escaper.ecapeVariableReserved('$name') + ':purge';
var _response = _requester.request(_url, "POST",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new Queue.fromJson(data));
}
/// Resume a queue.
///
/// This method resumes a queue after it has been
/// Queue.QueueState.PAUSED or Queue.QueueState.DISABLED. The state of
/// a queue is stored in Queue.queue_state; after calling this method it
/// will be set to Queue.QueueState.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](/cloud-tasks/pdfs/managing-cloud-tasks-scaling-risks-2017-06-05.pdf).
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Required.
///
/// The queue name. For example:
/// `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
/// Value must have pattern "^projects/[^/]+/locations/[^/]+/queues/[^/]+$".
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Queue].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Queue> resume(ResumeQueueRequest request, core.String name,
{core.String $fields}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
var _uploadOptions = null;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body = null;
if (request != null) {
_body = convert.JSON.encode((request).toJson());
}
if (name == null) {
throw new core.ArgumentError("Parameter name is required.");
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url =
'v2beta2/' + commons.Escaper.ecapeVariableReserved('$name') + ':resume';
var _response = _requester.request(_url, "POST",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new Queue.fromJson(data));
}
/// 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](/iam) permission on the
/// specified resource parent:
///
/// * `cloudtasks.queues.setIamPolicy`
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [resource] - REQUIRED: The resource for which the policy is being
/// specified.
/// See the operation documentation for the appropriate value for this field.
/// Value must have pattern "^projects/[^/]+/locations/[^/]+/queues/[^/]+$".
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Policy].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Policy> setIamPolicy(
SetIamPolicyRequest request, core.String resource,
{core.String $fields}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
var _uploadOptions = null;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body = null;
if (request != null) {
_body = convert.JSON.encode((request).toJson());
}
if (resource == null) {
throw new core.ArgumentError("Parameter resource is required.");
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url = 'v2beta2/' +
commons.Escaper.ecapeVariableReserved('$resource') +
':setIamPolicy';
var _response = _requester.request(_url, "POST",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new Policy.fromJson(data));
}
/// 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 google.rpc.Code.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.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [resource] - REQUIRED: The resource for which the policy detail is being
/// requested.
/// See the operation documentation for the appropriate value for this field.
/// Value must have pattern "^projects/[^/]+/locations/[^/]+/queues/[^/]+$".
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [TestIamPermissionsResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<TestIamPermissionsResponse> testIamPermissions(
TestIamPermissionsRequest request, core.String resource,
{core.String $fields}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
var _uploadOptions = null;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body = null;
if (request != null) {
_body = convert.JSON.encode((request).toJson());
}
if (resource == null) {
throw new core.ArgumentError("Parameter resource is required.");
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url = 'v2beta2/' +
commons.Escaper.ecapeVariableReserved('$resource') +
':testIamPermissions';
var _response = _requester.request(_url, "POST",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response
.then((data) => new TestIamPermissionsResponse.fromJson(data));
}
}
class ProjectsLocationsQueuesTasksResourceApi {
final commons.ApiRequester _requester;
ProjectsLocationsQueuesTasksResourceApi(commons.ApiRequester client)
: _requester = client;
/// Acknowledges a pull task.
///
/// The lease holder, that is, the entity that received this task in
/// a PullTasksResponse, must call this method to indicate that
/// the work associated with the task has finished.
///
/// The lease holder must acknowledge a task within the
/// PullTasksRequest.lease_duration or the lease will expire and
/// the task will become ready to be returned in a different
/// PullTasksResponse. After the task is acknowledged, it will
/// not be returned by a later CloudTasks.PullTasks,
/// CloudTasks.GetTask, or CloudTasks.ListTasks.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Required.
///
/// The task name. For example:
/// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
/// Value must have pattern
/// "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$".
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Empty].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Empty> acknowledge(
AcknowledgeTaskRequest request, core.String name,
{core.String $fields}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
var _uploadOptions = null;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body = null;
if (request != null) {
_body = convert.JSON.encode((request).toJson());
}
if (name == null) {
throw new core.ArgumentError("Parameter name is required.");
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url = 'v2beta2/' +
commons.Escaper.ecapeVariableReserved('$name') +
':acknowledge';
var _response = _requester.request(_url, "POST",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new Empty.fromJson(data));
}
/// Cancel a pull task's lease.
///
/// The lease holder can use this method to cancel a task's lease
/// by setting Task.schedule_time to now. This will make the task
/// available to be leased to the next caller of CloudTasks.PullTasks.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Required.
///
/// The task name. For example:
/// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
/// Value must have pattern
/// "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$".
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Task].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Task> cancelLease(CancelLeaseRequest request, core.String name,
{core.String $fields}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
var _uploadOptions = null;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body = null;
if (request != null) {
_body = convert.JSON.encode((request).toJson());
}
if (name == null) {
throw new core.ArgumentError("Parameter name is required.");
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url = 'v2beta2/' +
commons.Escaper.ecapeVariableReserved('$name') +
':cancelLease';
var _response = _requester.request(_url, "POST",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new Task.fromJson(data));
}
/// Creates a task and adds it to a queue.
///
/// To add multiple tasks at the same time, use
/// [HTTP batching](/storage/docs/json_api/v1/how-tos/batch)
/// or the batching documentation for your client library, for example
/// https://developers.google.com/api-client-library/python/guide/batch.
///
/// Tasks cannot be updated after creation; there is no UpdateTask command.
///
/// * For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),
/// the maximum task size is 100KB.
/// * For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this
/// the maximum task size is 1MB.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [parent] - Required.
///
/// The queue name. For example:
/// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
///
/// The queue must already exist.
/// Value must have pattern "^projects/[^/]+/locations/[^/]+/queues/[^/]+$".
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Task].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Task> create(CreateTaskRequest request, core.String parent,
{core.String $fields}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
var _uploadOptions = null;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body = null;
if (request != null) {
_body = convert.JSON.encode((request).toJson());
}
if (parent == null) {
throw new core.ArgumentError("Parameter parent is required.");
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url = 'v2beta2/' +
commons.Escaper.ecapeVariableReserved('$parent') +
'/tasks';
var _response = _requester.request(_url, "POST",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new Task.fromJson(data));
}
/// 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.
///
/// Request parameters:
///
/// [name] - Required.
///
/// The task name. For example:
/// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
/// Value must have pattern
/// "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$".
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Empty].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Empty> delete(core.String name, {core.String $fields}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
var _uploadOptions = null;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body = null;
if (name == null) {
throw new core.ArgumentError("Parameter name is required.");
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url = 'v2beta2/' + commons.Escaper.ecapeVariableReserved('$name');
var _response = _requester.request(_url, "DELETE",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new Empty.fromJson(data));
}
/// Gets a task.
///
/// Request parameters:
///
/// [name] - Required.
///
/// The task name. For example:
/// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
/// Value must have pattern
/// "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$".
///
/// [responseView] - The response_view specifies which subset of the Task will
/// be
/// returned.
///
/// By default response_view is Task.View.BASIC; not all
/// information is retrieved by default because some data, such as
/// payloads, might be desirable to return only when needed because
/// of its large size or because of the sensitivity of data that it
/// contains.
///
/// Authorization for Task.View.FULL requires `cloudtasks.tasks.fullView`
/// [Google IAM](/iam/) permission on the
/// Task.name resource.
/// Possible string values are:
/// - "VIEW_UNSPECIFIED" : A VIEW_UNSPECIFIED.
/// - "BASIC" : A BASIC.
/// - "FULL" : A FULL.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Task].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Task> get(core.String name,
{core.String responseView, core.String $fields}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
var _uploadOptions = null;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body = null;
if (name == null) {
throw new core.ArgumentError("Parameter name is required.");
}
if (responseView != null) {
_queryParams["responseView"] = [responseView];
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url = 'v2beta2/' + commons.Escaper.ecapeVariableReserved('$name');
var _response = _requester.request(_url, "GET",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new Task.fromJson(data));
}
/// Lists the tasks in a queue.
///
/// By default response_view is Task.View.BASIC; not all
/// information is retrieved by default due to performance
/// considerations; ListTasksRequest.response_view controls the
/// subset of information which is returned.
///
/// Request parameters:
///
/// [parent] - Required.
///
/// The queue name. For example:
/// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
/// Value must have pattern "^projects/[^/]+/locations/[^/]+/queues/[^/]+$".
///
/// [responseView] - The response_view specifies which subset of the Task will
/// be
/// returned.
///
/// By default response_view is Task.View.BASIC; not all
/// information is retrieved by default because some data, such as
/// payloads, might be desirable to return only when needed because
/// of its large size or because of the sensitivity of data that it
/// contains.
///
/// Authorization for Task.View.FULL requires `cloudtasks.tasks.fullView`
/// [Google IAM](/iam/) permission on the
/// Task.name resource.
/// Possible string values are:
/// - "VIEW_UNSPECIFIED" : A VIEW_UNSPECIFIED.
/// - "BASIC" : A BASIC.
/// - "FULL" : A FULL.
///
/// [orderBy] - Sort order used for the query. The only fields supported for
/// sorting
/// are `schedule_time` and `pull_message.tag`. All results will be
/// returned in approximately ascending order. The default ordering is by
/// `schedule_time`.
///
/// [pageToken] - A token identifying the page of results to return.
///
/// To request the first page results, page_token must be empty. To
/// request the next page of results, page_token must be the value of
/// ListTasksResponse.next_page_token returned from the previous
/// call to CloudTasks.ListTasks method.
///
/// The page token is valid for only 2 hours.
///
/// [pageSize] - Requested page size. Fewer tasks than requested might be
/// returned.
///
/// The maximum page size is 1000. If unspecified, the page size will
/// be the maximum. Fewer tasks than requested might be returned,
/// even if more tasks exist; use
/// ListTasksResponse.next_page_token to determine if more tasks
/// exist.
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [ListTasksResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<ListTasksResponse> list(core.String parent,
{core.String responseView,
core.String orderBy,
core.String pageToken,
core.int pageSize,
core.String $fields}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
var _uploadOptions = null;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body = null;
if (parent == null) {
throw new core.ArgumentError("Parameter parent is required.");
}
if (responseView != null) {
_queryParams["responseView"] = [responseView];
}
if (orderBy != null) {
_queryParams["orderBy"] = [orderBy];
}
if (pageToken != null) {
_queryParams["pageToken"] = [pageToken];
}
if (pageSize != null) {
_queryParams["pageSize"] = ["${pageSize}"];
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url = 'v2beta2/' +
commons.Escaper.ecapeVariableReserved('$parent') +
'/tasks';
var _response = _requester.request(_url, "GET",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new ListTasksResponse.fromJson(data));
}
/// Pulls tasks from a pull queue and acquires a lease on them for a
/// specified PullTasksRequest.lease_duration.
///
/// This method is invoked by the lease holder to obtain the
/// lease. The lease holder must acknowledge the task via
/// CloudTasks.AcknowledgeTask after they have performed the work
/// associated with the task.
///
/// The payload is intended to store data that the lease holder needs
/// to perform the work associated with the task. To return the
/// payloads in the PullTasksResponse, set
/// PullTasksRequest.response_view to Task.View.FULL.
///
/// A maximum of 10 qps of CloudTasks.PullTasks requests are allowed per
/// queue. google.rpc.Code.RESOURCE_EXHAUSTED is returned when this limit
/// is exceeded. google.rpc.Code.RESOURCE_EXHAUSTED is also returned when
/// RateLimits.max_tasks_dispatched_per_second is exceeded.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Required.
///
/// The queue name. For example:
/// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
/// Value must have pattern "^projects/[^/]+/locations/[^/]+/queues/[^/]+$".
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [PullTasksResponse].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<PullTasksResponse> pull(
PullTasksRequest request, core.String name,
{core.String $fields}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
var _uploadOptions = null;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body = null;
if (request != null) {
_body = convert.JSON.encode((request).toJson());
}
if (name == null) {
throw new core.ArgumentError("Parameter name is required.");
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url = 'v2beta2/' +
commons.Escaper.ecapeVariableReserved('$name') +
'/tasks:pull';
var _response = _requester.request(_url, "POST",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new PullTasksResponse.fromJson(data));
}
/// Renew the current lease of a pull task.
///
/// The lease holder can use this method to extend the lease by a new
/// duration, starting from now. The new task lease will be
/// returned in Task.schedule_time.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Required.
///
/// The task name. For example:
/// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
/// Value must have pattern
/// "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$".
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Task].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Task> renewLease(RenewLeaseRequest request, core.String name,
{core.String $fields}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
var _uploadOptions = null;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body = null;
if (request != null) {
_body = convert.JSON.encode((request).toJson());
}
if (name == null) {
throw new core.ArgumentError("Parameter name is required.");
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url = 'v2beta2/' +
commons.Escaper.ecapeVariableReserved('$name') +
':renewLease';
var _response = _requester.request(_url, "POST",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new Task.fromJson(data));
}
/// Forces a task to run now.
///
/// This command is meant to be used for manual debugging. For
/// example, CloudTasks.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.
///
/// When this method is called, Cloud Tasks will dispatch the task to its
/// target, even if the queue is Queue.QueueState.PAUSED.
///
/// The dispatched task is returned. That is, the task that is returned
/// contains the Task.task_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
/// handler, then the task will be deleted; otherwise the task's
/// Task.schedule_time will be reset to the time that
/// CloudTasks.RunTask was called plus the retry delay specified
/// in the queue and task's RetryConfig.
///
/// CloudTasks.RunTask returns google.rpc.Code.NOT_FOUND when
/// it is called on a task that has already succeeded or permanently
/// failed. google.rpc.Code.FAILED_PRECONDITION is returned when
/// CloudTasks.RunTask is called on task that is dispatched or
/// already running.
///
/// [request] - The metadata request object.
///
/// Request parameters:
///
/// [name] - Required.
///
/// The task name. For example:
/// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
/// Value must have pattern
/// "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$".
///
/// [$fields] - Selector specifying which fields to include in a partial
/// response.
///
/// Completes with a [Task].
///
/// Completes with a [commons.ApiRequestError] if the API endpoint returned an
/// error.
///
/// If the used [http.Client] completes with an error when making a REST call,
/// this method will complete with the same error.
async.Future<Task> run(RunTaskRequest request, core.String name,
{core.String $fields}) {
var _url = null;
var _queryParams = new core.Map();
var _uploadMedia = null;
var _uploadOptions = null;
var _downloadOptions = commons.DownloadOptions.Metadata;
var _body = null;
if (request != null) {
_body = convert.JSON.encode((request).toJson());
}
if (name == null) {
throw new core.ArgumentError("Parameter name is required.");
}
if ($fields != null) {
_queryParams["fields"] = [$fields];
}
_url = 'v2beta2/' + commons.Escaper.ecapeVariableReserved('$name') + ':run';
var _response = _requester.request(_url, "POST",
body: _body,
queryParams: _queryParams,
uploadOptions: _uploadOptions,
uploadMedia: _uploadMedia,
downloadOptions: _downloadOptions);
return _response.then((data) => new Task.fromJson(data));
}
}
/// Request message for acknowledging a task using
/// CloudTasks.AcknowledgeTask.
class AcknowledgeTaskRequest {
/// Required.
///
/// The task's current schedule time, available in the Task.schedule_time
/// returned in PullTasksResponse.tasks or
/// CloudTasks.RenewLease. This restriction is to check that
/// the caller is acknowledging the correct task.
core.String scheduleTime;
AcknowledgeTaskRequest();
AcknowledgeTaskRequest.fromJson(core.Map _json) {
if (_json.containsKey("scheduleTime")) {
scheduleTime = _json["scheduleTime"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (scheduleTime != null) {
_json["scheduleTime"] = scheduleTime;
}
return _json;
}
}
/// App Engine HTTP request.
///
/// The message defines the HTTP request that is sent to an App Engine app when
/// the task is dispatched.
///
/// This proto can only be used for tasks in a queue which has
/// Queue.app_engine_http_target set.
///
/// Using AppEngineHttpRequest requires
/// [`appengine.applications.get`](/appengine/docs/admin-api/access-control)
/// Google IAM permission for the project
/// and the following scope:
///
/// `https://www.googleapis.com/auth/cloud-platform`
///
/// The task will be delivered to the App Engine app which belongs to the same
/// project as the queue. For more information, see
/// [How Requests are
/// Routed](/appengine/docs/standard/python/how-requests-are-routed)
/// and how routing is affected by
/// [dispatch files](/appengine/docs/python/config/dispatchref).
///
/// The AppEngineRouting used to construct the URL that the task is
/// delivered to can be set at the queue-level or task-level:
///
/// * If set, AppEngineHttpTarget.app_engine_routing_override is used for
/// all tasks in the queue, no matter what the setting is for the
/// task-level app_engine_routing.
///
///
/// The `url` that the task will be sent to is:
///
/// * `url =` AppEngineRouting.host `+` AppEngineHttpRequest.relative_url
///
/// The task will be sent to a task handler by an HTTP
/// request using the specified AppEngineHttpRequest.http_method (for example
/// POST, HTTP GET, etc). The task attempt has succeeded if the task handler
/// returns an HTTP response code in the range [200 - 299]. Error 503 is
/// considered an App Engine system error instead of an application error.
/// Requests returning error 503 will be retried regardless of retry
/// configuration and not counted against retry counts.
/// Any other response code or a failure to receive a response before the
/// deadline is a failed attempt.
class AppEngineHttpRequest {
/// Task-level setting for App Engine routing.
///
/// If set, AppEngineHttpTarget.app_engine_routing_override is used for
/// all tasks in the queue, no matter what the setting is for the
/// task-level app_engine_routing.
AppEngineRouting appEngineRouting;
/// HTTP request headers.
///
/// This map contains the header field names and values.
/// Headers can be set when the
/// [task is created](google.cloud.tasks.v2beta2.CloudTasks.CreateTask).
/// Repeated headers are not supported but a header value can contain commas.
///
/// Cloud Tasks sets some headers to default values:
///
/// * `User-Agent`: By default, this header is
/// `"AppEngine-Google; (+http://code.google.com/appengine)"`.
/// This header can be modified, but Cloud Tasks will append
/// `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
/// modified `User-Agent`.
///
/// If the task has an AppEngineHttpRequest.payload, Cloud Tasks sets the
/// following headers:
///
/// * `Content-Type`: By default, the `Content-Type` header is set to
/// `"application/octet-stream"`. The default can be overridden by explictly
/// setting `Content-Type` to a particular media type when the
/// [task is created](google.cloud.tasks.v2beta2.CloudTasks.CreateTask).
/// For example, `Content-Type` can be set to `"application/json"`.
/// * `Content-Length`: This is computed by Cloud Tasks. This value is
/// output only. It cannot be changed.
///
/// The headers below cannot be set or overridden:
///
/// * `Host`
/// * `X-Google-*`
/// * `X-AppEngine-*`
///
/// In addition, some App Engine headers, which contain
/// task-specific information, are also be sent to the task handler; see
/// [request
/// headers](/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).
core.Map<core.String, core.String> headers;
/// The HTTP method to use for the request. The default is POST.
///
/// The app's request handler for the task's target URL must be able to handle
/// HTTP requests with this http_method, otherwise the task attempt will fail
/// with error code 405 (Method Not Allowed). See
/// the Request-Line is not allowed for the resource identified by the
/// Request-URI". See
/// [Writing a push task request
/// handler](/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)
/// and the documentation for the request handlers in the language your app is
/// written in e.g.
/// [python
/// RequestHandler](/appengine/docs/python/tools/webapp/requesthandlerclass).
/// Possible string values are:
/// - "HTTP_METHOD_UNSPECIFIED" : HTTP method unspecified
/// - "POST" : HTTP Post
/// - "GET" : HTTP Get
/// - "HEAD" : HTTP Head
/// - "PUT" : HTTP Put
/// - "DELETE" : HTTP Delete
core.String httpMethod;
/// Payload.
///
/// The payload will be sent as the HTTP message body. A message
/// body, and thus a payload, is allowed only if the HTTP method is
/// POST or PUT. It is an error to set a data payload on a task with
/// an incompatible HttpMethod.
core.String payload;
core.List<core.int> get payloadAsBytes {
return convert.BASE64.decode(payload);
}
void set payloadAsBytes(core.List<core.int> _bytes) {
payload =
convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
}
/// The relative URL.
///
/// The relative URL must begin with "/" and must be a valid HTTP relative
/// URL.
/// It can contain a path and query string arguments.
/// If the relative URL is empty, then the root path "/" will be used.
/// No spaces are allowed, and the maximum length allowed is 2083 characters.
core.String relativeUrl;
AppEngineHttpRequest();
AppEngineHttpRequest.fromJson(core.Map _json) {
if (_json.containsKey("appEngineRouting")) {
appEngineRouting =
new AppEngineRouting.fromJson(_json["appEngineRouting"]);
}
if (_json.containsKey("headers")) {
headers = _json["headers"];
}
if (_json.containsKey("httpMethod")) {
httpMethod = _json["httpMethod"];
}
if (_json.containsKey("payload")) {
payload = _json["payload"];
}
if (_json.containsKey("relativeUrl")) {
relativeUrl = _json["relativeUrl"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (appEngineRouting != null) {
_json["appEngineRouting"] = (appEngineRouting).toJson();
}
if (headers != null) {
_json["headers"] = headers;
}
if (httpMethod != null) {
_json["httpMethod"] = httpMethod;
}
if (payload != null) {
_json["payload"] = payload;
}
if (relativeUrl != null) {
_json["relativeUrl"] = relativeUrl;
}
return _json;
}
}
/// App Engine HTTP target.
///
/// The task will be delivered to the App Engine application hostname
/// specified by its AppEngineHttpTarget and AppEngineHttpRequest.
/// The documentation for AppEngineHttpRequest explains how the
/// task's host URL is constructed.
///
/// Using AppEngineHttpTarget requires
/// [`appengine.applications.get`](/appengine/docs/admin-api/access-control)
/// Google IAM permission for the project
/// and the following scope:
///
/// `https://www.googleapis.com/auth/cloud-platform`
class AppEngineHttpTarget {
/// Overrides for the
/// task-level app_engine_routing.
///
/// If set, AppEngineHttpTarget.app_engine_routing_override is used for
/// all tasks in the queue, no matter what the setting is for the
/// task-level app_engine_routing.
AppEngineRouting appEngineRoutingOverride;
AppEngineHttpTarget();
AppEngineHttpTarget.fromJson(core.Map _json) {
if (_json.containsKey("appEngineRoutingOverride")) {
appEngineRoutingOverride =
new AppEngineRouting.fromJson(_json["appEngineRoutingOverride"]);
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (appEngineRoutingOverride != null) {
_json["appEngineRoutingOverride"] = (appEngineRoutingOverride).toJson();
}
return _json;
}
}
/// Deprecated. Use AppEngineHttpTarget.
class AppEngineQueueConfig {
/// Deprecated. Use AppEngineHttpTarget.app_engine_routing_override.
AppEngineRouting appEngineRoutingOverride;
AppEngineQueueConfig();
AppEngineQueueConfig.fromJson(core.Map _json) {
if (_json.containsKey("appEngineRoutingOverride")) {
appEngineRoutingOverride =
new AppEngineRouting.fromJson(_json["appEngineRoutingOverride"]);
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (appEngineRoutingOverride != null) {
_json["appEngineRoutingOverride"] = (appEngineRoutingOverride).toJson();
}
return _json;
}
}
/// App Engine Routing.
///
/// For more information about services, versions, and instances see
/// [An Overview of App
/// Engine](/appengine/docs/python/an-overview-of-app-engine),
/// [Microservices Architecture on Google App
/// Engine](/appengine/docs/python/microservices-on-app-engine),
/// [App Engine Standard request
/// routing](/appengine/docs/standard/python/how-requests-are-routed),
/// and [App Engine Flex request
/// routing](/appengine/docs/flexible/python/how-requests-are-routed).
class AppEngineRouting {
/// Output only.
///
/// The host that the task is sent to. For more information, see
/// [How Requests are
/// Routed](/appengine/docs/standard/python/how-requests-are-routed).
///
/// The host is constructed as:
///
///
/// * `host = [application_domain_name]`</br>
/// `| [service] + '.' + [application_domain_name]`</br>
/// `| [version] + '.' + [application_domain_name]`</br>
/// `| [version_dot_service]+ '.' + [application_domain_name]`</br>
/// `| [instance] + '.' + [application_domain_name]`</br>
/// `| [instance_dot_service] + '.' + [application_domain_name]`</br>
/// `| [instance_dot_version] + '.' + [application_domain_name]`</br>
/// `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`
///
/// * `application_domain_name` = The domain name of the app, for
/// example <app-id>.appspot.com, which is associated with the
/// queue's project ID. Some tasks which were created using the App Engine
/// SDK use a custom domain name.
///
/// * `service =` AppEngineRouting.service
///
/// * `version =` AppEngineRouting.version
///
/// * `version_dot_service =`
/// AppEngineRouting.version `+ '.' +` AppEngineRouting.service
///
/// * `instance =` AppEngineRouting.instance
///
/// * `instance_dot_service =`
/// AppEngineRouting.instance `+ '.' +` AppEngineRouting.service
///
/// * `instance_dot_version =`
/// AppEngineRouting.instance `+ '.' +` AppEngineRouting.version
///
/// * `instance_dot_version_dot_service =`
/// AppEngineRouting.instance `+ '.' +`
/// AppEngineRouting.version `+ '.' +` AppEngineRouting.service
///
/// If AppEngineRouting.service is empty, then the task will be sent
/// to the service which is the default service when the task is attempted.
///
/// If AppEngineRouting.version is empty, then the task will be sent
/// to the version which is the default version when the task is attempted.
///
/// If AppEngineRouting.instance is empty, then the task will be sent
/// to an instance which is available when the task is attempted.
///
/// When AppEngineRouting.service is "default",
/// AppEngineRouting.version is "default", and
/// AppEngineRouting.instance is empty, AppEngineRouting.host is
/// shortened to just the `application_domain_name`.
///
/// If AppEngineRouting.service, AppEngineRouting.version, or
/// AppEngineRouting.instance is invalid, then the task will be sent
/// to the default version of the default service when the task is attempted.
core.String host;
/// App instance.
///
/// By default, the task is sent to an instance which is available when
/// the task is attempted.
///
/// Requests can only be sent to a specific instance if
/// [manual scaling is used in App Engine
/// Standard](/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
/// App Engine Flex does not support instances. For more information, see
/// [App Engine Standard request
/// routing](/appengine/docs/standard/python/how-requests-are-routed)
/// and [App Engine Flex request
/// routing](/appengine/docs/flexible/python/how-requests-are-routed).
core.String instance;
/// App service.
///
/// By default, the task is sent to the service which is the default
/// service when the task is attempted ("default").
///
/// For some queues or tasks which were created using the App Engine Task
/// Queue
/// API, AppEngineRouting.host is not parsable into
/// AppEngineRouting.service, AppEngineRouting.version, and
/// AppEngineRouting.instance. For example, some tasks which were created
/// using the App Engine SDK use a custom domain name; custom domains are not
/// parsed by Cloud Tasks. If AppEngineRouting.host is not parsable, then
/// AppEngineRouting.service, AppEngineRouting.version, and
/// AppEngineRouting.instance are the empty string.
core.String service;
/// App version.
///
/// By default, the task is sent to the version which is the default
/// version when the task is attempted ("default").
///
/// For some queues or tasks which were created using the App Engine Task
/// Queue
/// API, AppEngineRouting.host is not parsable into
/// AppEngineRouting.service, AppEngineRouting.version, and
/// AppEngineRouting.instance. For example, some tasks which were created
/// using the App Engine SDK use a custom domain name; custom domains are not
/// parsed by Cloud Tasks. If AppEngineRouting.host is not parsable, then
/// AppEngineRouting.service, AppEngineRouting.version, and
/// AppEngineRouting.instance are the empty string.
core.String version;
AppEngineRouting();
AppEngineRouting.fromJson(core.Map _json) {
if (_json.containsKey("host")) {
host = _json["host"];
}
if (_json.containsKey("instance")) {
instance = _json["instance"];
}
if (_json.containsKey("service")) {
service = _json["service"];
}
if (_json.containsKey("version")) {
version = _json["version"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (host != null) {
_json["host"] = host;
}
if (instance != null) {
_json["instance"] = instance;
}
if (service != null) {
_json["service"] = service;
}
if (version != null) {
_json["version"] = version;
}
return _json;
}
}
/// Deprecated. Use AppEngineHttpRequest.
class AppEngineTaskTarget {
/// Deprecated. Use AppEngineHttpRequest.app_engine_routing.
AppEngineRouting appEngineRouting;
/// Deprecated. Use AppEngineHttpRequest.headers.
core.Map<core.String, core.String> headers;
/// Deprecated. Use AppEngineHttpRequest.http_method.
/// Possible string values are:
/// - "HTTP_METHOD_UNSPECIFIED" : HTTP method unspecified
/// - "POST" : HTTP Post
/// - "GET" : HTTP Get
/// - "HEAD" : HTTP Head
/// - "PUT" : HTTP Put
/// - "DELETE" : HTTP Delete
core.String httpMethod;
/// Deprecated. Use AppEngineHttpRequest.payload.
core.String payload;
core.List<core.int> get payloadAsBytes {
return convert.BASE64.decode(payload);
}
void set payloadAsBytes(core.List<core.int> _bytes) {
payload =
convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
}
/// Deprecated. Use AppEngineHttpRequest.relative_url.
core.String relativeUrl;
AppEngineTaskTarget();
AppEngineTaskTarget.fromJson(core.Map _json) {
if (_json.containsKey("appEngineRouting")) {
appEngineRouting =
new AppEngineRouting.fromJson(_json["appEngineRouting"]);
}
if (_json.containsKey("headers")) {
headers = _json["headers"];
}
if (_json.containsKey("httpMethod")) {
httpMethod = _json["httpMethod"];
}
if (_json.containsKey("payload")) {
payload = _json["payload"];
}
if (_json.containsKey("relativeUrl")) {
relativeUrl = _json["relativeUrl"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (appEngineRouting != null) {
_json["appEngineRouting"] = (appEngineRouting).toJson();
}
if (headers != null) {
_json["headers"] = headers;
}
if (httpMethod != null) {
_json["httpMethod"] = httpMethod;
}
if (payload != null) {
_json["payload"] = payload;
}
if (relativeUrl != null) {
_json["relativeUrl"] = relativeUrl;
}
return _json;
}
}
/// The status of a task attempt.
class AttemptStatus {
/// Output only.
///
/// The time that this attempt was dispatched.
///
/// `dispatch_time` will be truncated to the nearest microsecond.
core.String dispatchTime;
/// Output only.
///
/// The response from the target for this attempt.
///
/// If the task has not been attempted or the task is currently running
/// then the response status is google.rpc.Code.UNKNOWN.
Status responseStatus;
/// Output only.
///
/// The time that this attempt response was received.
///
/// `response_time` will be truncated to the nearest microsecond.
core.String responseTime;
/// Output only.
///
/// The time that this attempt was scheduled.
///
/// `schedule_time` will be truncated to the nearest microsecond.
core.String scheduleTime;
AttemptStatus();
AttemptStatus.fromJson(core.Map _json) {
if (_json.containsKey("dispatchTime")) {
dispatchTime = _json["dispatchTime"];
}
if (_json.containsKey("responseStatus")) {
responseStatus = new Status.fromJson(_json["responseStatus"]);
}
if (_json.containsKey("responseTime")) {
responseTime = _json["responseTime"];
}
if (_json.containsKey("scheduleTime")) {
scheduleTime = _json["scheduleTime"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (dispatchTime != null) {
_json["dispatchTime"] = dispatchTime;
}
if (responseStatus != null) {
_json["responseStatus"] = (responseStatus).toJson();
}
if (responseTime != null) {
_json["responseTime"] = responseTime;
}
if (scheduleTime != null) {
_json["scheduleTime"] = scheduleTime;
}
return _json;
}
}
/// Associates `members` with a `role`.
class Binding {
/// Specifies the identities requesting access for a Cloud Platform resource.
/// `members` can have the following values:
///
/// * `allUsers`: A special identifier that represents anyone who is
/// on the internet; with or without a Google account.
///
/// * `allAuthenticatedUsers`: A special identifier that represents anyone
/// who is authenticated with a Google account or a service account.
///
/// * `user:{emailid}`: An email address that represents a specific Google
/// account. For example, `alice@gmail.com` or `joe@example.com`.
///
///
/// * `serviceAccount:{emailid}`: An email address that represents a service
/// account. For example, `my-other-app@appspot.gserviceaccount.com`.
///
/// * `group:{emailid}`: An email address that represents a Google group.
/// For example, `admins@example.com`.
///
///
/// * `domain:{domain}`: A Google Apps domain name that represents all the
/// users of that domain. For example, `google.com` or `example.com`.
core.List<core.String> members;
/// Role that is assigned to `members`.
/// For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
/// Required
core.String role;
Binding();
Binding.fromJson(core.Map _json) {
if (_json.containsKey("members")) {
members = _json["members"];
}
if (_json.containsKey("role")) {
role = _json["role"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (members != null) {
_json["members"] = members;
}
if (role != null) {
_json["role"] = role;
}
return _json;
}
}
/// Request message for canceling a lease using
/// CloudTasks.CancelLease.
class CancelLeaseRequest {
/// The response_view specifies which subset of the Task will be
/// returned.
///
/// By default response_view is Task.View.BASIC; not all
/// information is retrieved by default because some data, such as
/// payloads, might be desirable to return only when needed because
/// of its large size or because of the sensitivity of data that it
/// contains.
///
/// Authorization for Task.View.FULL requires `cloudtasks.tasks.fullView`
/// [Google IAM](/iam/) permission on the
/// Task.name resource.
/// Possible string values are:
/// - "VIEW_UNSPECIFIED" : Unspecified. Defaults to BASIC.
/// - "BASIC" : The basic view omits fields which can be large or can contain
/// sensitive data.
///
/// This view does not include the payload.
/// - "FULL" : All information is returned.
///
/// Payloads might be desirable to return only when needed, because
/// they can be large and because of the sensitivity of the data
/// that you choose to store in it.
///
/// Authorization for Task.View.FULL requires
/// `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
/// permission on the Queue.name resource.
core.String responseView;
/// Required.
///
/// The task's current schedule time, available in the Task.schedule_time
/// returned in PullTasksResponse.tasks or
/// CloudTasks.RenewLease. This restriction is to check that
/// the caller is canceling the correct task.
core.String scheduleTime;
CancelLeaseRequest();
CancelLeaseRequest.fromJson(core.Map _json) {
if (_json.containsKey("responseView")) {
responseView = _json["responseView"];
}
if (_json.containsKey("scheduleTime")) {
scheduleTime = _json["scheduleTime"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (responseView != null) {
_json["responseView"] = responseView;
}
if (scheduleTime != null) {
_json["scheduleTime"] = scheduleTime;
}
return _json;
}
}
/// Request message for CloudTasks.CreateTask.
class CreateTaskRequest {
/// The response_view specifies which subset of the Task will be
/// returned.
///
/// By default response_view is Task.View.BASIC; not all
/// information is retrieved by default because some data, such as
/// payloads, might be desirable to return only when needed because
/// of its large size or because of the sensitivity of data that it
/// contains.
///
/// Authorization for Task.View.FULL requires `cloudtasks.tasks.fullView`
/// [Google IAM](/iam/) permission on the
/// Task.name resource.
/// Possible string values are:
/// - "VIEW_UNSPECIFIED" : Unspecified. Defaults to BASIC.
/// - "BASIC" : The basic view omits fields which can be large or can contain
/// sensitive data.
///
/// This view does not include the payload.
/// - "FULL" : All information is returned.
///
/// Payloads might be desirable to return only when needed, because
/// they can be large and because of the sensitivity of the data
/// that you choose to store in it.
///
/// Authorization for Task.View.FULL requires
/// `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
/// permission on the Queue.name resource.
core.String responseView;
/// Required.
///
/// The task to add.
///
/// Task names have the following format:
/// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
/// The user can optionally specify a name for the task in
/// Task.name. If a name is not specified then the system will
/// generate a random unique task id, which will be returned in the
/// response's Task.name.
///
/// If Task.schedule_time is not set or is in the past then Cloud
/// Tasks will set it to the current time.
///
/// Task De-duplication:
///
/// Explicitly specifying a task ID enables task de-duplication. If
/// a task's ID is identical to that of an existing task or a task
/// that was deleted or completed recently then the call will fail
/// with google.rpc.Code.ALREADY_EXISTS. If the task's queue was
/// created using Cloud Tasks, then another task with the same name
/// can't be created for ~1hour after the original task was deleted
/// or completed. If the task's queue was created using queue.yaml or
/// queue.xml, then another task with the same name can't be created
/// for ~9days after the original task was deleted or completed.
///
/// Because there is an extra lookup cost to identify duplicate task
/// names, these CloudTasks.CreateTask calls have significantly
/// increased latency. Using hashed strings for the task id or for
/// the prefix of the task id is recommended. Choosing task ids that
/// are sequential or have sequential prefixes, for example using a
/// timestamp, causes an increase in latency and error rates in all
/// task commands. The infrastructure relies on an approximately
/// uniform distribution of task ids to store and serve tasks
/// efficiently.
Task task;
CreateTaskRequest();
CreateTaskRequest.fromJson(core.Map _json) {
if (_json.containsKey("responseView")) {
responseView = _json["responseView"];
}
if (_json.containsKey("task")) {
task = new Task.fromJson(_json["task"]);
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (responseView != null) {
_json["responseView"] = responseView;
}
if (task != null) {
_json["task"] = (task).toJson();
}
return _json;
}
}
/// A generic empty message that you can re-use to avoid defining duplicated
/// empty messages in your APIs. A typical example is to use it as the request
/// or the response type of an API method. For instance:
///
/// service Foo {
/// rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
/// }
///
/// The JSON representation for `Empty` is empty JSON object `{}`.
class Empty {
Empty();
Empty.fromJson(core.Map _json) {}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
return _json;
}
}
/// Request message for `GetIamPolicy` method.
class GetIamPolicyRequest {
GetIamPolicyRequest();
GetIamPolicyRequest.fromJson(core.Map _json) {}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
return _json;
}
}
/// The response message for Locations.ListLocations.
class ListLocationsResponse {
/// A list of locations that matches the specified filter in the request.
core.List<Location> locations;
/// The standard List next-page token.
core.String nextPageToken;
ListLocationsResponse();
ListLocationsResponse.fromJson(core.Map _json) {
if (_json.containsKey("locations")) {
locations = _json["locations"]
.map((value) => new Location.fromJson(value))
.toList();
}
if (_json.containsKey("nextPageToken")) {
nextPageToken = _json["nextPageToken"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (locations != null) {
_json["locations"] = locations.map((value) => (value).toJson()).toList();
}
if (nextPageToken != null) {
_json["nextPageToken"] = nextPageToken;
}
return _json;
}
}
/// Response message for CloudTasks.ListQueues.
class ListQueuesResponse {
/// A token to retrieve next page of results.
///
/// To return the next page of results, call
/// CloudTasks.ListQueues with this value as the
/// ListQueuesRequest.page_token.
///
/// If the next_page_token is empty, there are no more results.
///
/// The page token is valid for only 2 hours.
core.String nextPageToken;
/// The list of queues.
core.List<Queue> queues;
ListQueuesResponse();
ListQueuesResponse.fromJson(core.Map _json) {
if (_json.containsKey("nextPageToken")) {
nextPageToken = _json["nextPageToken"];
}
if (_json.containsKey("queues")) {
queues =
_json["queues"].map((value) => new Queue.fromJson(value)).toList();
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (nextPageToken != null) {
_json["nextPageToken"] = nextPageToken;
}
if (queues != null) {
_json["queues"] = queues.map((value) => (value).toJson()).toList();
}
return _json;
}
}
/// Response message for listing tasks using CloudTasks.ListTasks.
class ListTasksResponse {
/// A token to retrieve next page of results.
///
/// To return the next page of results, call
/// CloudTasks.ListTasks with this value as the
/// ListTasksRequest.page_token.
///
/// If the next_page_token is empty, there are no more results.
core.String nextPageToken;
/// The list of tasks.
core.List<Task> tasks;
ListTasksResponse();
ListTasksResponse.fromJson(core.Map _json) {
if (_json.containsKey("nextPageToken")) {
nextPageToken = _json["nextPageToken"];
}
if (_json.containsKey("tasks")) {
tasks = _json["tasks"].map((value) => new Task.fromJson(value)).toList();
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (nextPageToken != null) {
_json["nextPageToken"] = nextPageToken;
}
if (tasks != null) {
_json["tasks"] = tasks.map((value) => (value).toJson()).toList();
}
return _json;
}
}
/// A resource that represents Google Cloud Platform location.
class Location {
/// Cross-service attributes for the location. For example
///
/// {"cloud.googleapis.com/region": "us-east1"}
core.Map<core.String, core.String> labels;
/// The canonical id for this location. For example: `"us-east1"`.
core.String locationId;
/// Service-specific metadata. For example the available capacity at the given
/// location.
///
/// The values for Object must be JSON objects. It can consist of `num`,
/// `String`, `bool` and `null` as well as `Map` and `List` values.
core.Map<core.String, core.Object> metadata;
/// Resource name for the location, which may vary between implementations.
/// For example: `"projects/example-project/locations/us-east1"`
core.String name;
Location();
Location.fromJson(core.Map _json) {
if (_json.containsKey("labels")) {
labels = _json["labels"];
}
if (_json.containsKey("locationId")) {
locationId = _json["locationId"];
}
if (_json.containsKey("metadata")) {
metadata = _json["metadata"];
}
if (_json.containsKey("name")) {
name = _json["name"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (labels != null) {
_json["labels"] = labels;
}
if (locationId != null) {
_json["locationId"] = locationId;
}
if (metadata != null) {
_json["metadata"] = metadata;
}
if (name != null) {
_json["name"] = name;
}
return _json;
}
}
/// Request message for CloudTasks.PauseQueue.
class PauseQueueRequest {
PauseQueueRequest();
PauseQueueRequest.fromJson(core.Map _json) {}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
return _json;
}
}
/// Defines an Identity and Access Management (IAM) policy. It is used to
/// specify access control policies for Cloud Platform resources.
///
///
/// A `Policy` consists of a list of `bindings`. A `Binding` binds a list of
/// `members` to a `role`, where the members can be user accounts, Google
/// groups,
/// Google domains, and service accounts. A `role` is a named list of
/// permissions
/// defined by IAM.
///
/// **Example**
///
/// {
/// "bindings": [
/// {
/// "role": "roles/owner",
/// "members": [
/// "user:mike@example.com",
/// "group:admins@example.com",
/// "domain:google.com",
/// "serviceAccount:my-other-app@appspot.gserviceaccount.com",
/// ]
/// },
/// {
/// "role": "roles/viewer",
/// "members": ["user:sean@example.com"]
/// }
/// ]
/// }
///
/// For a description of IAM and its features, see the
/// [IAM developer's guide](https://cloud.google.com/iam).
class Policy {
/// Associates a list of `members` to a `role`.
/// `bindings` with no members will result in an error.
core.List<Binding> bindings;
/// `etag` is used for optimistic concurrency control as a way to help
/// prevent simultaneous updates of a policy from overwriting each other.
/// It is strongly suggested that systems make use of the `etag` in the
/// read-modify-write cycle to perform policy updates in order to avoid race
/// conditions: An `etag` is returned in the response to `getIamPolicy`, and
/// systems are expected to put that etag in the request to `setIamPolicy` to
/// ensure that their change will be applied to the same version of the
/// policy.
///
/// If no `etag` is provided in the call to `setIamPolicy`, then the existing
/// policy is overwritten blindly.
core.String etag;
core.List<core.int> get etagAsBytes {
return convert.BASE64.decode(etag);
}
void set etagAsBytes(core.List<core.int> _bytes) {
etag =
convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
}
/// Version of the `Policy`. The default version is 0.
core.int version;
Policy();
Policy.fromJson(core.Map _json) {
if (_json.containsKey("bindings")) {
bindings = _json["bindings"]
.map((value) => new Binding.fromJson(value))
.toList();
}
if (_json.containsKey("etag")) {
etag = _json["etag"];
}
if (_json.containsKey("version")) {
version = _json["version"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (bindings != null) {
_json["bindings"] = bindings.map((value) => (value).toJson()).toList();
}
if (etag != null) {
_json["etag"] = etag;
}
if (version != null) {
_json["version"] = version;
}
return _json;
}
}
/// The pull message contains data that can be used by the caller of
/// CloudTasks.PullTasks to process the task.
///
/// This proto can only be used for tasks in a queue which has
/// Queue.pull_target set.
class PullMessage {
/// A data payload consumed by the task worker to execute the task.
core.String payload;
core.List<core.int> get payloadAsBytes {
return convert.BASE64.decode(payload);
}
void set payloadAsBytes(core.List<core.int> _bytes) {
payload =
convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
}
/// A meta-data tag for this task.
///
/// This value is used by CloudTasks.PullTasks calls when
/// PullTasksRequest.filter is `tag=<tag>`.
///
/// The tag must be less than 500 bytes.
core.String tag;
core.List<core.int> get tagAsBytes {
return convert.BASE64.decode(tag);
}
void set tagAsBytes(core.List<core.int> _bytes) {
tag =
convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
}
PullMessage();
PullMessage.fromJson(core.Map _json) {
if (_json.containsKey("payload")) {
payload = _json["payload"];
}
if (_json.containsKey("tag")) {
tag = _json["tag"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (payload != null) {
_json["payload"] = payload;
}
if (tag != null) {
_json["tag"] = tag;
}
return _json;
}
}
/// Deprecated. Use PullTarget.
class PullQueueConfig {
PullQueueConfig();
PullQueueConfig.fromJson(core.Map _json) {}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
return _json;
}
}
/// Pull target.
class PullTarget {
PullTarget();
PullTarget.fromJson(core.Map _json) {}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
return _json;
}
}
/// Deprecated. Use PullMessage.
class PullTaskTarget {
/// Deprecated. Use PullMessage.payload.
core.String payload;
core.List<core.int> get payloadAsBytes {
return convert.BASE64.decode(payload);
}
void set payloadAsBytes(core.List<core.int> _bytes) {
payload =
convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
}
/// Deprecated. Use PullMessage.tag.
core.String tag;
core.List<core.int> get tagAsBytes {
return convert.BASE64.decode(tag);
}
void set tagAsBytes(core.List<core.int> _bytes) {
tag =
convert.BASE64.encode(_bytes).replaceAll("/", "_").replaceAll("+", "-");
}
PullTaskTarget();
PullTaskTarget.fromJson(core.Map _json) {
if (_json.containsKey("payload")) {
payload = _json["payload"];
}
if (_json.containsKey("tag")) {
tag = _json["tag"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (payload != null) {
_json["payload"] = payload;
}
if (tag != null) {
_json["tag"] = tag;
}
return _json;
}
}
/// Request message for pulling tasks using CloudTasks.PullTasks.
class PullTasksRequest {
/// `filter` can be used to specify a subset of tasks to lease.
///
/// When `filter` is set to `tag=<my-tag>` then the
/// PullTasksResponse will contain only tasks whose
/// PullMessage.tag is equal to `<my-tag>`. `<my-tag>` must be less than
/// 500 bytes.
///
/// When `filter` is set to `tag_function=oldest_tag()`, only tasks which have
/// the same tag as the task with the oldest schedule_time will be returned.
///
/// Grammar Syntax:
///
/// * `filter = "tag=" tag | "tag_function=" function`
///
/// * `tag = string | bytes`
///
/// * `function = "oldest_tag()"`
///
/// The `oldest_tag()` function returns tasks which have the same tag as the
/// oldest task (ordered by schedule time).
core.String filter;
/// The duration of the lease.
///
/// Each task returned in the PullTasksResponse will have its
/// Task.schedule_time set to the current time plus the
/// `lease_duration`. A task that has been returned in a
/// PullTasksResponse is leased -- that task will not be
/// returned in a different PullTasksResponse before the
/// Task.schedule_time.
///
/// After the lease holder has successfully finished the work
/// associated with the task, the lease holder must call
/// CloudTasks.AcknowledgeTask. If the task is not acknowledged
/// via CloudTasks.AcknowledgeTask before the
/// Task.schedule_time then it will be returned in a later
/// PullTasksResponse so that another lease holder can process
/// it.
///
/// The maximum lease duration is 1 week.
/// `lease_duration` will be truncated to the nearest second.
core.String leaseDuration;
/// The maximum number of tasks to lease. The maximum that can be
/// requested is 1000.
core.int maxTasks;
/// The response_view specifies which subset of the Task will be
/// returned.
///
/// By default response_view is Task.View.BASIC; not all
/// information is retrieved by default because some data, such as
/// payloads, might be desirable to return only when needed because
/// of its large size or because of the sensitivity of data that it
/// contains.
///
/// Authorization for Task.View.FULL requires `cloudtasks.tasks.fullView`
/// [Google IAM](/iam/) permission on the
/// Task.name resource.
/// Possible string values are:
/// - "VIEW_UNSPECIFIED" : Unspecified. Defaults to BASIC.
/// - "BASIC" : The basic view omits fields which can be large or can contain
/// sensitive data.
///
/// This view does not include the payload.
/// - "FULL" : All information is returned.
///
/// Payloads might be desirable to return only when needed, because
/// they can be large and because of the sensitivity of the data
/// that you choose to store in it.
///
/// Authorization for Task.View.FULL requires
/// `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
/// permission on the Queue.name resource.
core.String responseView;
PullTasksRequest();
PullTasksRequest.fromJson(core.Map _json) {
if (_json.containsKey("filter")) {
filter = _json["filter"];
}
if (_json.containsKey("leaseDuration")) {
leaseDuration = _json["leaseDuration"];
}
if (_json.containsKey("maxTasks")) {
maxTasks = _json["maxTasks"];
}
if (_json.containsKey("responseView")) {
responseView = _json["responseView"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (filter != null) {
_json["filter"] = filter;
}
if (leaseDuration != null) {
_json["leaseDuration"] = leaseDuration;
}
if (maxTasks != null) {
_json["maxTasks"] = maxTasks;
}
if (responseView != null) {
_json["responseView"] = responseView;
}
return _json;
}
}
/// Response message for pulling tasks using CloudTasks.PullTasks.
class PullTasksResponse {
/// The leased tasks.
core.List<Task> tasks;
PullTasksResponse();
PullTasksResponse.fromJson(core.Map _json) {
if (_json.containsKey("tasks")) {
tasks = _json["tasks"].map((value) => new Task.fromJson(value)).toList();
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (tasks != null) {
_json["tasks"] = tasks.map((value) => (value).toJson()).toList();
}
return _json;
}
}
/// Request message for CloudTasks.PurgeQueue.
class PurgeQueueRequest {
PurgeQueueRequest();
PurgeQueueRequest.fromJson(core.Map _json) {}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
return _json;
}
}
/// A queue is a container of related tasks. Queues are configured to manage
/// how those tasks are dispatched. Configurable properties include rate limits,
/// retry options, target types, and others.
class Queue {
/// App Engine HTTP target.
///
/// An App Engine queue is a queue that has an AppEngineHttpTarget.
AppEngineHttpTarget appEngineHttpTarget;
/// Deprecated. Use Queue.app_engine_http_target.
AppEngineQueueConfig appEngineQueueConfig;
/// The queue name.
///
/// The queue name must have the following format:
/// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
///
/// * `PROJECT_ID` can contain uppercase and lowercase letters,
/// numbers, hyphens, colons, and periods; that is, it must match
/// the regular expression: `[a-zA-Z\\d-:\\.]+`.
/// * `QUEUE_ID` can contain uppercase and lowercase letters,
/// numbers, and hyphens; that is, it must match the regular
/// expression: `[a-zA-Z\\d-]+`. The maximum length is 100
/// characters.
///
/// Caller-specified and required in CreateQueueRequest, after which
/// it becomes output only.
core.String name;
/// Deprecated. Use Queue.pull_target.
PullQueueConfig pullQueueConfig;
/// Pull target.
///
/// A pull queue is a queue that has a PullTarget.
PullTarget pullTarget;
/// Output only.
///
/// The last time this queue was purged. All tasks that were
/// created before this time were purged.
///
/// A queue can be purged using CloudTasks.PurgeQueue, the
/// [App Engine Task Queue SDK, or the Cloud
/// Console](/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).
///
/// Purge time will be truncated to the nearest microsecond. Purge
/// time will be zero if the queue has never been purged.
core.String purgeTime;
/// Output only.
///
/// The state of the queue.
///
/// `queue_state` can only be changed by called
/// CloudTasks.PauseQueue, CloudTasks.ResumeQueue, or uploading
/// [queue.yaml](/appengine/docs/python/config/queueref).
/// CloudTasks.UpdateQueue cannot be used to change `queue_state`.
/// Possible string values are:
/// - "QUEUE_STATE_UNSPECIFIED" : Unspecified state.
/// - "RUNNING" : The queue is running. Tasks can be dispatched.
/// - "PAUSED" : Tasks are paused by the user. If the queue is paused then
/// Cloud
/// Tasks will stop delivering tasks from it, but more tasks can
/// still be added to it by the user. When a pull queue is paused,
/// all CloudTasks.PullTasks calls will return a
/// `FAILED_PRECONDITION` error.
/// - "DISABLED" : The queue is disabled.
///
/// A queue becomes `DISABLED` when
/// [queue.yaml](/appengine/docs/python/config/queueref) or
/// [queue.xml](appengine/docs/standard/java/config/queueref) is uploaded
/// which does not contain the queue. You cannot directly disable a queue.
///
/// When a queue is disabled, tasks can still be added to a queue
/// but the tasks are not dispatched and CloudTasks.PullTasks calls
/// return a `FAILED_PRECONDITION` error.
///
/// To permanently delete this queue and all of its tasks, call
/// CloudTasks.DeleteQueue.
core.String queueState;
/// Rate limits for task dispatches.
///
/// Queue.rate_limits and Queue.retry_config are related because they
/// both control task attempts however they control how tasks are attempted in
/// different ways:
///
/// * Queue.rate_limits controls the total rate of dispatches from a queue
/// (i.e. all traffic dispatched from the queue, regardless of whether the
/// dispatch is from a first attempt or a retry).
/// * Queue.retry_config controls what happens to particular a task after
/// its first attempt fails. That is, Queue.retry_config controls task
/// retries (the second attempt, third attempt, etc).
RateLimits rateLimits;
/// Settings that determine the retry behavior.
///
/// * For tasks created using Cloud Tasks: the queue-level retry settings
/// apply to all tasks in the queue that were created using Cloud Tasks.
/// Retry settings cannot be set on individual tasks.
/// * For tasks created using the App Engine SDK: the queue-level retry
/// settings apply to all tasks in the queue which do not have retry settings
/// explicitly set on the task and were created by the App Engine SDK. See
/// [App Engine
/// documentation](/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
RetryConfig retryConfig;
Queue();
Queue.fromJson(core.Map _json) {
if (_json.containsKey("appEngineHttpTarget")) {
appEngineHttpTarget =
new AppEngineHttpTarget.fromJson(_json["appEngineHttpTarget"]);
}
if (_json.containsKey("appEngineQueueConfig")) {
appEngineQueueConfig =
new AppEngineQueueConfig.fromJson(_json["appEngineQueueConfig"]);
}
if (_json.containsKey("name")) {
name = _json["name"];
}
if (_json.containsKey("pullQueueConfig")) {
pullQueueConfig = new PullQueueConfig.fromJson(_json["pullQueueConfig"]);
}
if (_json.containsKey("pullTarget")) {
pullTarget = new PullTarget.fromJson(_json["pullTarget"]);
}
if (_json.containsKey("purgeTime")) {
purgeTime = _json["purgeTime"];
}
if (_json.containsKey("queueState")) {
queueState = _json["queueState"];
}
if (_json.containsKey("rateLimits")) {
rateLimits = new RateLimits.fromJson(_json["rateLimits"]);
}
if (_json.containsKey("retryConfig")) {
retryConfig = new RetryConfig.fromJson(_json["retryConfig"]);
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (appEngineHttpTarget != null) {
_json["appEngineHttpTarget"] = (appEngineHttpTarget).toJson();
}
if (appEngineQueueConfig != null) {
_json["appEngineQueueConfig"] = (appEngineQueueConfig).toJson();
}
if (name != null) {
_json["name"] = name;
}
if (pullQueueConfig != null) {
_json["pullQueueConfig"] = (pullQueueConfig).toJson();
}
if (pullTarget != null) {
_json["pullTarget"] = (pullTarget).toJson();
}
if (purgeTime != null) {
_json["purgeTime"] = purgeTime;
}
if (queueState != null) {
_json["queueState"] = queueState;
}
if (rateLimits != null) {
_json["rateLimits"] = (rateLimits).toJson();
}
if (retryConfig != null) {
_json["retryConfig"] = (retryConfig).toJson();
}
return _json;
}
}
/// Rate limits.
///
/// This message determines the maximum rate that tasks can be dispatched by a
/// queue, regardless of whether the dispatch is a first task attempt or a
/// retry.
class RateLimits {
/// Output only.
///
/// The max burst size limits how fast the queue is processed when
/// many tasks are in the queue and the rate is high. This field
/// allows the queue to have a high rate so processing starts shortly
/// after a task is enqueued, but still limits resource usage when
/// many tasks are enqueued in a short period of time.
///
/// * For App Engine queues, if
/// RateLimits.max_tasks_dispatched_per_second is 1, this
/// field is 10; otherwise this field is
/// RateLimits.max_tasks_dispatched_per_second / 5.
/// * For pull queues, this field is output only and always 10,000.
///
/// Note: For App Engine queues that were created through
/// `queue.yaml/xml`, `max_burst_size` might not have the same
/// settings as specified above; CloudTasks.UpdateQueue can be
/// used to set `max_burst_size` only to the values specified above.
///
/// This field has the same meaning as
/// [bucket_size in
/// queue.yaml](/appengine/docs/standard/python/config/queueref#bucket_size).
core.int maxBurstSize;
/// The maximum number of concurrent tasks that Cloud Tasks allows
/// to be dispatched for this queue. After this threshold has been
/// reached, Cloud Tasks stops dispatching tasks until the number of
/// concurrent requests decreases.
///
/// The maximum allowed value is 5,000.
///
/// * For App Engine queues, this field is 10 by default.
/// * For pull queues, this field is output only and always -1, which
/// indicates no limit.
///
/// This field has the same meaning as
/// [max_concurrent_requests in
/// queue.yaml](/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
core.int maxConcurrentTasks;
/// The maximum rate at which tasks are dispatched from this
/// queue.
///
/// The maximum allowed value is 500.
///
/// * For App Engine queues, this field is 1 by default.
/// * For pull queues, this field is output only and always 10,000.
///
/// This field has the same meaning as
/// [rate in
/// queue.yaml](/appengine/docs/standard/python/config/queueref#rate).
core.double maxTasksDispatchedPerSecond;
RateLimits();
RateLimits.fromJson(core.Map _json) {
if (_json.containsKey("maxBurstSize")) {
maxBurstSize = _json["maxBurstSize"];
}
if (_json.containsKey("maxConcurrentTasks")) {
maxConcurrentTasks = _json["maxConcurrentTasks"];
}
if (_json.containsKey("maxTasksDispatchedPerSecond")) {
maxTasksDispatchedPerSecond = _json["maxTasksDispatchedPerSecond"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (maxBurstSize != null) {
_json["maxBurstSize"] = maxBurstSize;
}
if (maxConcurrentTasks != null) {
_json["maxConcurrentTasks"] = maxConcurrentTasks;
}
if (maxTasksDispatchedPerSecond != null) {
_json["maxTasksDispatchedPerSecond"] = maxTasksDispatchedPerSecond;
}
return _json;
}
}
/// Request message for renewing a lease using CloudTasks.RenewLease.
class RenewLeaseRequest {
/// Required.
///
/// The desired new lease duration, starting from now.
///
///
/// The maximum lease duration is 1 week.
/// `new_lease_duration` will be truncated to the nearest second.
core.String newLeaseDuration;
/// The response_view specifies which subset of the Task will be
/// returned.
///
/// By default response_view is Task.View.BASIC; not all
/// information is retrieved by default because some data, such as
/// payloads, might be desirable to return only when needed because
/// of its large size or because of the sensitivity of data that it
/// contains.
///
/// Authorization for Task.View.FULL requires `cloudtasks.tasks.fullView`
/// [Google IAM](/iam/) permission on the
/// Task.name resource.
/// Possible string values are:
/// - "VIEW_UNSPECIFIED" : Unspecified. Defaults to BASIC.
/// - "BASIC" : The basic view omits fields which can be large or can contain
/// sensitive data.
///
/// This view does not include the payload.
/// - "FULL" : All information is returned.
///
/// Payloads might be desirable to return only when needed, because
/// they can be large and because of the sensitivity of the data
/// that you choose to store in it.
///
/// Authorization for Task.View.FULL requires
/// `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
/// permission on the Queue.name resource.
core.String responseView;
/// Required.
///
/// The task's current schedule time, available in the Task.schedule_time
/// returned in PullTasksResponse.tasks or
/// CloudTasks.RenewLease. This restriction is to check that
/// the caller is renewing the correct task.
core.String scheduleTime;
RenewLeaseRequest();
RenewLeaseRequest.fromJson(core.Map _json) {
if (_json.containsKey("newLeaseDuration")) {
newLeaseDuration = _json["newLeaseDuration"];
}
if (_json.containsKey("responseView")) {
responseView = _json["responseView"];
}
if (_json.containsKey("scheduleTime")) {
scheduleTime = _json["scheduleTime"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (newLeaseDuration != null) {
_json["newLeaseDuration"] = newLeaseDuration;
}
if (responseView != null) {
_json["responseView"] = responseView;
}
if (scheduleTime != null) {
_json["scheduleTime"] = scheduleTime;
}
return _json;
}
}
/// Request message for CloudTasks.ResumeQueue.
class ResumeQueueRequest {
ResumeQueueRequest();
ResumeQueueRequest.fromJson(core.Map _json) {}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
return _json;
}
}
/// Retry config.
///
/// These settings determine how a failed task attempt is retried.
class RetryConfig {
/// The maximum number of attempts for a task.
///
/// Cloud Tasks will attempt the task `max_attempts` times (that
/// is, if the first attempt fails, then there will be
/// `max_attempts - 1` retries). Must be > 0.
core.int maxAttempts;
/// The maximum amount of time to wait before retrying a task after
/// it fails. The default is 1 hour.
///
/// * For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),
/// this field is 1 hour by default.
/// * For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this field
/// is output only and always 0.
///
/// `max_backoff` will be truncated to the nearest second.
///
/// This field has the same meaning as
/// [max_backoff_seconds in
/// queue.yaml](/appengine/docs/standard/python/config/queueref#retry_parameters).
core.String maxBackoff;
/// The time between retries increases exponentially `max_doublings` times.
/// `max_doublings` is maximum number of times that the interval between
/// failed
/// task retries will be doubled before the interval increases linearly.
/// After max_doublings intervals, the retry interval will be
/// 2^(max_doublings - 1) * RetryConfig.min_backoff.
///
/// * For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),
/// this field is 16 by default.
/// * For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this field
/// is output only and always 0.
///
/// This field has the same meaning as
/// [max_doublings in
/// queue.yaml](/appengine/docs/standard/python/config/queueref#retry_parameters).
core.int maxDoublings;
/// If positive, `max_retry_duration` specifies the time limit for retrying a
/// failed task, measured from when the task was first attempted. Once
/// `max_retry_duration` time has passed *and* the task has been attempted
/// RetryConfig.max_attempts times, no further attempts will be made and
/// the task will be deleted.
///
/// If zero, then the task age is unlimited.
///
/// * For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),
/// this field is 0 seconds by default.
/// * For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this
/// field is output only and always 0.
///
/// `max_retry_duration` will be truncated to the nearest second.
///
/// This field has the same meaning as
/// [task_age_limit in
/// queue.yaml](/appengine/docs/standard/python/config/queueref#retry_parameters).
core.String maxRetryDuration;
/// The minimum amount of time to wait before retrying a task after
/// it fails.
///
/// * For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),
/// this field is 0.1 seconds by default.
/// * For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this
/// field is output only and always 0.
///
/// `min_backoff` will be truncated to the nearest second.
///
/// This field has the same meaning as
/// [min_backoff_seconds in
/// queue.yaml](/appengine/docs/standard/python/config/queueref#retry_parameters).
core.String minBackoff;
/// If true, then the number of attempts is unlimited.
core.bool unlimitedAttempts;
RetryConfig();
RetryConfig.fromJson(core.Map _json) {
if (_json.containsKey("maxAttempts")) {
maxAttempts = _json["maxAttempts"];
}
if (_json.containsKey("maxBackoff")) {
maxBackoff = _json["maxBackoff"];
}
if (_json.containsKey("maxDoublings")) {
maxDoublings = _json["maxDoublings"];
}
if (_json.containsKey("maxRetryDuration")) {
maxRetryDuration = _json["maxRetryDuration"];
}
if (_json.containsKey("minBackoff")) {
minBackoff = _json["minBackoff"];
}
if (_json.containsKey("unlimitedAttempts")) {
unlimitedAttempts = _json["unlimitedAttempts"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (maxAttempts != null) {
_json["maxAttempts"] = maxAttempts;
}
if (maxBackoff != null) {
_json["maxBackoff"] = maxBackoff;
}
if (maxDoublings != null) {
_json["maxDoublings"] = maxDoublings;
}
if (maxRetryDuration != null) {
_json["maxRetryDuration"] = maxRetryDuration;
}
if (minBackoff != null) {
_json["minBackoff"] = minBackoff;
}
if (unlimitedAttempts != null) {
_json["unlimitedAttempts"] = unlimitedAttempts;
}
return _json;
}
}
/// Request message for forcing a task to run now using
/// CloudTasks.RunTask.
class RunTaskRequest {
/// The response_view specifies which subset of the Task will be
/// returned.
///
/// By default response_view is Task.View.BASIC; not all
/// information is retrieved by default because some data, such as
/// payloads, might be desirable to return only when needed because
/// of its large size or because of the sensitivity of data that it
/// contains.
///
/// Authorization for Task.View.FULL requires `cloudtasks.tasks.fullView`
/// [Google IAM](/iam/) permission on the
/// Task.name resource.
/// Possible string values are:
/// - "VIEW_UNSPECIFIED" : Unspecified. Defaults to BASIC.
/// - "BASIC" : The basic view omits fields which can be large or can contain
/// sensitive data.
///
/// This view does not include the payload.
/// - "FULL" : All information is returned.
///
/// Payloads might be desirable to return only when needed, because
/// they can be large and because of the sensitivity of the data
/// that you choose to store in it.
///
/// Authorization for Task.View.FULL requires
/// `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
/// permission on the Queue.name resource.
core.String responseView;
RunTaskRequest();
RunTaskRequest.fromJson(core.Map _json) {
if (_json.containsKey("responseView")) {
responseView = _json["responseView"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (responseView != null) {
_json["responseView"] = responseView;
}
return _json;
}
}
/// Request message for `SetIamPolicy` method.
class SetIamPolicyRequest {
/// REQUIRED: The complete policy to be applied to the `resource`. The size of
/// the policy is limited to a few 10s of KB. An empty policy is a
/// valid policy but certain Cloud Platform services (such as Projects)
/// might reject them.
Policy policy;
SetIamPolicyRequest();
SetIamPolicyRequest.fromJson(core.Map _json) {
if (_json.containsKey("policy")) {
policy = new Policy.fromJson(_json["policy"]);
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (policy != null) {
_json["policy"] = (policy).toJson();
}
return _json;
}
}
/// The `Status` type defines a logical error model that is suitable for
/// different
/// programming environments, including REST APIs and RPC APIs. It is used by
/// [gRPC](https://github.com/grpc). The error model is designed to be:
///
/// - Simple to use and understand for most users
/// - Flexible enough to meet unexpected needs
///
/// # Overview
///
/// The `Status` message contains three pieces of data: error code, error
/// message,
/// and error details. The error code should be an enum value of
/// google.rpc.Code, but it may accept additional error codes if needed. The
/// error message should be a developer-facing English message that helps
/// developers *understand* and *resolve* the error. If a localized user-facing
/// error message is needed, put the localized message in the error details or
/// localize it in the client. The optional error details may contain arbitrary
/// information about the error. There is a predefined set of error detail types
/// in the package `google.rpc` that can be used for common error conditions.
///
/// # Language mapping
///
/// The `Status` message is the logical representation of the error model, but
/// it
/// is not necessarily the actual wire format. When the `Status` message is
/// exposed in different client libraries and different wire protocols, it can
/// be
/// mapped differently. For example, it will likely be mapped to some exceptions
/// in Java, but more likely mapped to some error codes in C.
///
/// # Other uses
///
/// The error model and the `Status` message can be used in a variety of
/// environments, either with or without APIs, to provide a
/// consistent developer experience across different environments.
///
/// Example uses of this error model include:
///
/// - Partial errors. If a service needs to return partial errors to the client,
/// it may embed the `Status` in the normal response to indicate the partial
/// errors.
///
/// - Workflow errors. A typical workflow has multiple steps. Each step may
/// have a `Status` message for error reporting.
///
/// - Batch operations. If a client uses batch request and batch response, the
/// `Status` message should be used directly inside batch response, one for
/// each error sub-response.
///
/// - Asynchronous operations. If an API call embeds asynchronous operation
/// results in its response, the status of those operations should be
/// represented directly using the `Status` message.
///
/// - Logging. If some API errors are stored in logs, the message `Status` could
/// be used directly after any stripping needed for security/privacy reasons.
class Status {
/// The status code, which should be an enum value of google.rpc.Code.
core.int code;
/// A list of messages that carry the error details. There is a common set of
/// message types for APIs to use.
///
/// The values for Object must be JSON objects. It can consist of `num`,
/// `String`, `bool` and `null` as well as `Map` and `List` values.
core.List<core.Map<core.String, core.Object>> details;
/// A developer-facing error message, which should be in English. Any
/// user-facing error message should be localized and sent in the
/// google.rpc.Status.details field, or localized by the client.
core.String message;
Status();
Status.fromJson(core.Map _json) {
if (_json.containsKey("code")) {
code = _json["code"];
}
if (_json.containsKey("details")) {
details = _json["details"];
}
if (_json.containsKey("message")) {
message = _json["message"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (code != null) {
_json["code"] = code;
}
if (details != null) {
_json["details"] = details;
}
if (message != null) {
_json["message"] = message;
}
return _json;
}
}
/// A unit of scheduled work.
class Task {
/// App Engine HTTP request that is sent to the task's target. Can be set
/// only if Queue.app_engine_http_target is set.
///
/// An App Engine task is a task that has AppEngineHttpRequest set.
AppEngineHttpRequest appEngineHttpRequest;
/// Deprecated. Use Task.app_engine_http_request.
AppEngineTaskTarget appEngineTaskTarget;
/// Output only.
///
/// The time that the task was created.
///
/// `create_time` will be truncated to the nearest second.
core.String createTime;
/// The task name.
///
/// The task name must have the following format:
/// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
///
/// * `PROJECT_ID` can contain uppercase and lowercase letters,
/// numbers, hyphens, colons, and periods; that is, it must match
/// the regular expression: `[a-zA-Z\\d-:\\.]+`.
/// * `QUEUE_ID` can contain uppercase and lowercase letters,
/// numbers, and hyphens; that is, it must match the regular
/// expression: `[a-zA-Z\\d-]+`. The maximum length is 100
/// characters.
/// * `TASK_ID` contain uppercase and lowercase letters, numbers,
/// underscores, and hyphens; that is, it must match the regular
/// expression: `[a-zA-Z\\d_-]+`. The maximum length is 500
/// characters.
///
/// Optionally caller-specified in CreateTaskRequest.
core.String name;
/// Pull message contains data that should be used by the caller of
/// CloudTasks.PullTasks to process the task. Can be set only if
/// Queue.pull_target is set.
///
/// A pull task is a task that has PullMessage set.
PullMessage pullMessage;
/// Deprecated. Use Task.pull_message.
PullTaskTarget pullTaskTarget;
/// The time when the task is scheduled to be attempted.
///
/// For pull queues, this is the time when the task is available to
/// be leased; if a task is currently leased, this is the time when
/// the current lease expires, that is, the time that the task was
/// leased plus the PullTasksRequest.lease_duration.
///
/// For App Engine queues, this is when the task will be attempted or retried.
///
/// `schedule_time` will be truncated to the nearest microsecond.
core.String scheduleTime;
/// Output only.
///
/// Task status.
TaskStatus taskStatus;
/// Output only.
///
/// The view specifies which subset of the Task has been
/// returned.
/// Possible string values are:
/// - "VIEW_UNSPECIFIED" : Unspecified. Defaults to BASIC.
/// - "BASIC" : The basic view omits fields which can be large or can contain
/// sensitive data.
///
/// This view does not include the payload.
/// - "FULL" : All information is returned.
///
/// Payloads might be desirable to return only when needed, because
/// they can be large and because of the sensitivity of the data
/// that you choose to store in it.
///
/// Authorization for Task.View.FULL requires
/// `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
/// permission on the Queue.name resource.
core.String view;
Task();
Task.fromJson(core.Map _json) {
if (_json.containsKey("appEngineHttpRequest")) {
appEngineHttpRequest =
new AppEngineHttpRequest.fromJson(_json["appEngineHttpRequest"]);
}
if (_json.containsKey("appEngineTaskTarget")) {
appEngineTaskTarget =
new AppEngineTaskTarget.fromJson(_json["appEngineTaskTarget"]);
}
if (_json.containsKey("createTime")) {
createTime = _json["createTime"];
}
if (_json.containsKey("name")) {
name = _json["name"];
}
if (_json.containsKey("pullMessage")) {
pullMessage = new PullMessage.fromJson(_json["pullMessage"]);
}
if (_json.containsKey("pullTaskTarget")) {
pullTaskTarget = new PullTaskTarget.fromJson(_json["pullTaskTarget"]);
}
if (_json.containsKey("scheduleTime")) {
scheduleTime = _json["scheduleTime"];
}
if (_json.containsKey("taskStatus")) {
taskStatus = new TaskStatus.fromJson(_json["taskStatus"]);
}
if (_json.containsKey("view")) {
view = _json["view"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (appEngineHttpRequest != null) {
_json["appEngineHttpRequest"] = (appEngineHttpRequest).toJson();
}
if (appEngineTaskTarget != null) {
_json["appEngineTaskTarget"] = (appEngineTaskTarget).toJson();
}
if (createTime != null) {
_json["createTime"] = createTime;
}
if (name != null) {
_json["name"] = name;
}
if (pullMessage != null) {
_json["pullMessage"] = (pullMessage).toJson();
}
if (pullTaskTarget != null) {
_json["pullTaskTarget"] = (pullTaskTarget).toJson();
}
if (scheduleTime != null) {
_json["scheduleTime"] = scheduleTime;
}
if (taskStatus != null) {
_json["taskStatus"] = (taskStatus).toJson();
}
if (view != null) {
_json["view"] = view;
}
return _json;
}
}
/// Status of the task.
class TaskStatus {
/// Output only.
///
/// The number of attempts dispatched. This count includes tasks which have
/// been dispatched but haven't received a response.
core.String attemptDispatchCount;
/// Output only.
///
/// The number of attempts which have received a response.
///
/// This field is not calculated for
/// [pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget).
core.String attemptResponseCount;
/// Output only.
///
/// The status of the task's first attempt.
///
/// Only AttemptStatus.dispatch_time will be set.
/// The other AttemptStatus information is not retained by Cloud Tasks.
///
/// This field is not calculated for
/// [pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget).
AttemptStatus firstAttemptStatus;
/// Output only.
///
/// The status of the task's last attempt.
///
/// This field is not calculated for
/// [pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget).
AttemptStatus lastAttemptStatus;
TaskStatus();
TaskStatus.fromJson(core.Map _json) {
if (_json.containsKey("attemptDispatchCount")) {
attemptDispatchCount = _json["attemptDispatchCount"];
}
if (_json.containsKey("attemptResponseCount")) {
attemptResponseCount = _json["attemptResponseCount"];
}
if (_json.containsKey("firstAttemptStatus")) {
firstAttemptStatus =
new AttemptStatus.fromJson(_json["firstAttemptStatus"]);
}
if (_json.containsKey("lastAttemptStatus")) {
lastAttemptStatus =
new AttemptStatus.fromJson(_json["lastAttemptStatus"]);
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (attemptDispatchCount != null) {
_json["attemptDispatchCount"] = attemptDispatchCount;
}
if (attemptResponseCount != null) {
_json["attemptResponseCount"] = attemptResponseCount;
}
if (firstAttemptStatus != null) {
_json["firstAttemptStatus"] = (firstAttemptStatus).toJson();
}
if (lastAttemptStatus != null) {
_json["lastAttemptStatus"] = (lastAttemptStatus).toJson();
}
return _json;
}
}
/// Request message for `TestIamPermissions` method.
class TestIamPermissionsRequest {
/// The set of permissions to check for the `resource`. Permissions with
/// wildcards (such as '*' or 'storage.*') are not allowed. For more
/// information see
/// [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
core.List<core.String> permissions;
TestIamPermissionsRequest();
TestIamPermissionsRequest.fromJson(core.Map _json) {
if (_json.containsKey("permissions")) {
permissions = _json["permissions"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (permissions != null) {
_json["permissions"] = permissions;
}
return _json;
}
}
/// Response message for `TestIamPermissions` method.
class TestIamPermissionsResponse {
/// A subset of `TestPermissionsRequest.permissions` that the caller is
/// allowed.
core.List<core.String> permissions;
TestIamPermissionsResponse();
TestIamPermissionsResponse.fromJson(core.Map _json) {
if (_json.containsKey("permissions")) {
permissions = _json["permissions"];
}
}
core.Map<core.String, core.Object> toJson() {
final core.Map<core.String, core.Object> _json =
new core.Map<core.String, core.Object>();
if (permissions != null) {
_json["permissions"] = permissions;
}
return _json;
}
}