@maxim_mazurok/gapi.client.cloudtasks-v2beta3 0.1.20260115 → 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 +102 -75
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://cloudtasks.googleapis.com/$discovery/rest?version=v2beta3
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260306
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -40,7 +40,15 @@ declare namespace gapi.client {
|
|
|
40
40
|
/** 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. */
|
|
41
41
|
headers?: {[P in string]: string};
|
|
42
42
|
/** 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). */
|
|
43
|
-
httpMethod?:
|
|
43
|
+
httpMethod?:
|
|
44
|
+
| 'HTTP_METHOD_UNSPECIFIED'
|
|
45
|
+
| 'POST'
|
|
46
|
+
| 'GET'
|
|
47
|
+
| 'HEAD'
|
|
48
|
+
| 'PUT'
|
|
49
|
+
| 'DELETE'
|
|
50
|
+
| 'PATCH'
|
|
51
|
+
| 'OPTIONS';
|
|
44
52
|
/** 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. */
|
|
45
53
|
relativeUri?: string;
|
|
46
54
|
}
|
|
@@ -88,7 +96,7 @@ declare namespace gapi.client {
|
|
|
88
96
|
}
|
|
89
97
|
interface CreateTaskRequest {
|
|
90
98
|
/** 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. */
|
|
91
|
-
responseView?:
|
|
99
|
+
responseView?: 'VIEW_UNSPECIFIED' | 'BASIC' | 'FULL';
|
|
92
100
|
/** 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. */
|
|
93
101
|
task?: Task;
|
|
94
102
|
}
|
|
@@ -135,7 +143,15 @@ declare namespace gapi.client {
|
|
|
135
143
|
/** 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: * Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in Cloud Tasks. * 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. */
|
|
136
144
|
headers?: {[P in string]: string};
|
|
137
145
|
/** The HTTP method to use for the request. The default is POST. */
|
|
138
|
-
httpMethod?:
|
|
146
|
+
httpMethod?:
|
|
147
|
+
| 'HTTP_METHOD_UNSPECIFIED'
|
|
148
|
+
| 'POST'
|
|
149
|
+
| 'GET'
|
|
150
|
+
| 'HEAD'
|
|
151
|
+
| 'PUT'
|
|
152
|
+
| 'DELETE'
|
|
153
|
+
| 'PATCH'
|
|
154
|
+
| 'OPTIONS';
|
|
139
155
|
/** 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. */
|
|
140
156
|
oauthToken?: OAuthToken;
|
|
141
157
|
/** 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. */
|
|
@@ -147,7 +163,15 @@ declare namespace gapi.client {
|
|
|
147
163
|
/** 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). */
|
|
148
164
|
headerOverrides?: HeaderOverride[];
|
|
149
165
|
/** The HTTP method to use for the request. When specified, it overrides HttpRequest.http_method for the task. Note that if the value is set to HttpMethod.GET the HttpRequest.body of the task will be ignored at execution time. */
|
|
150
|
-
httpMethod?:
|
|
166
|
+
httpMethod?:
|
|
167
|
+
| 'HTTP_METHOD_UNSPECIFIED'
|
|
168
|
+
| 'POST'
|
|
169
|
+
| 'GET'
|
|
170
|
+
| 'HEAD'
|
|
171
|
+
| 'PUT'
|
|
172
|
+
| 'DELETE'
|
|
173
|
+
| 'PATCH'
|
|
174
|
+
| 'OPTIONS';
|
|
151
175
|
/** 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. */
|
|
152
176
|
oauthToken?: OAuthToken;
|
|
153
177
|
/** 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. */
|
|
@@ -237,7 +261,7 @@ declare namespace gapi.client {
|
|
|
237
261
|
/** Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written. */
|
|
238
262
|
stackdriverLoggingConfig?: StackdriverLoggingConfig;
|
|
239
263
|
/** Output only. The state of the queue. `state` can only be changed by called PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`. */
|
|
240
|
-
state?:
|
|
264
|
+
state?: 'STATE_UNSPECIFIED' | 'RUNNING' | 'PAUSED' | 'DISABLED';
|
|
241
265
|
/** Output only. The realtime, informational statistics for a queue. In order to receive the statistics the caller should include this field in the FieldMask. */
|
|
242
266
|
stats?: QueueStats;
|
|
243
267
|
/** The maximum amount of time that a task will be retained in this queue. After a task has lived for `task_ttl`, the task will be deleted regardless of whether it was dispatched or not. The minimum value is 10 days. The maximum value is 10 years. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). Queues created by Cloud Tasks have a default `task_ttl` of 31 days. . Queues created by queue.yaml/xml have a fixed `task_ttl` of the maximum duration, because there is a [storage quota](https://docs.cloud.google.com/appengine/docs/standard/quotas#Task_Queue) for these queues. */
|
|
@@ -245,7 +269,7 @@ declare namespace gapi.client {
|
|
|
245
269
|
/** The task tombstone time to live (TTL). After a task is deleted or executed, the task's tombstone is retained for the length of time specified by `tombstone_ttl`. The tombstone is used by task de-duplication; another task with the same name can't be created until the tombstone has expired. For more information about task de-duplication, see the documentation for CreateTaskRequest. The minimum value is 1 hour. The maximum value is 9 days. The value must be given as a string that indicates the length of time (in seconds) followed by `s` (for "seconds"). For more information on the format, see the documentation for [Duration](https://protobuf.dev/reference/protobuf/google.protobuf/#duration). Queues created by Cloud Tasks have a default `tombstone_ttl` of 1 hour. */
|
|
246
270
|
tombstoneTtl?: string;
|
|
247
271
|
/** Immutable. The type of a queue (push or pull). `Queue.type` is an immutable property of the queue that is set at the queue creation time. When left unspecified, the default value of `PUSH` is selected. */
|
|
248
|
-
type?:
|
|
272
|
+
type?: 'TYPE_UNSPECIFIED' | 'PULL' | 'PUSH';
|
|
249
273
|
}
|
|
250
274
|
interface QueueStats {
|
|
251
275
|
/** Output only. The number of requests that the queue has dispatched but has not received a reply for yet. */
|
|
@@ -282,7 +306,7 @@ declare namespace gapi.client {
|
|
|
282
306
|
}
|
|
283
307
|
interface RunTaskRequest {
|
|
284
308
|
/** 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. */
|
|
285
|
-
responseView?:
|
|
309
|
+
responseView?: 'VIEW_UNSPECIFIED' | 'BASIC' | 'FULL';
|
|
286
310
|
}
|
|
287
311
|
interface SetIamPolicyRequest {
|
|
288
312
|
/** 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. */
|
|
@@ -324,7 +348,7 @@ declare namespace gapi.client {
|
|
|
324
348
|
/** The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. `schedule_time` will be truncated to the nearest microsecond. */
|
|
325
349
|
scheduleTime?: string;
|
|
326
350
|
/** Output only. The view specifies which subset of the Task has been returned. */
|
|
327
|
-
view?:
|
|
351
|
+
view?: 'VIEW_UNSPECIFIED' | 'BASIC' | 'FULL';
|
|
328
352
|
}
|
|
329
353
|
interface TestIamPermissionsRequest {
|
|
330
354
|
/** 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). */
|
|
@@ -344,19 +368,22 @@ declare namespace gapi.client {
|
|
|
344
368
|
/** 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. */
|
|
345
369
|
queryOverride?: QueryOverride;
|
|
346
370
|
/** Scheme override. When specified, the task URI scheme is replaced by the provided value (HTTP or HTTPS). */
|
|
347
|
-
scheme?:
|
|
371
|
+
scheme?: 'SCHEME_UNSPECIFIED' | 'HTTP' | 'HTTPS';
|
|
348
372
|
/** URI Override Enforce Mode When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS. */
|
|
349
|
-
uriOverrideEnforceMode?:
|
|
373
|
+
uriOverrideEnforceMode?:
|
|
374
|
+
| 'URI_OVERRIDE_ENFORCE_MODE_UNSPECIFIED'
|
|
375
|
+
| 'IF_NOT_EXISTS'
|
|
376
|
+
| 'ALWAYS';
|
|
350
377
|
}
|
|
351
378
|
interface TasksResource {
|
|
352
379
|
/** 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. */
|
|
353
380
|
buffer(request: {
|
|
354
381
|
/** V1 error format. */
|
|
355
|
-
'$.xgafv'?:
|
|
382
|
+
'$.xgafv'?: '1' | '2';
|
|
356
383
|
/** OAuth access token. */
|
|
357
384
|
access_token?: string;
|
|
358
385
|
/** Data format for response. */
|
|
359
|
-
alt?:
|
|
386
|
+
alt?: 'json' | 'media' | 'proto';
|
|
360
387
|
/** JSONP */
|
|
361
388
|
callback?: string;
|
|
362
389
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -383,11 +410,11 @@ declare namespace gapi.client {
|
|
|
383
410
|
buffer(
|
|
384
411
|
request: {
|
|
385
412
|
/** V1 error format. */
|
|
386
|
-
'$.xgafv'?:
|
|
413
|
+
'$.xgafv'?: '1' | '2';
|
|
387
414
|
/** OAuth access token. */
|
|
388
415
|
access_token?: string;
|
|
389
416
|
/** Data format for response. */
|
|
390
|
-
alt?:
|
|
417
|
+
alt?: 'json' | 'media' | 'proto';
|
|
391
418
|
/** JSONP */
|
|
392
419
|
callback?: string;
|
|
393
420
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -414,11 +441,11 @@ declare namespace gapi.client {
|
|
|
414
441
|
/** 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. */
|
|
415
442
|
create(request: {
|
|
416
443
|
/** V1 error format. */
|
|
417
|
-
'$.xgafv'?:
|
|
444
|
+
'$.xgafv'?: '1' | '2';
|
|
418
445
|
/** OAuth access token. */
|
|
419
446
|
access_token?: string;
|
|
420
447
|
/** Data format for response. */
|
|
421
|
-
alt?:
|
|
448
|
+
alt?: 'json' | 'media' | 'proto';
|
|
422
449
|
/** JSONP */
|
|
423
450
|
callback?: string;
|
|
424
451
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -443,11 +470,11 @@ declare namespace gapi.client {
|
|
|
443
470
|
create(
|
|
444
471
|
request: {
|
|
445
472
|
/** V1 error format. */
|
|
446
|
-
'$.xgafv'?:
|
|
473
|
+
'$.xgafv'?: '1' | '2';
|
|
447
474
|
/** OAuth access token. */
|
|
448
475
|
access_token?: string;
|
|
449
476
|
/** Data format for response. */
|
|
450
|
-
alt?:
|
|
477
|
+
alt?: 'json' | 'media' | 'proto';
|
|
451
478
|
/** JSONP */
|
|
452
479
|
callback?: string;
|
|
453
480
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -472,11 +499,11 @@ declare namespace gapi.client {
|
|
|
472
499
|
/** 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. */
|
|
473
500
|
delete(request?: {
|
|
474
501
|
/** V1 error format. */
|
|
475
|
-
'$.xgafv'?:
|
|
502
|
+
'$.xgafv'?: '1' | '2';
|
|
476
503
|
/** OAuth access token. */
|
|
477
504
|
access_token?: string;
|
|
478
505
|
/** Data format for response. */
|
|
479
|
-
alt?:
|
|
506
|
+
alt?: 'json' | 'media' | 'proto';
|
|
480
507
|
/** JSONP */
|
|
481
508
|
callback?: string;
|
|
482
509
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -499,11 +526,11 @@ declare namespace gapi.client {
|
|
|
499
526
|
/** 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. */
|
|
500
527
|
get(request?: {
|
|
501
528
|
/** V1 error format. */
|
|
502
|
-
'$.xgafv'?:
|
|
529
|
+
'$.xgafv'?: '1' | '2';
|
|
503
530
|
/** OAuth access token. */
|
|
504
531
|
access_token?: string;
|
|
505
532
|
/** Data format for response. */
|
|
506
|
-
alt?:
|
|
533
|
+
alt?: 'json' | 'media' | 'proto';
|
|
507
534
|
/** JSONP */
|
|
508
535
|
callback?: string;
|
|
509
536
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -519,7 +546,7 @@ declare namespace gapi.client {
|
|
|
519
546
|
/** 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. */
|
|
520
547
|
quotaUser?: string;
|
|
521
548
|
/** 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. */
|
|
522
|
-
responseView?:
|
|
549
|
+
responseView?: 'VIEW_UNSPECIFIED' | 'BASIC' | 'FULL';
|
|
523
550
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
524
551
|
upload_protocol?: string;
|
|
525
552
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -528,11 +555,11 @@ declare namespace gapi.client {
|
|
|
528
555
|
/** 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. */
|
|
529
556
|
list(request?: {
|
|
530
557
|
/** V1 error format. */
|
|
531
|
-
'$.xgafv'?:
|
|
558
|
+
'$.xgafv'?: '1' | '2';
|
|
532
559
|
/** OAuth access token. */
|
|
533
560
|
access_token?: string;
|
|
534
561
|
/** Data format for response. */
|
|
535
|
-
alt?:
|
|
562
|
+
alt?: 'json' | 'media' | 'proto';
|
|
536
563
|
/** JSONP */
|
|
537
564
|
callback?: string;
|
|
538
565
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -552,7 +579,7 @@ declare namespace gapi.client {
|
|
|
552
579
|
/** 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. */
|
|
553
580
|
quotaUser?: string;
|
|
554
581
|
/** 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. */
|
|
555
|
-
responseView?:
|
|
582
|
+
responseView?: 'VIEW_UNSPECIFIED' | 'BASIC' | 'FULL';
|
|
556
583
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
557
584
|
upload_protocol?: string;
|
|
558
585
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -561,11 +588,11 @@ declare namespace gapi.client {
|
|
|
561
588
|
/** Forces a task to run now. When this method is called, Cloud Tasks will dispatch the task, even if the task is already running, the queue has reached its RateLimits or is PAUSED. This command is meant to be used for manual debugging. For example, RunTask can be used to retry a failed task after a fix has been made or to manually force a task to be dispatched now. The dispatched task is returned. That is, the task that is returned contains the status after the task is dispatched but before the task is received by its target. If Cloud Tasks receives a successful response from the task's target, then the task will be deleted; otherwise the task's schedule_time will be reset to the time that RunTask was called plus the retry delay specified in the queue's RetryConfig. RunTask returns NOT_FOUND when it is called on a task that has already succeeded or permanently failed. */
|
|
562
589
|
run(request: {
|
|
563
590
|
/** V1 error format. */
|
|
564
|
-
'$.xgafv'?:
|
|
591
|
+
'$.xgafv'?: '1' | '2';
|
|
565
592
|
/** OAuth access token. */
|
|
566
593
|
access_token?: string;
|
|
567
594
|
/** Data format for response. */
|
|
568
|
-
alt?:
|
|
595
|
+
alt?: 'json' | 'media' | 'proto';
|
|
569
596
|
/** JSONP */
|
|
570
597
|
callback?: string;
|
|
571
598
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -590,11 +617,11 @@ declare namespace gapi.client {
|
|
|
590
617
|
run(
|
|
591
618
|
request: {
|
|
592
619
|
/** V1 error format. */
|
|
593
|
-
'$.xgafv'?:
|
|
620
|
+
'$.xgafv'?: '1' | '2';
|
|
594
621
|
/** OAuth access token. */
|
|
595
622
|
access_token?: string;
|
|
596
623
|
/** Data format for response. */
|
|
597
|
-
alt?:
|
|
624
|
+
alt?: 'json' | 'media' | 'proto';
|
|
598
625
|
/** JSONP */
|
|
599
626
|
callback?: string;
|
|
600
627
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -621,11 +648,11 @@ declare namespace gapi.client {
|
|
|
621
648
|
/** 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. */
|
|
622
649
|
create(request: {
|
|
623
650
|
/** V1 error format. */
|
|
624
|
-
'$.xgafv'?:
|
|
651
|
+
'$.xgafv'?: '1' | '2';
|
|
625
652
|
/** OAuth access token. */
|
|
626
653
|
access_token?: string;
|
|
627
654
|
/** Data format for response. */
|
|
628
|
-
alt?:
|
|
655
|
+
alt?: 'json' | 'media' | 'proto';
|
|
629
656
|
/** JSONP */
|
|
630
657
|
callback?: string;
|
|
631
658
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -650,11 +677,11 @@ declare namespace gapi.client {
|
|
|
650
677
|
create(
|
|
651
678
|
request: {
|
|
652
679
|
/** V1 error format. */
|
|
653
|
-
'$.xgafv'?:
|
|
680
|
+
'$.xgafv'?: '1' | '2';
|
|
654
681
|
/** OAuth access token. */
|
|
655
682
|
access_token?: string;
|
|
656
683
|
/** Data format for response. */
|
|
657
|
-
alt?:
|
|
684
|
+
alt?: 'json' | 'media' | 'proto';
|
|
658
685
|
/** JSONP */
|
|
659
686
|
callback?: string;
|
|
660
687
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -679,11 +706,11 @@ declare namespace gapi.client {
|
|
|
679
706
|
/** 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. */
|
|
680
707
|
delete(request?: {
|
|
681
708
|
/** V1 error format. */
|
|
682
|
-
'$.xgafv'?:
|
|
709
|
+
'$.xgafv'?: '1' | '2';
|
|
683
710
|
/** OAuth access token. */
|
|
684
711
|
access_token?: string;
|
|
685
712
|
/** Data format for response. */
|
|
686
|
-
alt?:
|
|
713
|
+
alt?: 'json' | 'media' | 'proto';
|
|
687
714
|
/** JSONP */
|
|
688
715
|
callback?: string;
|
|
689
716
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -706,11 +733,11 @@ declare namespace gapi.client {
|
|
|
706
733
|
/** Gets a queue. */
|
|
707
734
|
get(request?: {
|
|
708
735
|
/** V1 error format. */
|
|
709
|
-
'$.xgafv'?:
|
|
736
|
+
'$.xgafv'?: '1' | '2';
|
|
710
737
|
/** OAuth access token. */
|
|
711
738
|
access_token?: string;
|
|
712
739
|
/** Data format for response. */
|
|
713
|
-
alt?:
|
|
740
|
+
alt?: 'json' | 'media' | 'proto';
|
|
714
741
|
/** JSONP */
|
|
715
742
|
callback?: string;
|
|
716
743
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -736,11 +763,11 @@ declare namespace gapi.client {
|
|
|
736
763
|
getIamPolicy(
|
|
737
764
|
request: {
|
|
738
765
|
/** V1 error format. */
|
|
739
|
-
'$.xgafv'?:
|
|
766
|
+
'$.xgafv'?: '1' | '2';
|
|
740
767
|
/** OAuth access token. */
|
|
741
768
|
access_token?: string;
|
|
742
769
|
/** Data format for response. */
|
|
743
|
-
alt?:
|
|
770
|
+
alt?: 'json' | 'media' | 'proto';
|
|
744
771
|
/** JSONP */
|
|
745
772
|
callback?: string;
|
|
746
773
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -765,11 +792,11 @@ declare namespace gapi.client {
|
|
|
765
792
|
/** Lists queues. Queues are returned in lexicographical order. */
|
|
766
793
|
list(request?: {
|
|
767
794
|
/** V1 error format. */
|
|
768
|
-
'$.xgafv'?:
|
|
795
|
+
'$.xgafv'?: '1' | '2';
|
|
769
796
|
/** OAuth access token. */
|
|
770
797
|
access_token?: string;
|
|
771
798
|
/** Data format for response. */
|
|
772
|
-
alt?:
|
|
799
|
+
alt?: 'json' | 'media' | 'proto';
|
|
773
800
|
/** JSONP */
|
|
774
801
|
callback?: string;
|
|
775
802
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -800,11 +827,11 @@ declare namespace gapi.client {
|
|
|
800
827
|
/** 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. */
|
|
801
828
|
patch(request: {
|
|
802
829
|
/** V1 error format. */
|
|
803
|
-
'$.xgafv'?:
|
|
830
|
+
'$.xgafv'?: '1' | '2';
|
|
804
831
|
/** OAuth access token. */
|
|
805
832
|
access_token?: string;
|
|
806
833
|
/** Data format for response. */
|
|
807
|
-
alt?:
|
|
834
|
+
alt?: 'json' | 'media' | 'proto';
|
|
808
835
|
/** JSONP */
|
|
809
836
|
callback?: string;
|
|
810
837
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -831,11 +858,11 @@ declare namespace gapi.client {
|
|
|
831
858
|
patch(
|
|
832
859
|
request: {
|
|
833
860
|
/** V1 error format. */
|
|
834
|
-
'$.xgafv'?:
|
|
861
|
+
'$.xgafv'?: '1' | '2';
|
|
835
862
|
/** OAuth access token. */
|
|
836
863
|
access_token?: string;
|
|
837
864
|
/** Data format for response. */
|
|
838
|
-
alt?:
|
|
865
|
+
alt?: 'json' | 'media' | 'proto';
|
|
839
866
|
/** JSONP */
|
|
840
867
|
callback?: string;
|
|
841
868
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -862,11 +889,11 @@ declare namespace gapi.client {
|
|
|
862
889
|
/** 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. */
|
|
863
890
|
pause(request: {
|
|
864
891
|
/** V1 error format. */
|
|
865
|
-
'$.xgafv'?:
|
|
892
|
+
'$.xgafv'?: '1' | '2';
|
|
866
893
|
/** OAuth access token. */
|
|
867
894
|
access_token?: string;
|
|
868
895
|
/** Data format for response. */
|
|
869
|
-
alt?:
|
|
896
|
+
alt?: 'json' | 'media' | 'proto';
|
|
870
897
|
/** JSONP */
|
|
871
898
|
callback?: string;
|
|
872
899
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -891,11 +918,11 @@ declare namespace gapi.client {
|
|
|
891
918
|
pause(
|
|
892
919
|
request: {
|
|
893
920
|
/** V1 error format. */
|
|
894
|
-
'$.xgafv'?:
|
|
921
|
+
'$.xgafv'?: '1' | '2';
|
|
895
922
|
/** OAuth access token. */
|
|
896
923
|
access_token?: string;
|
|
897
924
|
/** Data format for response. */
|
|
898
|
-
alt?:
|
|
925
|
+
alt?: 'json' | 'media' | 'proto';
|
|
899
926
|
/** JSONP */
|
|
900
927
|
callback?: string;
|
|
901
928
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -920,11 +947,11 @@ declare namespace gapi.client {
|
|
|
920
947
|
/** 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. */
|
|
921
948
|
purge(request: {
|
|
922
949
|
/** V1 error format. */
|
|
923
|
-
'$.xgafv'?:
|
|
950
|
+
'$.xgafv'?: '1' | '2';
|
|
924
951
|
/** OAuth access token. */
|
|
925
952
|
access_token?: string;
|
|
926
953
|
/** Data format for response. */
|
|
927
|
-
alt?:
|
|
954
|
+
alt?: 'json' | 'media' | 'proto';
|
|
928
955
|
/** JSONP */
|
|
929
956
|
callback?: string;
|
|
930
957
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -949,11 +976,11 @@ declare namespace gapi.client {
|
|
|
949
976
|
purge(
|
|
950
977
|
request: {
|
|
951
978
|
/** V1 error format. */
|
|
952
|
-
'$.xgafv'?:
|
|
979
|
+
'$.xgafv'?: '1' | '2';
|
|
953
980
|
/** OAuth access token. */
|
|
954
981
|
access_token?: string;
|
|
955
982
|
/** Data format for response. */
|
|
956
|
-
alt?:
|
|
983
|
+
alt?: 'json' | 'media' | 'proto';
|
|
957
984
|
/** JSONP */
|
|
958
985
|
callback?: string;
|
|
959
986
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -978,11 +1005,11 @@ declare namespace gapi.client {
|
|
|
978
1005
|
/** 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). */
|
|
979
1006
|
resume(request: {
|
|
980
1007
|
/** V1 error format. */
|
|
981
|
-
'$.xgafv'?:
|
|
1008
|
+
'$.xgafv'?: '1' | '2';
|
|
982
1009
|
/** OAuth access token. */
|
|
983
1010
|
access_token?: string;
|
|
984
1011
|
/** Data format for response. */
|
|
985
|
-
alt?:
|
|
1012
|
+
alt?: 'json' | 'media' | 'proto';
|
|
986
1013
|
/** JSONP */
|
|
987
1014
|
callback?: string;
|
|
988
1015
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1007,11 +1034,11 @@ declare namespace gapi.client {
|
|
|
1007
1034
|
resume(
|
|
1008
1035
|
request: {
|
|
1009
1036
|
/** V1 error format. */
|
|
1010
|
-
'$.xgafv'?:
|
|
1037
|
+
'$.xgafv'?: '1' | '2';
|
|
1011
1038
|
/** OAuth access token. */
|
|
1012
1039
|
access_token?: string;
|
|
1013
1040
|
/** Data format for response. */
|
|
1014
|
-
alt?:
|
|
1041
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1015
1042
|
/** JSONP */
|
|
1016
1043
|
callback?: string;
|
|
1017
1044
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1037,11 +1064,11 @@ declare namespace gapi.client {
|
|
|
1037
1064
|
setIamPolicy(
|
|
1038
1065
|
request: {
|
|
1039
1066
|
/** V1 error format. */
|
|
1040
|
-
'$.xgafv'?:
|
|
1067
|
+
'$.xgafv'?: '1' | '2';
|
|
1041
1068
|
/** OAuth access token. */
|
|
1042
1069
|
access_token?: string;
|
|
1043
1070
|
/** Data format for response. */
|
|
1044
|
-
alt?:
|
|
1071
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1045
1072
|
/** JSONP */
|
|
1046
1073
|
callback?: string;
|
|
1047
1074
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1067,11 +1094,11 @@ declare namespace gapi.client {
|
|
|
1067
1094
|
testIamPermissions(
|
|
1068
1095
|
request: {
|
|
1069
1096
|
/** V1 error format. */
|
|
1070
|
-
'$.xgafv'?:
|
|
1097
|
+
'$.xgafv'?: '1' | '2';
|
|
1071
1098
|
/** OAuth access token. */
|
|
1072
1099
|
access_token?: string;
|
|
1073
1100
|
/** Data format for response. */
|
|
1074
|
-
alt?:
|
|
1101
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1075
1102
|
/** JSONP */
|
|
1076
1103
|
callback?: string;
|
|
1077
1104
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1099,11 +1126,11 @@ declare namespace gapi.client {
|
|
|
1099
1126
|
/** Gets information about a location. */
|
|
1100
1127
|
get(request?: {
|
|
1101
1128
|
/** V1 error format. */
|
|
1102
|
-
'$.xgafv'?:
|
|
1129
|
+
'$.xgafv'?: '1' | '2';
|
|
1103
1130
|
/** OAuth access token. */
|
|
1104
1131
|
access_token?: string;
|
|
1105
1132
|
/** Data format for response. */
|
|
1106
|
-
alt?:
|
|
1133
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1107
1134
|
/** JSONP */
|
|
1108
1135
|
callback?: string;
|
|
1109
1136
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1126,11 +1153,11 @@ declare namespace gapi.client {
|
|
|
1126
1153
|
/** Gets the CMEK config. Gets the Customer Managed Encryption Key configured with the Cloud Tasks lcoation. By default there is no kms_key configured. */
|
|
1127
1154
|
getCmekConfig(request?: {
|
|
1128
1155
|
/** V1 error format. */
|
|
1129
|
-
'$.xgafv'?:
|
|
1156
|
+
'$.xgafv'?: '1' | '2';
|
|
1130
1157
|
/** OAuth access token. */
|
|
1131
1158
|
access_token?: string;
|
|
1132
1159
|
/** Data format for response. */
|
|
1133
|
-
alt?:
|
|
1160
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1134
1161
|
/** JSONP */
|
|
1135
1162
|
callback?: string;
|
|
1136
1163
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1150,14 +1177,14 @@ declare namespace gapi.client {
|
|
|
1150
1177
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1151
1178
|
uploadType?: string;
|
|
1152
1179
|
}): Request<CmekConfig>;
|
|
1153
|
-
/** Lists information about the supported locations for this service. */
|
|
1180
|
+
/** 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. */
|
|
1154
1181
|
list(request?: {
|
|
1155
1182
|
/** V1 error format. */
|
|
1156
|
-
'$.xgafv'?:
|
|
1183
|
+
'$.xgafv'?: '1' | '2';
|
|
1157
1184
|
/** OAuth access token. */
|
|
1158
1185
|
access_token?: string;
|
|
1159
1186
|
/** Data format for response. */
|
|
1160
|
-
alt?:
|
|
1187
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1161
1188
|
/** JSONP */
|
|
1162
1189
|
callback?: string;
|
|
1163
1190
|
/** Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */
|
|
@@ -1185,14 +1212,14 @@ declare namespace gapi.client {
|
|
|
1185
1212
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1186
1213
|
uploadType?: string;
|
|
1187
1214
|
}): Request<ListLocationsResponse>;
|
|
1188
|
-
/** Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key
|
|
1215
|
+
/** 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. */
|
|
1189
1216
|
updateCmekConfig(request: {
|
|
1190
1217
|
/** V1 error format. */
|
|
1191
|
-
'$.xgafv'?:
|
|
1218
|
+
'$.xgafv'?: '1' | '2';
|
|
1192
1219
|
/** OAuth access token. */
|
|
1193
1220
|
access_token?: string;
|
|
1194
1221
|
/** Data format for response. */
|
|
1195
|
-
alt?:
|
|
1222
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1196
1223
|
/** JSONP */
|
|
1197
1224
|
callback?: string;
|
|
1198
1225
|
/** Selector specifying which fields to include in a partial response. */
|
|
@@ -1219,11 +1246,11 @@ declare namespace gapi.client {
|
|
|
1219
1246
|
updateCmekConfig(
|
|
1220
1247
|
request: {
|
|
1221
1248
|
/** V1 error format. */
|
|
1222
|
-
'$.xgafv'?:
|
|
1249
|
+
'$.xgafv'?: '1' | '2';
|
|
1223
1250
|
/** OAuth access token. */
|
|
1224
1251
|
access_token?: string;
|
|
1225
1252
|
/** Data format for response. */
|
|
1226
|
-
alt?:
|
|
1253
|
+
alt?: 'json' | 'media' | 'proto';
|
|
1227
1254
|
/** JSONP */
|
|
1228
1255
|
callback?: string;
|
|
1229
1256
|
/** Selector specifying which fields to include in a partial response. */
|