@maxim_mazurok/gapi.client.cloudtasks-v2 0.0.20220813

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/index.d.ts +1307 -0
  2. package/package.json +20 -0
  3. package/readme.md +68 -0
  4. package/tests.ts +308 -0
  5. package/tsconfig.json +18 -0
  6. package/tslint.json +6 -0
package/index.d.ts ADDED
@@ -0,0 +1,1307 @@
1
+ /* Type definitions for non-npm package Cloud Tasks API v2 0.0 */
2
+ // Project: https://cloud.google.com/tasks/
3
+ // Definitions by: Maxim Mazurok <https://github.com/Maxim-Mazurok>
4
+ // Nick Amoscato <https://github.com/namoscato>
5
+ // Declan Vong <https://github.com/declanvong>
6
+ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
7
+ // TypeScript Version: 2.8
8
+
9
+ // IMPORTANT
10
+ // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
11
+ // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
12
+ // Generated from: https://cloudtasks.googleapis.com/$discovery/rest?version=v2
13
+ // Revision: 20220813
14
+
15
+ /// <reference types="gapi.client" />
16
+
17
+ declare namespace gapi.client {
18
+ /** Load Cloud Tasks API v2 */
19
+ function load(urlOrObject: "https://cloudtasks.googleapis.com/$discovery/rest?version=v2"): Promise<void>;
20
+ /** @deprecated Please load APIs with discovery documents. */
21
+ function load(name: "cloudtasks", version: "v2"): Promise<void>;
22
+ /** @deprecated Please load APIs with discovery documents. */
23
+ function load(name: "cloudtasks", version: "v2", callback: () => any): void;
24
+
25
+ namespace cloudtasks {
26
+ interface AppEngineHttpRequest {
27
+ /**
28
+ * Task-level setting for App Engine routing. * If app_engine_routing_override is set on the queue, this value is used for all tasks in the queue, no matter what the setting is for the
29
+ * task-level app_engine_routing.
30
+ */
31
+ appEngineRouting?: AppEngineRouting;
32
+ /** HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It is an error to set a body on a task with an incompatible HttpMethod. */
33
+ body?: string;
34
+ /**
35
+ * HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. Repeated headers are not supported but a header value can
36
+ * 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
37
+ * can be modified, but Cloud Tasks will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. If the task has a body, Cloud Tasks sets the
38
+ * following headers: * `Content-Type`: By default, the `Content-Type` header is set to `"application/octet-stream"`. The default can be overridden by explicitly setting `Content-Type`
39
+ * to a particular media type when the task is created. For example, `Content-Type` can be set to `"application/json"`. * `Content-Length`: This is computed by Cloud Tasks. This value
40
+ * is output only. It cannot be changed. The headers below cannot be set or overridden: * `Host` * `X-Google-*` * `X-AppEngine-*` In addition, Cloud Tasks sets some headers when the
41
+ * task is dispatched, such as headers containing information about the task; see [request
42
+ * headers](https://cloud.google.com/tasks/docs/creating-appengine-handlers#reading_request_headers). These headers are set only when the task is dispatched, so they are not visible
43
+ * when the task is returned in a Cloud Tasks response. Although there is no specific limit for the maximum number of headers or the size, there is a limit on the maximum size of the
44
+ * Task. For more information, see the CreateTask documentation.
45
+ */
46
+ headers?: { [P in string]: string };
47
+ /**
48
+ * 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,
49
+ * otherwise the task attempt fails with error code 405 (Method Not Allowed). See [Writing a push task request
50
+ * handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler) and the App Engine documentation for your runtime on [How
51
+ * Requests are Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled).
52
+ */
53
+ httpMethod?: string;
54
+ /**
55
+ * The relative URI. The relative URI must begin with "/" and must be a valid HTTP relative URI. It can contain a path and query string arguments. If the relative URI is empty, then
56
+ * the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
57
+ */
58
+ relativeUri?: string;
59
+ }
60
+ interface AppEngineRouting {
61
+ /**
62
+ * Output only. The host that the task is sent to. The host is constructed from the domain name of the app associated with the queue's project ID (for example .appspot.com), and the
63
+ * service, version, and instance. Tasks which were created using the App Engine SDK might have a custom domain name. For more information, see [How Requests are
64
+ * Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
65
+ */
66
+ host?: string;
67
+ /**
68
+ * 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
69
+ * in App Engine Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). App Engine Flex does not support
70
+ * instances. For more information, see [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and [App Engine Flex
71
+ * request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
72
+ */
73
+ instance?: string;
74
+ /**
75
+ * App service. By default, the task is sent to the service which is the default service when the task is attempted. For some queues or tasks which were created using the App Engine
76
+ * Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom
77
+ * domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
78
+ */
79
+ service?: string;
80
+ /**
81
+ * App version. By default, the task is sent to the version which is the default version when the task is attempted. For some queues or tasks which were created using the App Engine
82
+ * Task Queue API, host is not parsable into service, version, and instance. For example, some tasks which were created using the App Engine SDK use a custom domain name; custom
83
+ * domains are not parsed by Cloud Tasks. If host is not parsable, then service, version, and instance are the empty string.
84
+ */
85
+ version?: string;
86
+ }
87
+ interface Attempt {
88
+ /** Output only. The time that this attempt was dispatched. `dispatch_time` will be truncated to the nearest microsecond. */
89
+ dispatchTime?: string;
90
+ /**
91
+ * Output only. The response from the worker for this attempt. If `response_time` is unset, then the task has not been attempted or is currently running and the `response_status` field
92
+ * is meaningless.
93
+ */
94
+ responseStatus?: Status;
95
+ /** Output only. The time that this attempt response was received. `response_time` will be truncated to the nearest microsecond. */
96
+ responseTime?: string;
97
+ /** Output only. The time that this attempt was scheduled. `schedule_time` will be truncated to the nearest microsecond. */
98
+ scheduleTime?: string;
99
+ }
100
+ interface Binding {
101
+ /**
102
+ * The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`,
103
+ * then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which
104
+ * resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
105
+ */
106
+ condition?: Expr;
107
+ /**
108
+ * Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on
109
+ * 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
110
+ * account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that
111
+ * represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier
112
+ * for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example,
113
+ * `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. *
114
+ * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example,
115
+ * `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. *
116
+ * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example,
117
+ * `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service
118
+ * account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently
119
+ * deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in
120
+ * the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
121
+ */
122
+ members?: string[];
123
+ /** Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */
124
+ role?: string;
125
+ }
126
+ interface CreateTaskRequest {
127
+ /**
128
+ * The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as
129
+ * 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 FULL requires
130
+ * `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource.
131
+ */
132
+ responseView?: string;
133
+ /**
134
+ * 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 task
135
+ * name. If a name is not specified then the system will generate a random unique task id, which will be set in the task returned in the response. If schedule_time is not set or is in
136
+ * 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
137
+ * an existing task or a task that was deleted or executed recently then the call will fail with ALREADY_EXISTS. If the task's queue was created using Cloud Tasks, then another task
138
+ * with the same name can't be created for ~1hour after the original task was deleted or executed. If the task's queue was created using queue.yaml or queue.xml, then another task with
139
+ * the same name can't be created for ~9days after the original task was deleted or executed. Because there is an extra lookup cost to identify duplicate task names, these CreateTask
140
+ * 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
141
+ * 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
142
+ * distribution of task ids to store and serve tasks efficiently.
143
+ */
144
+ task?: Task;
145
+ }
146
+ // tslint:disable-next-line:no-empty-interface
147
+ interface Empty {
148
+ }
149
+ interface Expr {
150
+ /** Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */
151
+ description?: string;
152
+ /** Textual representation of an expression in Common Expression Language syntax. */
153
+ expression?: string;
154
+ /** Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */
155
+ location?: string;
156
+ /** Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */
157
+ title?: string;
158
+ }
159
+ interface GetIamPolicyRequest {
160
+ /** OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. */
161
+ options?: GetPolicyOptions;
162
+ }
163
+ interface GetPolicyOptions {
164
+ /**
165
+ * Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for
166
+ * policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in
167
+ * the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role
168
+ * bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM
169
+ * documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
170
+ */
171
+ requestedPolicyVersion?: number;
172
+ }
173
+ interface HttpRequest {
174
+ /** HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod. */
175
+ body?: string;
176
+ /**
177
+ * HTTP request headers. This map contains the header field names and values. Headers can be set when the task is created. These headers represent a subset of the headers that will
178
+ * accompany the task's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is: * Host: This will be
179
+ * computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. *
180
+ * `X-Google-*`: Google use only. * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is
181
+ * created. For example, `Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. Headers which can have multiple values (according to RFC2616) can be
182
+ * specified using comma-separated values. The size of the headers must be less than 80KB.
183
+ */
184
+ headers?: { [P in string]: string };
185
+ /** The HTTP method to use for the request. The default is POST. */
186
+ httpMethod?: string;
187
+ /**
188
+ * If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of
189
+ * authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.
190
+ */
191
+ oauthToken?: OAuthToken;
192
+ /**
193
+ * If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This
194
+ * type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.
195
+ */
196
+ oidcToken?: OidcToken;
197
+ /**
198
+ * Required. The full url path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples are: `http://acme.com` and
199
+ * `https://acme.com/sales:8080`. Cloud Tasks will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters after encoding. The `Location`
200
+ * header response from a redirect response [`300` - `399`] may be followed. The redirect is not counted as a separate attempt.
201
+ */
202
+ url?: string;
203
+ }
204
+ interface ListLocationsResponse {
205
+ /** A list of locations that matches the specified filter in the request. */
206
+ locations?: Location[];
207
+ /** The standard List next-page token. */
208
+ nextPageToken?: string;
209
+ }
210
+ interface ListQueuesResponse {
211
+ /**
212
+ * A token to retrieve next page of results. To return the next page of results, call ListQueues with this value as the page_token. If the next_page_token is empty, there are no more
213
+ * results. The page token is valid for only 2 hours.
214
+ */
215
+ nextPageToken?: string;
216
+ /** The list of queues. */
217
+ queues?: Queue[];
218
+ }
219
+ interface ListTasksResponse {
220
+ /**
221
+ * A token to retrieve next page of results. To return the next page of results, call ListTasks with this value as the page_token. If the next_page_token is empty, there are no more
222
+ * results.
223
+ */
224
+ nextPageToken?: string;
225
+ /** The list of tasks. */
226
+ tasks?: Task[];
227
+ }
228
+ interface Location {
229
+ /** The friendly name for this location, typically a nearby city name. For example, "Tokyo". */
230
+ displayName?: string;
231
+ /** Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */
232
+ labels?: { [P in string]: string };
233
+ /** The canonical id for this location. For example: `"us-east1"`. */
234
+ locationId?: string;
235
+ /** Service-specific metadata. For example the available capacity at the given location. */
236
+ metadata?: { [P in string]: any };
237
+ /** Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` */
238
+ name?: string;
239
+ }
240
+ interface OAuthToken {
241
+ /** OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. */
242
+ scope?: string;
243
+ /**
244
+ * [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the queue.
245
+ * The caller must have iam.serviceAccounts.actAs permission for the service account.
246
+ */
247
+ serviceAccountEmail?: string;
248
+ }
249
+ interface OidcToken {
250
+ /** Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. */
251
+ audience?: string;
252
+ /**
253
+ * [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the queue.
254
+ * The caller must have iam.serviceAccounts.actAs permission for the service account.
255
+ */
256
+ serviceAccountEmail?: string;
257
+ }
258
+ // tslint:disable-next-line:no-empty-interface
259
+ interface PauseQueueRequest {
260
+ }
261
+ interface Policy {
262
+ /**
263
+ * Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings`
264
+ * must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a
265
+ * principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another
266
+ * 1,450 principals to the `bindings` in the `Policy`.
267
+ */
268
+ bindings?: Binding[];
269
+ /**
270
+ * `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
271
+ * 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
272
+ * 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. **Important:** If you use IAM
273
+ * Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1`
274
+ * policy, and all of the conditions in the version `3` policy are lost.
275
+ */
276
+ etag?: string;
277
+ /**
278
+ * Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings
279
+ * must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a
280
+ * policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use
281
+ * IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1`
282
+ * policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave
283
+ * the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
284
+ */
285
+ version?: number;
286
+ }
287
+ // tslint:disable-next-line:no-empty-interface
288
+ interface PurgeQueueRequest {
289
+ }
290
+ interface Queue {
291
+ /**
292
+ * Overrides for task-level app_engine_routing. These settings apply only to App Engine tasks in this queue. Http tasks are not affected. If set, `app_engine_routing_override` is used
293
+ * for all App Engine tasks in the queue, no matter what the setting is for the task-level app_engine_routing.
294
+ */
295
+ appEngineRoutingOverride?: AppEngineRouting;
296
+ /**
297
+ * Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format:
298
+ * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more
299
+ * information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the
300
+ * queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can
301
+ * contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters.
302
+ */
303
+ name?: string;
304
+ /**
305
+ * 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 PurgeQueue, the [App Engine Task Queue SDK,
306
+ * or the Cloud Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). Purge time will be truncated
307
+ * to the nearest microsecond. Purge time will be unset if the queue has never been purged.
308
+ */
309
+ purgeTime?: string;
310
+ /**
311
+ * Rate limits for task dispatches. rate_limits and retry_config are related because they both control task attempts. However they control task attempts in different ways: *
312
+ * 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). *
313
+ * retry_config controls what happens to particular a task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The
314
+ * queue's actual dispatch rate is the result of: * Number of tasks in the queue * User-specified throttling: rate_limits, retry_config, and the queue's state. * System throttling due
315
+ * to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes.
316
+ */
317
+ rateLimits?: RateLimits;
318
+ /**
319
+ * 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
320
+ * 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
321
+ * have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine
322
+ * documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks).
323
+ */
324
+ retryConfig?: RetryConfig;
325
+ /** Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written. */
326
+ stackdriverLoggingConfig?: StackdriverLoggingConfig;
327
+ /**
328
+ * Output only. The state of the queue. `state` can only be changed by calling PauseQueue, ResumeQueue, or uploading
329
+ * [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`.
330
+ */
331
+ state?: string;
332
+ }
333
+ interface RateLimits {
334
+ /**
335
+ * Output only. The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to
336
+ * 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. The [token
337
+ * bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is used to control the rate of task dispatches. Each queue has a token bucket that holds tokens, up to the maximum
338
+ * specified by `max_burst_size`. Each time a task is dispatched, a token is removed from the bucket. Tasks will be dispatched until the queue's bucket runs out of tokens. The bucket
339
+ * will be continuously refilled with new tokens based on max_dispatches_per_second. Cloud Tasks will pick the value of `max_burst_size` based on the value of
340
+ * max_dispatches_per_second. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to
341
+ * [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). Since `max_burst_size` is output only, if UpdateQueue is called on a queue
342
+ * created by `queue.yaml/xml`, `max_burst_size` will be reset based on the value of max_dispatches_per_second, regardless of whether max_dispatches_per_second is updated.
343
+ */
344
+ maxBurstSize?: number;
345
+ /**
346
+ * 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
347
+ * number of concurrent requests decreases. If unspecified when the queue is created, Cloud Tasks will pick the default. The maximum allowed value is 5,000. This field has the same
348
+ * meaning as [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests).
349
+ */
350
+ maxConcurrentDispatches?: number;
351
+ /**
352
+ * The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default. * The maximum allowed value is 500. This
353
+ * field has the same meaning as [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate).
354
+ */
355
+ maxDispatchesPerSecond?: number;
356
+ }
357
+ // tslint:disable-next-line:no-empty-interface
358
+ interface ResumeQueueRequest {
359
+ }
360
+ interface RetryConfig {
361
+ /**
362
+ * Number of attempts per 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 >=
363
+ * -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts. This field has the same meaning as [task_retry_limit in
364
+ * queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
365
+ */
366
+ maxAttempts?: number;
367
+ /**
368
+ * A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified
369
+ * when the queue is created, Cloud Tasks will pick the default. `max_backoff` will be truncated to the nearest second. This field has the same meaning as [max_backoff_seconds in
370
+ * queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
371
+ */
372
+ maxBackoff?: string;
373
+ /**
374
+ * The time between retries will double `max_doublings` times. A task's retry interval starts at min_backoff, then doubles `max_doublings` times, then increases linearly, and finally
375
+ * retries at intervals of max_backoff up to max_attempts times. For example, if min_backoff is 10s, max_backoff is 300s, and `max_doublings` is 3, then the a task will first be
376
+ * retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the task will retry at intervals of max_backoff until the task has been
377
+ * attempted max_attempts times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... If unspecified when the queue is created, Cloud Tasks will pick the
378
+ * default. This field has the same meaning as [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
379
+ */
380
+ maxDoublings?: number;
381
+ /**
382
+ * 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
383
+ * *and* the task has been attempted max_attempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited. If unspecified when the
384
+ * queue is created, Cloud Tasks will pick the default. `max_retry_duration` will be truncated to the nearest second. This field has the same meaning as [task_age_limit in
385
+ * queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
386
+ */
387
+ maxRetryDuration?: string;
388
+ /**
389
+ * A task will be scheduled for retry between min_backoff and max_backoff duration after it fails, if the queue's RetryConfig specifies that the task should be retried. If unspecified
390
+ * when the queue is created, Cloud Tasks will pick the default. `min_backoff` will be truncated to the nearest second. This field has the same meaning as [min_backoff_seconds in
391
+ * queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters).
392
+ */
393
+ minBackoff?: string;
394
+ }
395
+ interface RunTaskRequest {
396
+ /**
397
+ * The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as
398
+ * 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 FULL requires
399
+ * `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource.
400
+ */
401
+ responseView?: string;
402
+ }
403
+ interface SetIamPolicyRequest {
404
+ /**
405
+ * 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 Google Cloud
406
+ * services (such as Projects) might reject them.
407
+ */
408
+ policy?: Policy;
409
+ }
410
+ interface StackdriverLoggingConfig {
411
+ /**
412
+ * Specifies the fraction of operations to write to [Stackdriver Logging](https://cloud.google.com/logging/docs/). This field may contain any value between 0.0 and 1.0, inclusive. 0.0
413
+ * is the default and means that no operations are logged.
414
+ */
415
+ samplingRatio?: number;
416
+ }
417
+ interface Status {
418
+ /** The status code, which should be an enum value of google.rpc.Code. */
419
+ code?: number;
420
+ /** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
421
+ details?: Array<{ [P in string]: any }>;
422
+ /**
423
+ * 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
424
+ * client.
425
+ */
426
+ message?: string;
427
+ }
428
+ interface Task {
429
+ /** HTTP request that is sent to the App Engine app handler. An App Engine task is a task that has AppEngineHttpRequest set. */
430
+ appEngineHttpRequest?: AppEngineHttpRequest;
431
+ /** Output only. The time that the task was created. `create_time` will be truncated to the nearest second. */
432
+ createTime?: string;
433
+ /** Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response. */
434
+ dispatchCount?: number;
435
+ /**
436
+ * The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a `DEADLINE_EXCEEDED`
437
+ * failure. Cloud Tasks will retry the task according to the RetryConfig. Note that when the request is cancelled, Cloud Tasks will stop listening for the response, but whether the
438
+ * worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests. The default and maximum values depend on the type of
439
+ * request: * For HTTP tasks, the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes]. * For App Engine tasks, 0 indicates that the request has the
440
+ * default deadline. The default deadline depends on the [scaling type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling) of the service:
441
+ * 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must
442
+ * be in the interval [15 seconds, 24 hours 15 seconds]. Regardless of the task's `dispatch_deadline`, the app handler will not run for longer than than the service's timeout. We
443
+ * recommend setting the `dispatch_deadline` to at most a few seconds more than the app handler's timeout. For more information see
444
+ * [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts). `dispatch_deadline` will be truncated to the nearest millisecond. The deadline is an
445
+ * approximate deadline.
446
+ */
447
+ dispatchDeadline?: string;
448
+ /** Output only. The status of the task's first attempt. Only dispatch_time will be set. The other Attempt information is not retained by Cloud Tasks. */
449
+ firstAttempt?: Attempt;
450
+ /** HTTP request that is sent to the worker. An HTTP task is a task that has HttpRequest set. */
451
+ httpRequest?: HttpRequest;
452
+ /** Output only. The status of the task's last attempt. */
453
+ lastAttempt?: Attempt;
454
+ /**
455
+ * Optionally caller-specified in CreateTask. The task name. The task name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` *
456
+ * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying
457
+ * projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the task's location. The list of
458
+ * available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]),
459
+ * numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum
460
+ * length is 500 characters.
461
+ */
462
+ name?: string;
463
+ /** Output only. The number of attempts which have received a response. */
464
+ responseCount?: number;
465
+ /** The time when the task is scheduled to be attempted or retried. `schedule_time` will be truncated to the nearest microsecond. */
466
+ scheduleTime?: string;
467
+ /** Output only. The view specifies which subset of the Task has been returned. */
468
+ view?: string;
469
+ }
470
+ interface TestIamPermissionsRequest {
471
+ /**
472
+ * The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM
473
+ * Overview](https://cloud.google.com/iam/docs/overview#permissions).
474
+ */
475
+ permissions?: string[];
476
+ }
477
+ interface TestIamPermissionsResponse {
478
+ /** A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */
479
+ permissions?: string[];
480
+ }
481
+ interface TasksResource {
482
+ /** Creates a task and adds it to a queue. Tasks cannot be updated after creation; there is no UpdateTask command. * The maximum task size is 100KB. */
483
+ create(request: {
484
+ /** V1 error format. */
485
+ "$.xgafv"?: string;
486
+ /** OAuth access token. */
487
+ access_token?: string;
488
+ /** Data format for response. */
489
+ alt?: string;
490
+ /** JSONP */
491
+ callback?: string;
492
+ /** Selector specifying which fields to include in a partial response. */
493
+ fields?: string;
494
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
495
+ key?: string;
496
+ /** OAuth 2.0 token for the current user. */
497
+ oauth_token?: string;
498
+ /** Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue must already exist. */
499
+ parent: string;
500
+ /** Returns response with indentations and line breaks. */
501
+ prettyPrint?: boolean;
502
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
503
+ quotaUser?: string;
504
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
505
+ upload_protocol?: string;
506
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
507
+ uploadType?: string;
508
+ /** Request body */
509
+ resource: CreateTaskRequest;
510
+ }): Request<Task>;
511
+ create(request: {
512
+ /** V1 error format. */
513
+ "$.xgafv"?: string;
514
+ /** OAuth access token. */
515
+ access_token?: string;
516
+ /** Data format for response. */
517
+ alt?: string;
518
+ /** JSONP */
519
+ callback?: string;
520
+ /** Selector specifying which fields to include in a partial response. */
521
+ fields?: string;
522
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
523
+ key?: string;
524
+ /** OAuth 2.0 token for the current user. */
525
+ oauth_token?: string;
526
+ /** Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue must already exist. */
527
+ parent: string;
528
+ /** Returns response with indentations and line breaks. */
529
+ prettyPrint?: boolean;
530
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
531
+ quotaUser?: string;
532
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
533
+ upload_protocol?: string;
534
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
535
+ uploadType?: string;
536
+ },
537
+ body: CreateTaskRequest): Request<Task>;
538
+ /** Deletes a task. A task can be deleted if it is scheduled or dispatched. A task cannot be deleted if it has executed successfully or permanently failed. */
539
+ delete(request?: {
540
+ /** V1 error format. */
541
+ "$.xgafv"?: string;
542
+ /** OAuth access token. */
543
+ access_token?: string;
544
+ /** Data format for response. */
545
+ alt?: string;
546
+ /** JSONP */
547
+ callback?: string;
548
+ /** Selector specifying which fields to include in a partial response. */
549
+ fields?: string;
550
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
551
+ key?: string;
552
+ /** Required. The task name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` */
553
+ name: string;
554
+ /** OAuth 2.0 token for the current user. */
555
+ oauth_token?: string;
556
+ /** Returns response with indentations and line breaks. */
557
+ prettyPrint?: boolean;
558
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
559
+ quotaUser?: string;
560
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
561
+ upload_protocol?: string;
562
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
563
+ uploadType?: string;
564
+ }): Request<{}>;
565
+ /** Gets a task. */
566
+ get(request?: {
567
+ /** V1 error format. */
568
+ "$.xgafv"?: string;
569
+ /** OAuth access token. */
570
+ access_token?: string;
571
+ /** Data format for response. */
572
+ alt?: string;
573
+ /** JSONP */
574
+ callback?: string;
575
+ /** Selector specifying which fields to include in a partial response. */
576
+ fields?: string;
577
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
578
+ key?: string;
579
+ /** Required. The task name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` */
580
+ name: string;
581
+ /** OAuth 2.0 token for the current user. */
582
+ oauth_token?: string;
583
+ /** Returns response with indentations and line breaks. */
584
+ prettyPrint?: boolean;
585
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
586
+ quotaUser?: string;
587
+ /**
588
+ * The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as
589
+ * 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 FULL requires
590
+ * `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource.
591
+ */
592
+ responseView?: string;
593
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
594
+ upload_protocol?: string;
595
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
596
+ uploadType?: string;
597
+ }): Request<Task>;
598
+ /**
599
+ * Lists the tasks in a queue. By default, only the BASIC view is retrieved due to performance considerations; response_view controls the subset of information which is returned. The
600
+ * tasks may be returned in any order. The ordering may change at any time.
601
+ */
602
+ list(request?: {
603
+ /** V1 error format. */
604
+ "$.xgafv"?: string;
605
+ /** OAuth access token. */
606
+ access_token?: string;
607
+ /** Data format for response. */
608
+ alt?: string;
609
+ /** JSONP */
610
+ callback?: string;
611
+ /** Selector specifying which fields to include in a partial response. */
612
+ fields?: string;
613
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
614
+ key?: string;
615
+ /** OAuth 2.0 token for the current user. */
616
+ oauth_token?: string;
617
+ /**
618
+ * Maximum page size. Fewer tasks than requested might be returned, even if more tasks exist; use next_page_token in the response to determine if more tasks exist. The maximum page
619
+ * size is 1000. If unspecified, the page size will be the maximum.
620
+ */
621
+ pageSize?: number;
622
+ /**
623
+ * 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
624
+ * of next_page_token returned from the previous call to ListTasks method. The page token is valid for only 2 hours.
625
+ */
626
+ pageToken?: string;
627
+ /** Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` */
628
+ parent: string;
629
+ /** Returns response with indentations and line breaks. */
630
+ prettyPrint?: boolean;
631
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
632
+ quotaUser?: string;
633
+ /**
634
+ * The response_view specifies which subset of the Task will be returned. By default response_view is BASIC; not all information is retrieved by default because some data, such as
635
+ * 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 FULL requires
636
+ * `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource.
637
+ */
638
+ responseView?: string;
639
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
640
+ upload_protocol?: string;
641
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
642
+ uploadType?: string;
643
+ }): Request<ListTasksResponse>;
644
+ /**
645
+ * Forces a task to run now. When this method is called, Cloud Tasks will dispatch the task, even if the task is already running, the queue has reached its RateLimits or is PAUSED.
646
+ * This command is meant to be used for manual debugging. For example, RunTask can be used to retry a failed task after a fix has been made or to manually force a task to be dispatched
647
+ * now. The dispatched task is returned. That is, the task that is returned contains the status after the task is dispatched but before the task is received by its target. If Cloud
648
+ * Tasks receives a successful response from the task's target, then the task will be deleted; otherwise the task's schedule_time will be reset to the time that RunTask was called plus
649
+ * the retry delay specified in the queue's RetryConfig. RunTask returns NOT_FOUND when it is called on a task that has already succeeded or permanently failed.
650
+ */
651
+ run(request: {
652
+ /** V1 error format. */
653
+ "$.xgafv"?: string;
654
+ /** OAuth access token. */
655
+ access_token?: string;
656
+ /** Data format for response. */
657
+ alt?: string;
658
+ /** JSONP */
659
+ callback?: string;
660
+ /** Selector specifying which fields to include in a partial response. */
661
+ fields?: string;
662
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
663
+ key?: string;
664
+ /** Required. The task name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` */
665
+ name: string;
666
+ /** OAuth 2.0 token for the current user. */
667
+ oauth_token?: string;
668
+ /** Returns response with indentations and line breaks. */
669
+ prettyPrint?: boolean;
670
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
671
+ quotaUser?: string;
672
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
673
+ upload_protocol?: string;
674
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
675
+ uploadType?: string;
676
+ /** Request body */
677
+ resource: RunTaskRequest;
678
+ }): Request<Task>;
679
+ run(request: {
680
+ /** V1 error format. */
681
+ "$.xgafv"?: string;
682
+ /** OAuth access token. */
683
+ access_token?: string;
684
+ /** Data format for response. */
685
+ alt?: string;
686
+ /** JSONP */
687
+ callback?: string;
688
+ /** Selector specifying which fields to include in a partial response. */
689
+ fields?: string;
690
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
691
+ key?: string;
692
+ /** Required. The task name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` */
693
+ name: string;
694
+ /** OAuth 2.0 token for the current user. */
695
+ oauth_token?: string;
696
+ /** Returns response with indentations and line breaks. */
697
+ prettyPrint?: boolean;
698
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
699
+ quotaUser?: string;
700
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
701
+ upload_protocol?: string;
702
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
703
+ uploadType?: string;
704
+ },
705
+ body: RunTaskRequest): Request<Task>;
706
+ }
707
+ interface QueuesResource {
708
+ /**
709
+ * Creates a queue. Queues created with this method allow tasks to live for a maximum of 31 days. After a task is 31 days old, the task will be deleted regardless of whether it was
710
+ * dispatched or not. WARNING: Using this method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview
711
+ * of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this method.
712
+ */
713
+ create(request: {
714
+ /** V1 error format. */
715
+ "$.xgafv"?: string;
716
+ /** OAuth access token. */
717
+ access_token?: string;
718
+ /** Data format for response. */
719
+ alt?: string;
720
+ /** JSONP */
721
+ callback?: string;
722
+ /** Selector specifying which fields to include in a partial response. */
723
+ fields?: string;
724
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
725
+ key?: string;
726
+ /** OAuth 2.0 token for the current user. */
727
+ oauth_token?: string;
728
+ /**
729
+ * 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
730
+ * Cloud Tasks' implementation of ListLocations.
731
+ */
732
+ parent: string;
733
+ /** Returns response with indentations and line breaks. */
734
+ prettyPrint?: boolean;
735
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
736
+ quotaUser?: string;
737
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
738
+ upload_protocol?: string;
739
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
740
+ uploadType?: string;
741
+ /** Request body */
742
+ resource: Queue;
743
+ }): Request<Queue>;
744
+ create(request: {
745
+ /** V1 error format. */
746
+ "$.xgafv"?: string;
747
+ /** OAuth access token. */
748
+ access_token?: string;
749
+ /** Data format for response. */
750
+ alt?: string;
751
+ /** JSONP */
752
+ callback?: string;
753
+ /** Selector specifying which fields to include in a partial response. */
754
+ fields?: string;
755
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
756
+ key?: string;
757
+ /** OAuth 2.0 token for the current user. */
758
+ oauth_token?: string;
759
+ /**
760
+ * 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
761
+ * Cloud Tasks' implementation of ListLocations.
762
+ */
763
+ parent: string;
764
+ /** Returns response with indentations and line breaks. */
765
+ prettyPrint?: boolean;
766
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
767
+ quotaUser?: string;
768
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
769
+ upload_protocol?: string;
770
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
771
+ uploadType?: string;
772
+ },
773
+ body: Queue): Request<Queue>;
774
+ /**
775
+ * Deletes a queue. This command will delete the queue even if it has tasks in it. Note: If you delete a queue, a queue with the same name can't be created for 7 days. WARNING: Using
776
+ * this method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and
777
+ * queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this method.
778
+ */
779
+ delete(request?: {
780
+ /** V1 error format. */
781
+ "$.xgafv"?: string;
782
+ /** OAuth access token. */
783
+ access_token?: string;
784
+ /** Data format for response. */
785
+ alt?: string;
786
+ /** JSONP */
787
+ callback?: string;
788
+ /** Selector specifying which fields to include in a partial response. */
789
+ fields?: string;
790
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
791
+ key?: string;
792
+ /** Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` */
793
+ name: string;
794
+ /** OAuth 2.0 token for the current user. */
795
+ oauth_token?: string;
796
+ /** Returns response with indentations and line breaks. */
797
+ prettyPrint?: boolean;
798
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
799
+ quotaUser?: string;
800
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
801
+ upload_protocol?: string;
802
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
803
+ uploadType?: string;
804
+ }): Request<{}>;
805
+ /** Gets a queue. */
806
+ get(request?: {
807
+ /** V1 error format. */
808
+ "$.xgafv"?: string;
809
+ /** OAuth access token. */
810
+ access_token?: string;
811
+ /** Data format for response. */
812
+ alt?: string;
813
+ /** JSONP */
814
+ callback?: string;
815
+ /** Selector specifying which fields to include in a partial response. */
816
+ fields?: string;
817
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
818
+ key?: string;
819
+ /** Required. The resource name of the queue. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` */
820
+ name: string;
821
+ /** OAuth 2.0 token for the current user. */
822
+ oauth_token?: string;
823
+ /** Returns response with indentations and line breaks. */
824
+ prettyPrint?: boolean;
825
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
826
+ quotaUser?: string;
827
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
828
+ upload_protocol?: string;
829
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
830
+ uploadType?: string;
831
+ }): Request<Queue>;
832
+ /**
833
+ * 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
834
+ * IAM](https://cloud.google.com/iam) permission on the specified resource parent: * `cloudtasks.queues.getIamPolicy`
835
+ */
836
+ getIamPolicy(request: {
837
+ /** V1 error format. */
838
+ "$.xgafv"?: string;
839
+ /** OAuth access token. */
840
+ access_token?: string;
841
+ /** Data format for response. */
842
+ alt?: string;
843
+ /** JSONP */
844
+ callback?: string;
845
+ /** Selector specifying which fields to include in a partial response. */
846
+ fields?: string;
847
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
848
+ key?: string;
849
+ /** OAuth 2.0 token for the current user. */
850
+ oauth_token?: string;
851
+ /** Returns response with indentations and line breaks. */
852
+ prettyPrint?: boolean;
853
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
854
+ quotaUser?: string;
855
+ /**
856
+ * REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this
857
+ * field.
858
+ */
859
+ resource: string;
860
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
861
+ upload_protocol?: string;
862
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
863
+ uploadType?: string;
864
+ },
865
+ body: GetIamPolicyRequest): Request<Policy>;
866
+ /** Lists queues. Queues are returned in lexicographical order. */
867
+ list(request?: {
868
+ /** V1 error format. */
869
+ "$.xgafv"?: string;
870
+ /** OAuth access token. */
871
+ access_token?: string;
872
+ /** Data format for response. */
873
+ alt?: string;
874
+ /** JSONP */
875
+ callback?: string;
876
+ /** Selector specifying which fields to include in a partial response. */
877
+ fields?: string;
878
+ /**
879
+ * `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
880
+ * syntax is the same as described in [Stackdriver's Advanced Logs Filters](https://cloud.google.com/logging/docs/view/advanced_filters). Sample filter "state: PAUSED". Note that
881
+ * using filters might cause fewer queues than the requested page_size to be returned.
882
+ */
883
+ filter?: string;
884
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
885
+ key?: string;
886
+ /** OAuth 2.0 token for the current user. */
887
+ oauth_token?: string;
888
+ /**
889
+ * 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;
890
+ * use the next_page_token in the response to determine if more queues exist.
891
+ */
892
+ pageSize?: number;
893
+ /**
894
+ * 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
895
+ * of next_page_token returned from the previous call to ListQueues method. It is an error to switch the value of the filter while iterating through pages.
896
+ */
897
+ pageToken?: string;
898
+ /** Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID` */
899
+ parent: string;
900
+ /** Returns response with indentations and line breaks. */
901
+ prettyPrint?: boolean;
902
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
903
+ quotaUser?: string;
904
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
905
+ upload_protocol?: string;
906
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
907
+ uploadType?: string;
908
+ }): Request<ListQueuesResponse>;
909
+ /**
910
+ * Updates a queue. This method creates the queue if it does not exist and updates the queue if it does exist. Queues created with this method allow tasks to live for a maximum of 31
911
+ * days. After a task is 31 days old, the task will be deleted regardless of whether it was dispatched or not. WARNING: Using this method may have unintended side effects if you are
912
+ * using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before
913
+ * using this method.
914
+ */
915
+ patch(request: {
916
+ /** V1 error format. */
917
+ "$.xgafv"?: string;
918
+ /** OAuth access token. */
919
+ access_token?: string;
920
+ /** Data format for response. */
921
+ alt?: string;
922
+ /** JSONP */
923
+ callback?: string;
924
+ /** Selector specifying which fields to include in a partial response. */
925
+ fields?: string;
926
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
927
+ key?: string;
928
+ /**
929
+ * Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format:
930
+ * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more
931
+ * information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for
932
+ * the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID`
933
+ * can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters.
934
+ */
935
+ name: string;
936
+ /** OAuth 2.0 token for the current user. */
937
+ oauth_token?: string;
938
+ /** Returns response with indentations and line breaks. */
939
+ prettyPrint?: boolean;
940
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
941
+ quotaUser?: string;
942
+ /** A mask used to specify which fields of the queue are being updated. If empty, then all fields will be updated. */
943
+ updateMask?: string;
944
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
945
+ upload_protocol?: string;
946
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
947
+ uploadType?: string;
948
+ /** Request body */
949
+ resource: Queue;
950
+ }): Request<Queue>;
951
+ patch(request: {
952
+ /** V1 error format. */
953
+ "$.xgafv"?: string;
954
+ /** OAuth access token. */
955
+ access_token?: string;
956
+ /** Data format for response. */
957
+ alt?: string;
958
+ /** JSONP */
959
+ callback?: string;
960
+ /** Selector specifying which fields to include in a partial response. */
961
+ fields?: string;
962
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
963
+ key?: string;
964
+ /**
965
+ * Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format:
966
+ * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more
967
+ * information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for
968
+ * the queue's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID`
969
+ * can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters.
970
+ */
971
+ name: string;
972
+ /** OAuth 2.0 token for the current user. */
973
+ oauth_token?: string;
974
+ /** Returns response with indentations and line breaks. */
975
+ prettyPrint?: boolean;
976
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
977
+ quotaUser?: string;
978
+ /** A mask used to specify which fields of the queue are being updated. If empty, then all fields will be updated. */
979
+ updateMask?: string;
980
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
981
+ upload_protocol?: string;
982
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
983
+ uploadType?: string;
984
+ },
985
+ body: Queue): Request<Queue>;
986
+ /**
987
+ * Pauses the queue. If a queue is paused then the system will stop dispatching tasks until the queue is resumed via ResumeQueue. Tasks can still be added when the queue is paused. A
988
+ * queue is paused if its state is PAUSED.
989
+ */
990
+ pause(request: {
991
+ /** V1 error format. */
992
+ "$.xgafv"?: string;
993
+ /** OAuth access token. */
994
+ access_token?: string;
995
+ /** Data format for response. */
996
+ alt?: string;
997
+ /** JSONP */
998
+ callback?: string;
999
+ /** Selector specifying which fields to include in a partial response. */
1000
+ fields?: string;
1001
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1002
+ key?: string;
1003
+ /** Required. The queue name. For example: `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` */
1004
+ name: string;
1005
+ /** OAuth 2.0 token for the current user. */
1006
+ oauth_token?: string;
1007
+ /** Returns response with indentations and line breaks. */
1008
+ prettyPrint?: boolean;
1009
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1010
+ quotaUser?: string;
1011
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1012
+ upload_protocol?: string;
1013
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1014
+ uploadType?: string;
1015
+ /** Request body */
1016
+ resource: PauseQueueRequest;
1017
+ }): Request<Queue>;
1018
+ pause(request: {
1019
+ /** V1 error format. */
1020
+ "$.xgafv"?: string;
1021
+ /** OAuth access token. */
1022
+ access_token?: string;
1023
+ /** Data format for response. */
1024
+ alt?: string;
1025
+ /** JSONP */
1026
+ callback?: string;
1027
+ /** Selector specifying which fields to include in a partial response. */
1028
+ fields?: string;
1029
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1030
+ key?: string;
1031
+ /** Required. The queue name. For example: `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` */
1032
+ name: string;
1033
+ /** OAuth 2.0 token for the current user. */
1034
+ oauth_token?: string;
1035
+ /** Returns response with indentations and line breaks. */
1036
+ prettyPrint?: boolean;
1037
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1038
+ quotaUser?: string;
1039
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1040
+ upload_protocol?: string;
1041
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1042
+ uploadType?: string;
1043
+ },
1044
+ body: PauseQueueRequest): Request<Queue>;
1045
+ /**
1046
+ * 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
1047
+ * might be dispatched before the purge takes effect. A purge is irreversible.
1048
+ */
1049
+ purge(request: {
1050
+ /** V1 error format. */
1051
+ "$.xgafv"?: string;
1052
+ /** OAuth access token. */
1053
+ access_token?: string;
1054
+ /** Data format for response. */
1055
+ alt?: string;
1056
+ /** JSONP */
1057
+ callback?: string;
1058
+ /** Selector specifying which fields to include in a partial response. */
1059
+ fields?: string;
1060
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1061
+ key?: string;
1062
+ /** Required. The queue name. For example: `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` */
1063
+ name: string;
1064
+ /** OAuth 2.0 token for the current user. */
1065
+ oauth_token?: string;
1066
+ /** Returns response with indentations and line breaks. */
1067
+ prettyPrint?: boolean;
1068
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1069
+ quotaUser?: string;
1070
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1071
+ upload_protocol?: string;
1072
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1073
+ uploadType?: string;
1074
+ /** Request body */
1075
+ resource: PurgeQueueRequest;
1076
+ }): Request<Queue>;
1077
+ purge(request: {
1078
+ /** V1 error format. */
1079
+ "$.xgafv"?: string;
1080
+ /** OAuth access token. */
1081
+ access_token?: string;
1082
+ /** Data format for response. */
1083
+ alt?: string;
1084
+ /** JSONP */
1085
+ callback?: string;
1086
+ /** Selector specifying which fields to include in a partial response. */
1087
+ fields?: string;
1088
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1089
+ key?: string;
1090
+ /** Required. The queue name. For example: `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` */
1091
+ name: string;
1092
+ /** OAuth 2.0 token for the current user. */
1093
+ oauth_token?: string;
1094
+ /** Returns response with indentations and line breaks. */
1095
+ prettyPrint?: boolean;
1096
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1097
+ quotaUser?: string;
1098
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1099
+ upload_protocol?: string;
1100
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1101
+ uploadType?: string;
1102
+ },
1103
+ body: PurgeQueueRequest): Request<Queue>;
1104
+ /**
1105
+ * Resume a queue. This method resumes a queue after it has been PAUSED or DISABLED. The state of a queue is stored in the queue's state; after calling this method it will be set to
1106
+ * 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
1107
+ * [Managing Cloud Tasks Scaling Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
1108
+ */
1109
+ resume(request: {
1110
+ /** V1 error format. */
1111
+ "$.xgafv"?: string;
1112
+ /** OAuth access token. */
1113
+ access_token?: string;
1114
+ /** Data format for response. */
1115
+ alt?: string;
1116
+ /** JSONP */
1117
+ callback?: string;
1118
+ /** Selector specifying which fields to include in a partial response. */
1119
+ fields?: string;
1120
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1121
+ key?: string;
1122
+ /** Required. The queue name. For example: `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` */
1123
+ name: string;
1124
+ /** OAuth 2.0 token for the current user. */
1125
+ oauth_token?: string;
1126
+ /** Returns response with indentations and line breaks. */
1127
+ prettyPrint?: boolean;
1128
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1129
+ quotaUser?: string;
1130
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1131
+ upload_protocol?: string;
1132
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1133
+ uploadType?: string;
1134
+ /** Request body */
1135
+ resource: ResumeQueueRequest;
1136
+ }): Request<Queue>;
1137
+ resume(request: {
1138
+ /** V1 error format. */
1139
+ "$.xgafv"?: string;
1140
+ /** OAuth access token. */
1141
+ access_token?: string;
1142
+ /** Data format for response. */
1143
+ alt?: string;
1144
+ /** JSONP */
1145
+ callback?: string;
1146
+ /** Selector specifying which fields to include in a partial response. */
1147
+ fields?: string;
1148
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1149
+ key?: string;
1150
+ /** Required. The queue name. For example: `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID` */
1151
+ name: string;
1152
+ /** OAuth 2.0 token for the current user. */
1153
+ oauth_token?: string;
1154
+ /** Returns response with indentations and line breaks. */
1155
+ prettyPrint?: boolean;
1156
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1157
+ quotaUser?: string;
1158
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1159
+ upload_protocol?: string;
1160
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1161
+ uploadType?: string;
1162
+ },
1163
+ body: ResumeQueueRequest): Request<Queue>;
1164
+ /**
1165
+ * 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
1166
+ * required to use the Cloud Console. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission on the specified resource parent: *
1167
+ * `cloudtasks.queues.setIamPolicy`
1168
+ */
1169
+ setIamPolicy(request: {
1170
+ /** V1 error format. */
1171
+ "$.xgafv"?: string;
1172
+ /** OAuth access token. */
1173
+ access_token?: string;
1174
+ /** Data format for response. */
1175
+ alt?: string;
1176
+ /** JSONP */
1177
+ callback?: string;
1178
+ /** Selector specifying which fields to include in a partial response. */
1179
+ fields?: string;
1180
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1181
+ key?: string;
1182
+ /** OAuth 2.0 token for the current user. */
1183
+ oauth_token?: string;
1184
+ /** Returns response with indentations and line breaks. */
1185
+ prettyPrint?: boolean;
1186
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1187
+ quotaUser?: string;
1188
+ /**
1189
+ * REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this
1190
+ * field.
1191
+ */
1192
+ resource: string;
1193
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1194
+ upload_protocol?: string;
1195
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1196
+ uploadType?: string;
1197
+ },
1198
+ body: SetIamPolicyRequest): Request<Policy>;
1199
+ /**
1200
+ * Returns permissions that a caller has on a Queue. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is
1201
+ * designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
1202
+ */
1203
+ testIamPermissions(request: {
1204
+ /** V1 error format. */
1205
+ "$.xgafv"?: string;
1206
+ /** OAuth access token. */
1207
+ access_token?: string;
1208
+ /** Data format for response. */
1209
+ alt?: string;
1210
+ /** JSONP */
1211
+ callback?: string;
1212
+ /** Selector specifying which fields to include in a partial response. */
1213
+ fields?: string;
1214
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1215
+ key?: string;
1216
+ /** OAuth 2.0 token for the current user. */
1217
+ oauth_token?: string;
1218
+ /** Returns response with indentations and line breaks. */
1219
+ prettyPrint?: boolean;
1220
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1221
+ quotaUser?: string;
1222
+ /**
1223
+ * REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for
1224
+ * this field.
1225
+ */
1226
+ resource: string;
1227
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1228
+ upload_protocol?: string;
1229
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1230
+ uploadType?: string;
1231
+ },
1232
+ body: TestIamPermissionsRequest): Request<TestIamPermissionsResponse>;
1233
+ tasks: TasksResource;
1234
+ }
1235
+ interface LocationsResource {
1236
+ /** Gets information about a location. */
1237
+ get(request?: {
1238
+ /** V1 error format. */
1239
+ "$.xgafv"?: string;
1240
+ /** OAuth access token. */
1241
+ access_token?: string;
1242
+ /** Data format for response. */
1243
+ alt?: string;
1244
+ /** JSONP */
1245
+ callback?: string;
1246
+ /** Selector specifying which fields to include in a partial response. */
1247
+ fields?: string;
1248
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1249
+ key?: string;
1250
+ /** Resource name for the location. */
1251
+ name: string;
1252
+ /** OAuth 2.0 token for the current user. */
1253
+ oauth_token?: string;
1254
+ /** Returns response with indentations and line breaks. */
1255
+ prettyPrint?: boolean;
1256
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1257
+ quotaUser?: string;
1258
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1259
+ upload_protocol?: string;
1260
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1261
+ uploadType?: string;
1262
+ }): Request<Location>;
1263
+ /** Lists information about the supported locations for this service. */
1264
+ list(request?: {
1265
+ /** V1 error format. */
1266
+ "$.xgafv"?: string;
1267
+ /** OAuth access token. */
1268
+ access_token?: string;
1269
+ /** Data format for response. */
1270
+ alt?: string;
1271
+ /** JSONP */
1272
+ callback?: string;
1273
+ /** Selector specifying which fields to include in a partial response. */
1274
+ fields?: string;
1275
+ /**
1276
+ * A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in
1277
+ * [AIP-160](https://google.aip.dev/160).
1278
+ */
1279
+ filter?: string;
1280
+ /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
1281
+ key?: string;
1282
+ /** The resource that owns the locations collection, if applicable. */
1283
+ name: string;
1284
+ /** OAuth 2.0 token for the current user. */
1285
+ oauth_token?: string;
1286
+ /** The maximum number of results to return. If not set, the service selects a default. */
1287
+ pageSize?: number;
1288
+ /** A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. */
1289
+ pageToken?: string;
1290
+ /** Returns response with indentations and line breaks. */
1291
+ prettyPrint?: boolean;
1292
+ /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
1293
+ quotaUser?: string;
1294
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1295
+ upload_protocol?: string;
1296
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1297
+ uploadType?: string;
1298
+ }): Request<ListLocationsResponse>;
1299
+ queues: QueuesResource;
1300
+ }
1301
+ interface ProjectsResource {
1302
+ locations: LocationsResource;
1303
+ }
1304
+
1305
+ const projects: ProjectsResource;
1306
+ }
1307
+ }