@maxim_mazurok/gapi.client.cloudtasks-v2 0.1.20260306 → 0.2.20260306
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.
- package/index.d.ts +98 -71
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -32,7 +32,15 @@ declare namespace gapi.client {
|
|
|
32
32
|
/** 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 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 a body, 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 explicitly setting `Content-Type` 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 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 task is dispatched, such as headers containing information about the task; see [request 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 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 Task. For more information, see the CreateTask documentation. */
|
|
33
33
|
headers?: {[P in string]: string};
|
|
34
34
|
/** 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 fails with error code 405 (Method Not Allowed). See [Writing a push task request 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 Requests are Handled](https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled). */
|
|
35
|
-
httpMethod?:
|
|
35
|
+
httpMethod?:
|
|
36
|
+
| 'HTTP_METHOD_UNSPECIFIED'
|
|
37
|
+
| 'POST'
|
|
38
|
+
| 'GET'
|
|
39
|
+
| 'HEAD'
|
|
40
|
+
| 'PUT'
|
|
41
|
+
| 'DELETE'
|
|
42
|
+
| 'PATCH'
|
|
43
|
+
| 'OPTIONS';
|
|
36
44
|
/** 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 the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters. */
|
|
37
45
|
relativeUri?: string;
|
|
38
46
|
}
|
|
@@ -80,7 +88,7 @@ declare namespace gapi.client {
|
|
|
80
88
|
}
|
|
81
89
|
interface CreateTaskRequest {
|
|
82
90
|
/** 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 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 `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. */
|
|
83
|
-
responseView?:
|
|
91
|
+
responseView?: 'VIEW_UNSPECIFIED' | 'BASIC' | 'FULL';
|
|
84
92
|
/** 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 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 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 executed recently then the call will fail with ALREADY_EXISTS. The IDs of deleted tasks are not immediately available for reuse. It can take up to 24 hours (or 9 days if the task's queue was created using a queue.yaml or queue.xml) for the task ID to be released and made available again. Because there is an extra lookup cost to identify duplicate task names, these 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. */
|
|
85
93
|
task?: Task;
|
|
86
94
|
}
|
|
@@ -127,7 +135,15 @@ declare namespace gapi.client {
|
|
|
127
135
|
/** 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 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 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"`. * `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 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 specified using comma-separated values. The size of the headers must be less than 80KB. */
|
|
128
136
|
headers?: {[P in string]: string};
|
|
129
137
|
/** The HTTP method to use for the request. The default is POST. */
|
|
130
|
-
httpMethod?:
|
|
138
|
+
httpMethod?:
|
|
139
|
+
| 'HTTP_METHOD_UNSPECIFIED'
|
|
140
|
+
| 'POST'
|
|
141
|
+
| 'GET'
|
|
142
|
+
| 'HEAD'
|
|
143
|
+
| 'PUT'
|
|
144
|
+
| 'DELETE'
|
|
145
|
+
| 'PATCH'
|
|
146
|
+
| 'OPTIONS';
|
|
131
147
|
/** 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 authorization should generally only be used when calling Google APIs hosted on *.googleapis.com. */
|
|
132
148
|
oauthToken?: OAuthToken;
|
|
133
149
|
/** 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 type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. */
|
|
@@ -139,7 +155,15 @@ declare namespace gapi.client {
|
|
|
139
155
|
/** HTTP target headers. This map contains the header field names and values. Headers will be set when running the CreateTask and/or BufferTask. These headers represent a subset of the headers that will be configured for 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: * Several predefined headers, prefixed with "X-CloudTasks-", can be used to define properties of the task. * Host: This will be computed by Cloud Tasks and derived from HttpRequest.url. * Content-Length: This will be computed by Cloud Tasks. `Content-Type` won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a media type when the task is created. For example,`Content-Type` can be set to `"application/octet-stream"` or `"application/json"`. The default value is set to "application/json"`. * User-Agent: This will be set to `"Google-Cloud-Tasks"`. Headers which can have multiple values (according to RFC2616) can be specified using comma-separated values. The size of the headers must be less than 80KB. Queue-level headers to override headers of all the tasks in the queue. Do not put business sensitive or personally identifying data in the HTTP Header Override Configuration or other similar fields in accordance with Section 12 (Resource Fields) of the [Service Specific Terms](https://cloud.google.com/terms/service-terms). */
|
|
140
156
|
headerOverrides?: HeaderOverride[];
|
|
141
157
|
/** The HTTP method to use for the request. When specified, it overrides HttpRequest for the task. Note that if the value is set to HttpMethod the HttpRequest of the task will be ignored at execution time. */
|
|
142
|
-
httpMethod?:
|
|
158
|
+
httpMethod?:
|
|
159
|
+
| 'HTTP_METHOD_UNSPECIFIED'
|
|
160
|
+
| 'POST'
|
|
161
|
+
| 'GET'
|
|
162
|
+
| 'HEAD'
|
|
163
|
+
| 'PUT'
|
|
164
|
+
| 'DELETE'
|
|
165
|
+
| 'PATCH'
|
|
166
|
+
| 'OPTIONS';
|
|
143
167
|
/** If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) is generated and attached as the `Authorization` header in the HTTP request. This type of authorization should generally be used only when calling Google APIs hosted on *.googleapis.com. Note that both the service account email and the scope MUST be specified when using the queue-level authorization override. */
|
|
144
168
|
oauthToken?: OAuthToken;
|
|
145
169
|
/** If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token is generated and attached as an `Authorization` header in the HTTP request. This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself. Note that both the service account email and the audience MUST be specified when using the queue-level authorization override. */
|
|
@@ -223,7 +247,7 @@ declare namespace gapi.client {
|
|
|
223
247
|
/** Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written. */
|
|
224
248
|
stackdriverLoggingConfig?: StackdriverLoggingConfig;
|
|
225
249
|
/** Output only. The state of the queue. `state` can only be changed by calling PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`. */
|
|
226
|
-
state?:
|
|
250
|
+
state?: 'STATE_UNSPECIFIED' | 'RUNNING' | 'PAUSED' | 'DISABLED';
|
|
227
251
|
}
|
|
228
252
|
interface RateLimits {
|
|
229
253
|
/** 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 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 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 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 will be continuously refilled with new tokens based on `max_dispatches_per_second`. Cloud Tasks automatically sets an appropriate `max_burst_size` based on the value of `max_dispatches_per_second`. The value is dynamically optimized to ensure queue stability and throughput. It is generally at least equal to `max_dispatches_per_second` but might be higher to accommodate bursts of traffic. For queues that were created or updated using `queue.yaml/xml`, `max_burst_size` is equal to [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 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. */
|
|
@@ -248,7 +272,7 @@ declare namespace gapi.client {
|
|
|
248
272
|
}
|
|
249
273
|
interface RunTaskRequest {
|
|
250
274
|
/** 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 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 `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. */
|
|
251
|
-
responseView?:
|
|
275
|
+
responseView?: 'VIEW_UNSPECIFIED' | 'BASIC' | 'FULL';
|
|
252
276
|
}
|
|
253
277
|
interface SetIamPolicyRequest {
|
|
254
278
|
/** 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 services (such as Projects) might reject them. */
|
|
@@ -288,7 +312,7 @@ declare namespace gapi.client {
|
|
|
288
312
|
/** The time when the task is scheduled to be attempted or retried. `schedule_time` will be truncated to the nearest microsecond. */
|
|
289
313
|
scheduleTime?: string;
|
|
290
314
|
/** Output only. The view specifies which subset of the Task has been returned. */
|
|
291
|
-
view?:
|
|
315
|
+
view?: 'VIEW_UNSPECIFIED' | 'BASIC' | 'FULL';
|
|
292
316
|
}
|
|
293
317
|
interface TestIamPermissionsRequest {
|
|
294
318
|
/** 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). */
|
|
@@ -308,19 +332,22 @@ declare namespace gapi.client {
|
|
|
308
332
|
/** URI query. When specified, replaces the query part of the task URI. Setting the query value to an empty string clears the URI query segment. */
|
|
309
333
|
queryOverride?: QueryOverride;
|
|
310
334
|
/** Scheme override. When specified, the task URI scheme is replaced by the provided value (HTTP or HTTPS). */
|
|
311
|
-
scheme?:
|
|
335
|
+
scheme?: 'SCHEME_UNSPECIFIED' | 'HTTP' | 'HTTPS';
|
|
312
336
|
/** URI Override Enforce Mode When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS. */
|
|
313
|
-
uriOverrideEnforceMode?:
|
|
337
|
+
uriOverrideEnforceMode?:
|
|
338
|
+
| 'URI_OVERRIDE_ENFORCE_MODE_UNSPECIFIED'
|
|
339
|
+
| 'IF_NOT_EXISTS'
|
|
340
|
+
| 'ALWAYS';
|
|
314
341
|
}
|
|
315
342
|
interface TasksResource {
|
|
316
343
|
/** Creates and buffers a new task without the need to explicitly define a Task message. The queue must have HTTP target. To create the task with a custom ID, use the following format and set TASK_ID to your desired ID: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID:buffer To create the task with an automatically generated ID, use the following format: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks:buffer. */
|
|
317
344
|
buffer(request: {
|
|
318
345
|
/** V1 error format. */
|
|
319
|
-
'$.xgafv'?:
|
|
346
|
+
'$.xgafv'?: '1' | '2';
|
|
320
347
|
/** OAuth access token. */
|
|
321
348
|
access_token?: string;
|
|
322
349
|
/** Data format for response. */
|
|
323
|
-
alt?:
|
|
350
|
+
alt?: 'json' | 'media' | 'proto';
|
|
324
351
|
/** JSONP */
|
|
325
352
|
callback?: string;
|
|
326
353
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -347,11 +374,11 @@ declare namespace gapi.client {
|
|
|
347
374
|
buffer(
|
|
348
375
|
request: {
|
|
349
376
|
/** V1 error format. */
|
|
350
|
-
'$.xgafv'?:
|
|
377
|
+
'$.xgafv'?: '1' | '2';
|
|
351
378
|
/** OAuth access token. */
|
|
352
379
|
access_token?: string;
|
|
353
380
|
/** Data format for response. */
|
|
354
|
-
alt?:
|
|
381
|
+
alt?: 'json' | 'media' | 'proto';
|
|
355
382
|
/** JSONP */
|
|
356
383
|
callback?: string;
|
|
357
384
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -378,11 +405,11 @@ declare namespace gapi.client {
|
|
|
378
405
|
/** 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. */
|
|
379
406
|
create(request: {
|
|
380
407
|
/** V1 error format. */
|
|
381
|
-
'$.xgafv'?:
|
|
408
|
+
'$.xgafv'?: '1' | '2';
|
|
382
409
|
/** OAuth access token. */
|
|
383
410
|
access_token?: string;
|
|
384
411
|
/** Data format for response. */
|
|
385
|
-
alt?:
|
|
412
|
+
alt?: 'json' | 'media' | 'proto';
|
|
386
413
|
/** JSONP */
|
|
387
414
|
callback?: string;
|
|
388
415
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -407,11 +434,11 @@ declare namespace gapi.client {
|
|
|
407
434
|
create(
|
|
408
435
|
request: {
|
|
409
436
|
/** V1 error format. */
|
|
410
|
-
'$.xgafv'?:
|
|
437
|
+
'$.xgafv'?: '1' | '2';
|
|
411
438
|
/** OAuth access token. */
|
|
412
439
|
access_token?: string;
|
|
413
440
|
/** Data format for response. */
|
|
414
|
-
alt?:
|
|
441
|
+
alt?: 'json' | 'media' | 'proto';
|
|
415
442
|
/** JSONP */
|
|
416
443
|
callback?: string;
|
|
417
444
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -436,11 +463,11 @@ declare namespace gapi.client {
|
|
|
436
463
|
/** 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. */
|
|
437
464
|
delete(request?: {
|
|
438
465
|
/** V1 error format. */
|
|
439
|
-
'$.xgafv'?:
|
|
466
|
+
'$.xgafv'?: '1' | '2';
|
|
440
467
|
/** OAuth access token. */
|
|
441
468
|
access_token?: string;
|
|
442
469
|
/** Data format for response. */
|
|
443
|
-
alt?:
|
|
470
|
+
alt?: 'json' | 'media' | 'proto';
|
|
444
471
|
/** JSONP */
|
|
445
472
|
callback?: string;
|
|
446
473
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -463,11 +490,11 @@ declare namespace gapi.client {
|
|
|
463
490
|
/** Gets a task. After a task is successfully executed or has exhausted its retry attempts, the task is deleted. A `GetTask` request for a deleted task returns a `NOT_FOUND` error. */
|
|
464
491
|
get(request?: {
|
|
465
492
|
/** V1 error format. */
|
|
466
|
-
'$.xgafv'?:
|
|
493
|
+
'$.xgafv'?: '1' | '2';
|
|
467
494
|
/** OAuth access token. */
|
|
468
495
|
access_token?: string;
|
|
469
496
|
/** Data format for response. */
|
|
470
|
-
alt?:
|
|
497
|
+
alt?: 'json' | 'media' | 'proto';
|
|
471
498
|
/** JSONP */
|
|
472
499
|
callback?: string;
|
|
473
500
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -483,7 +510,7 @@ declare namespace gapi.client {
|
|
|
483
510
|
/** 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. */
|
|
484
511
|
quotaUser?: string;
|
|
485
512
|
/** 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 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 `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. */
|
|
486
|
-
responseView?:
|
|
513
|
+
responseView?: 'VIEW_UNSPECIFIED' | 'BASIC' | 'FULL';
|
|
487
514
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
488
515
|
upload_protocol?: string;
|
|
489
516
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -492,11 +519,11 @@ declare namespace gapi.client {
|
|
|
492
519
|
/** Lists the tasks in a queue. By default, only the BASIC view is retrieved due to performance considerations; response_view controls the subset of information which is returned. The tasks may be returned in any order. The ordering may change at any time. */
|
|
493
520
|
list(request?: {
|
|
494
521
|
/** V1 error format. */
|
|
495
|
-
'$.xgafv'?:
|
|
522
|
+
'$.xgafv'?: '1' | '2';
|
|
496
523
|
/** OAuth access token. */
|
|
497
524
|
access_token?: string;
|
|
498
525
|
/** Data format for response. */
|
|
499
|
-
alt?:
|
|
526
|
+
alt?: 'json' | 'media' | 'proto';
|
|
500
527
|
/** JSONP */
|
|
501
528
|
callback?: string;
|
|
502
529
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -516,7 +543,7 @@ declare namespace gapi.client {
|
|
|
516
543
|
/** 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. */
|
|
517
544
|
quotaUser?: string;
|
|
518
545
|
/** 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 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 `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) permission on the Task resource. */
|
|
519
|
-
responseView?:
|
|
546
|
+
responseView?: 'VIEW_UNSPECIFIED' | 'BASIC' | 'FULL';
|
|
520
547
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
521
548
|
upload_protocol?: string;
|
|
522
549
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -525,11 +552,11 @@ declare namespace gapi.client {
|
|
|
525
552
|
/** Forces a task to run now. When this method is called, Cloud Tasks will dispatch the task, even if the task is already running, the queue has reached its RateLimits or is PAUSED. This command is meant to be used for manual debugging. For example, RunTask can be used to retry a failed task after a fix has been made or to manually force a task to be dispatched now. If Cloud Tasks receives a successful response from the task's target, then the task will be deleted; otherwise the task's schedule_time will be reset to the time that RunTask was called plus the retry delay specified in the queue's RetryConfig. RunTask returns NOT_FOUND when it is called on a task that has already succeeded or permanently failed. */
|
|
526
553
|
run(request: {
|
|
527
554
|
/** V1 error format. */
|
|
528
|
-
'$.xgafv'?:
|
|
555
|
+
'$.xgafv'?: '1' | '2';
|
|
529
556
|
/** OAuth access token. */
|
|
530
557
|
access_token?: string;
|
|
531
558
|
/** Data format for response. */
|
|
532
|
-
alt?:
|
|
559
|
+
alt?: 'json' | 'media' | 'proto';
|
|
533
560
|
/** JSONP */
|
|
534
561
|
callback?: string;
|
|
535
562
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -554,11 +581,11 @@ declare namespace gapi.client {
|
|
|
554
581
|
run(
|
|
555
582
|
request: {
|
|
556
583
|
/** V1 error format. */
|
|
557
|
-
'$.xgafv'?:
|
|
584
|
+
'$.xgafv'?: '1' | '2';
|
|
558
585
|
/** OAuth access token. */
|
|
559
586
|
access_token?: string;
|
|
560
587
|
/** Data format for response. */
|
|
561
|
-
alt?:
|
|
588
|
+
alt?: 'json' | 'media' | 'proto';
|
|
562
589
|
/** JSONP */
|
|
563
590
|
callback?: string;
|
|
564
591
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -585,11 +612,11 @@ declare namespace gapi.client {
|
|
|
585
612
|
/** Creates a queue. Queues created with this method allow tasks to live for a maximum of 31 days. After a task is 31 days old, the task will be deleted regardless of whether it was dispatched or not. WARNING: Using this method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this method. */
|
|
586
613
|
create(request: {
|
|
587
614
|
/** V1 error format. */
|
|
588
|
-
'$.xgafv'?:
|
|
615
|
+
'$.xgafv'?: '1' | '2';
|
|
589
616
|
/** OAuth access token. */
|
|
590
617
|
access_token?: string;
|
|
591
618
|
/** Data format for response. */
|
|
592
|
-
alt?:
|
|
619
|
+
alt?: 'json' | 'media' | 'proto';
|
|
593
620
|
/** JSONP */
|
|
594
621
|
callback?: string;
|
|
595
622
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -614,11 +641,11 @@ declare namespace gapi.client {
|
|
|
614
641
|
create(
|
|
615
642
|
request: {
|
|
616
643
|
/** V1 error format. */
|
|
617
|
-
'$.xgafv'?:
|
|
644
|
+
'$.xgafv'?: '1' | '2';
|
|
618
645
|
/** OAuth access token. */
|
|
619
646
|
access_token?: string;
|
|
620
647
|
/** Data format for response. */
|
|
621
|
-
alt?:
|
|
648
|
+
alt?: 'json' | 'media' | 'proto';
|
|
622
649
|
/** JSONP */
|
|
623
650
|
callback?: string;
|
|
624
651
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -643,11 +670,11 @@ declare namespace gapi.client {
|
|
|
643
670
|
/** Deletes a queue. This command will delete the queue even if it has tasks in it. Note: If you delete a queue, you may be prevented from creating a new queue with the same name as the deleted queue for a tombstone window of up to 3 days. During this window, the CreateQueue operation may appear to recreate the queue, but this can be misleading. If you attempt to create a queue with the same name as one that is in the tombstone window, run GetQueue to confirm that the queue creation was successful. If GetQueue returns 200 response code, your queue was successfully created with the name of the previously deleted queue. Otherwise, your queue did not successfully recreate. WARNING: Using this method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this method. */
|
|
644
671
|
delete(request?: {
|
|
645
672
|
/** V1 error format. */
|
|
646
|
-
'$.xgafv'?:
|
|
673
|
+
'$.xgafv'?: '1' | '2';
|
|
647
674
|
/** OAuth access token. */
|
|
648
675
|
access_token?: string;
|
|
649
676
|
/** Data format for response. */
|
|
650
|
-
alt?:
|
|
677
|
+
alt?: 'json' | 'media' | 'proto';
|
|
651
678
|
/** JSONP */
|
|
652
679
|
callback?: string;
|
|
653
680
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -670,11 +697,11 @@ declare namespace gapi.client {
|
|
|
670
697
|
/** Gets a queue. */
|
|
671
698
|
get(request?: {
|
|
672
699
|
/** V1 error format. */
|
|
673
|
-
'$.xgafv'?:
|
|
700
|
+
'$.xgafv'?: '1' | '2';
|
|
674
701
|
/** OAuth access token. */
|
|
675
702
|
access_token?: string;
|
|
676
703
|
/** Data format for response. */
|
|
677
|
-
alt?:
|
|
704
|
+
alt?: 'json' | 'media' | 'proto';
|
|
678
705
|
/** JSONP */
|
|
679
706
|
callback?: string;
|
|
680
707
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -698,11 +725,11 @@ declare namespace gapi.client {
|
|
|
698
725
|
getIamPolicy(
|
|
699
726
|
request: {
|
|
700
727
|
/** V1 error format. */
|
|
701
|
-
'$.xgafv'?:
|
|
728
|
+
'$.xgafv'?: '1' | '2';
|
|
702
729
|
/** OAuth access token. */
|
|
703
730
|
access_token?: string;
|
|
704
731
|
/** Data format for response. */
|
|
705
|
-
alt?:
|
|
732
|
+
alt?: 'json' | 'media' | 'proto';
|
|
706
733
|
/** JSONP */
|
|
707
734
|
callback?: string;
|
|
708
735
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -727,11 +754,11 @@ declare namespace gapi.client {
|
|
|
727
754
|
/** Lists queues. Queues are returned in lexicographical order. */
|
|
728
755
|
list(request?: {
|
|
729
756
|
/** V1 error format. */
|
|
730
|
-
'$.xgafv'?:
|
|
757
|
+
'$.xgafv'?: '1' | '2';
|
|
731
758
|
/** OAuth access token. */
|
|
732
759
|
access_token?: string;
|
|
733
760
|
/** Data format for response. */
|
|
734
|
-
alt?:
|
|
761
|
+
alt?: 'json' | 'media' | 'proto';
|
|
735
762
|
/** JSONP */
|
|
736
763
|
callback?: string;
|
|
737
764
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -760,11 +787,11 @@ declare namespace gapi.client {
|
|
|
760
787
|
/** Updates a queue. This method creates the queue if it does not exist and updates the queue if it does exist. Queues created with this method allow tasks to live for a maximum of 31 days. After a task is 31 days old, the task will be deleted regardless of whether it was dispatched or not. WARNING: Using this method may have unintended side effects if you are using an App Engine `queue.yaml` or `queue.xml` file to manage your queues. Read [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using this method. */
|
|
761
788
|
patch(request: {
|
|
762
789
|
/** V1 error format. */
|
|
763
|
-
'$.xgafv'?:
|
|
790
|
+
'$.xgafv'?: '1' | '2';
|
|
764
791
|
/** OAuth access token. */
|
|
765
792
|
access_token?: string;
|
|
766
793
|
/** Data format for response. */
|
|
767
|
-
alt?:
|
|
794
|
+
alt?: 'json' | 'media' | 'proto';
|
|
768
795
|
/** JSONP */
|
|
769
796
|
callback?: string;
|
|
770
797
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -791,11 +818,11 @@ declare namespace gapi.client {
|
|
|
791
818
|
patch(
|
|
792
819
|
request: {
|
|
793
820
|
/** V1 error format. */
|
|
794
|
-
'$.xgafv'?:
|
|
821
|
+
'$.xgafv'?: '1' | '2';
|
|
795
822
|
/** OAuth access token. */
|
|
796
823
|
access_token?: string;
|
|
797
824
|
/** Data format for response. */
|
|
798
|
-
alt?:
|
|
825
|
+
alt?: 'json' | 'media' | 'proto';
|
|
799
826
|
/** JSONP */
|
|
800
827
|
callback?: string;
|
|
801
828
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -822,11 +849,11 @@ declare namespace gapi.client {
|
|
|
822
849
|
/** Pauses the queue. If a queue is paused then the system will stop dispatching tasks until the queue is resumed via ResumeQueue. Tasks can still be added when the queue is paused. A queue is paused if its state is PAUSED. */
|
|
823
850
|
pause(request: {
|
|
824
851
|
/** V1 error format. */
|
|
825
|
-
'$.xgafv'?:
|
|
852
|
+
'$.xgafv'?: '1' | '2';
|
|
826
853
|
/** OAuth access token. */
|
|
827
854
|
access_token?: string;
|
|
828
855
|
/** Data format for response. */
|
|
829
|
-
alt?:
|
|
856
|
+
alt?: 'json' | 'media' | 'proto';
|
|
830
857
|
/** JSONP */
|
|
831
858
|
callback?: string;
|
|
832
859
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -851,11 +878,11 @@ declare namespace gapi.client {
|
|
|
851
878
|
pause(
|
|
852
879
|
request: {
|
|
853
880
|
/** V1 error format. */
|
|
854
|
-
'$.xgafv'?:
|
|
881
|
+
'$.xgafv'?: '1' | '2';
|
|
855
882
|
/** OAuth access token. */
|
|
856
883
|
access_token?: string;
|
|
857
884
|
/** Data format for response. */
|
|
858
|
-
alt?:
|
|
885
|
+
alt?: 'json' | 'media' | 'proto';
|
|
859
886
|
/** JSONP */
|
|
860
887
|
callback?: string;
|
|
861
888
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -880,11 +907,11 @@ declare namespace gapi.client {
|
|
|
880
907
|
/** 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. */
|
|
881
908
|
purge(request: {
|
|
882
909
|
/** V1 error format. */
|
|
883
|
-
'$.xgafv'?:
|
|
910
|
+
'$.xgafv'?: '1' | '2';
|
|
884
911
|
/** OAuth access token. */
|
|
885
912
|
access_token?: string;
|
|
886
913
|
/** Data format for response. */
|
|
887
|
-
alt?:
|
|
914
|
+
alt?: 'json' | 'media' | 'proto';
|
|
888
915
|
/** JSONP */
|
|
889
916
|
callback?: string;
|
|
890
917
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -909,11 +936,11 @@ declare namespace gapi.client {
|
|
|
909
936
|
purge(
|
|
910
937
|
request: {
|
|
911
938
|
/** V1 error format. */
|
|
912
|
-
'$.xgafv'?:
|
|
939
|
+
'$.xgafv'?: '1' | '2';
|
|
913
940
|
/** OAuth access token. */
|
|
914
941
|
access_token?: string;
|
|
915
942
|
/** Data format for response. */
|
|
916
|
-
alt?:
|
|
943
|
+
alt?: 'json' | 'media' | 'proto';
|
|
917
944
|
/** JSONP */
|
|
918
945
|
callback?: string;
|
|
919
946
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -938,11 +965,11 @@ declare namespace gapi.client {
|
|
|
938
965
|
/** Resume a queue. This method resumes a queue after it has been PAUSED or DISABLED. The state of a queue is stored in the queue's state; after calling this method it will be set to RUNNING. WARNING: Resuming many high-QPS queues at the same time can lead to target overloading. If you are resuming high-QPS queues, follow the 500/50/5 pattern described in [Managing Cloud Tasks Scaling Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling). */
|
|
939
966
|
resume(request: {
|
|
940
967
|
/** V1 error format. */
|
|
941
|
-
'$.xgafv'?:
|
|
968
|
+
'$.xgafv'?: '1' | '2';
|
|
942
969
|
/** OAuth access token. */
|
|
943
970
|
access_token?: string;
|
|
944
971
|
/** Data format for response. */
|
|
945
|
-
alt?:
|
|
972
|
+
alt?: 'json' | 'media' | 'proto';
|
|
946
973
|
/** JSONP */
|
|
947
974
|
callback?: string;
|
|
948
975
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -967,11 +994,11 @@ declare namespace gapi.client {
|
|
|
967
994
|
resume(
|
|
968
995
|
request: {
|
|
969
996
|
/** V1 error format. */
|
|
970
|
-
'$.xgafv'?:
|
|
997
|
+
'$.xgafv'?: '1' | '2';
|
|
971
998
|
/** OAuth access token. */
|
|
972
999
|
access_token?: string;
|
|
973
1000
|
/** Data format for response. */
|
|
974
|
-
alt?:
|
|
1001
|
+
alt?: 'json' | 'media' | 'proto';
|
|
975
1002
|
/** JSONP */
|
|
976
1003
|
callback?: string;
|
|
977
1004
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -997,11 +1024,11 @@ declare namespace gapi.client {
|
|
|
997
1024
|
setIamPolicy(
|
|
998
1025
|
request: {
|
|
999
1026
|
/** V1 error format. */
|
|
1000
|
-
'$.xgafv'?:
|
|
1027
|
+
'$.xgafv'?: '1' | '2';
|
|
1001
1028
|
/** OAuth access token. */
|
|
1002
1029
|
access_token?: string;
|
|
1003
1030
|
/** Data format for response. */
|
|
1004
|
-
alt?:
|
|
1031
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1005
1032
|
/** JSONP */
|
|
1006
1033
|
callback?: string;
|
|
1007
1034
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1027,11 +1054,11 @@ declare namespace gapi.client {
|
|
|
1027
1054
|
testIamPermissions(
|
|
1028
1055
|
request: {
|
|
1029
1056
|
/** V1 error format. */
|
|
1030
|
-
'$.xgafv'?:
|
|
1057
|
+
'$.xgafv'?: '1' | '2';
|
|
1031
1058
|
/** OAuth access token. */
|
|
1032
1059
|
access_token?: string;
|
|
1033
1060
|
/** Data format for response. */
|
|
1034
|
-
alt?:
|
|
1061
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1035
1062
|
/** JSONP */
|
|
1036
1063
|
callback?: string;
|
|
1037
1064
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1059,11 +1086,11 @@ declare namespace gapi.client {
|
|
|
1059
1086
|
/** Gets information about a location. */
|
|
1060
1087
|
get(request?: {
|
|
1061
1088
|
/** V1 error format. */
|
|
1062
|
-
'$.xgafv'?:
|
|
1089
|
+
'$.xgafv'?: '1' | '2';
|
|
1063
1090
|
/** OAuth access token. */
|
|
1064
1091
|
access_token?: string;
|
|
1065
1092
|
/** Data format for response. */
|
|
1066
|
-
alt?:
|
|
1093
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1067
1094
|
/** JSONP */
|
|
1068
1095
|
callback?: string;
|
|
1069
1096
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1086,11 +1113,11 @@ declare namespace gapi.client {
|
|
|
1086
1113
|
/** Gets the CMEK config. Gets the Customer Managed Encryption Key configured with the Cloud Tasks lcoation. By default there is no kms_key configured. */
|
|
1087
1114
|
getCmekConfig(request?: {
|
|
1088
1115
|
/** V1 error format. */
|
|
1089
|
-
'$.xgafv'?:
|
|
1116
|
+
'$.xgafv'?: '1' | '2';
|
|
1090
1117
|
/** OAuth access token. */
|
|
1091
1118
|
access_token?: string;
|
|
1092
1119
|
/** Data format for response. */
|
|
1093
|
-
alt?:
|
|
1120
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1094
1121
|
/** JSONP */
|
|
1095
1122
|
callback?: string;
|
|
1096
1123
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1113,11 +1140,11 @@ declare namespace gapi.client {
|
|
|
1113
1140
|
/** Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project. */
|
|
1114
1141
|
list(request?: {
|
|
1115
1142
|
/** V1 error format. */
|
|
1116
|
-
'$.xgafv'?:
|
|
1143
|
+
'$.xgafv'?: '1' | '2';
|
|
1117
1144
|
/** OAuth access token. */
|
|
1118
1145
|
access_token?: string;
|
|
1119
1146
|
/** Data format for response. */
|
|
1120
|
-
alt?:
|
|
1147
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1121
1148
|
/** JSONP */
|
|
1122
1149
|
callback?: string;
|
|
1123
1150
|
/** Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */
|
|
@@ -1148,11 +1175,11 @@ declare namespace gapi.client {
|
|
|
1148
1175
|
/** Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key associated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config. */
|
|
1149
1176
|
updateCmekConfig(request: {
|
|
1150
1177
|
/** V1 error format. */
|
|
1151
|
-
'$.xgafv'?:
|
|
1178
|
+
'$.xgafv'?: '1' | '2';
|
|
1152
1179
|
/** OAuth access token. */
|
|
1153
1180
|
access_token?: string;
|
|
1154
1181
|
/** Data format for response. */
|
|
1155
|
-
alt?:
|
|
1182
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1156
1183
|
/** JSONP */
|
|
1157
1184
|
callback?: string;
|
|
1158
1185
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1179,11 +1206,11 @@ declare namespace gapi.client {
|
|
|
1179
1206
|
updateCmekConfig(
|
|
1180
1207
|
request: {
|
|
1181
1208
|
/** V1 error format. */
|
|
1182
|
-
'$.xgafv'?:
|
|
1209
|
+
'$.xgafv'?: '1' | '2';
|
|
1183
1210
|
/** OAuth access token. */
|
|
1184
1211
|
access_token?: string;
|
|
1185
1212
|
/** Data format for response. */
|
|
1186
|
-
alt?:
|
|
1213
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1187
1214
|
/** JSONP */
|
|
1188
1215
|
callback?: string;
|
|
1189
1216
|
/** Selector specifying which fields to include in a partial response. */
|