@maxim_mazurok/gapi.client.cloudtasks-v2beta3 0.3.20260707 → 0.3.20260722
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 +176 -2
- 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: 20260722
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -72,6 +72,18 @@ declare namespace gapi.client {
|
|
|
72
72
|
/** Output only. The time that this attempt was scheduled. `schedule_time` will be truncated to the nearest microsecond. */
|
|
73
73
|
scheduleTime?: string;
|
|
74
74
|
}
|
|
75
|
+
interface BatchCreateTasksRequest {
|
|
76
|
+
/** Optional. This field will be used to identify the long running operation, avoiding duplication when user retries. If not provided, then a UUID will be generated at server side. */
|
|
77
|
+
requestId?: string;
|
|
78
|
+
/** Required. The list of requests to create tasks. The queue specified in parent field of each CreateTaskRequest will be the same. This validation happens on the client side as well as in the handler. BatchCreateTasksRequest.parent will also be the same value as the individual CreateTaskRequest.parent . The maximum number of requests is 100. */
|
|
79
|
+
requests?: CreateTaskRequest[];
|
|
80
|
+
}
|
|
81
|
+
interface BatchDeleteTasksRequest {
|
|
82
|
+
/** Required. The names of the tasks to delete. A maximum of 1000 tasks can be deleted in a batch. For example: Format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` */
|
|
83
|
+
names?: string[];
|
|
84
|
+
/** Optional. This field will be used to identify the long running operation, avoiding duplication when user retries. If not provided, then a UUID will be generated at server side. */
|
|
85
|
+
requestId?: string;
|
|
86
|
+
}
|
|
75
87
|
interface Binding {
|
|
76
88
|
/** 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`, 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 resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). */
|
|
77
89
|
condition?: Expr;
|
|
@@ -95,6 +107,8 @@ declare namespace gapi.client {
|
|
|
95
107
|
name?: string;
|
|
96
108
|
}
|
|
97
109
|
interface CreateTaskRequest {
|
|
110
|
+
/** Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue must already exist. */
|
|
111
|
+
parent?: string;
|
|
98
112
|
/** 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. */
|
|
99
113
|
responseView?: 'VIEW_UNSPECIFIED' | 'BASIC' | 'FULL';
|
|
100
114
|
/** 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. */
|
|
@@ -221,6 +235,18 @@ declare namespace gapi.client {
|
|
|
221
235
|
/** [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. The caller must have iam.serviceAccounts.actAs permission for the service account. */
|
|
222
236
|
serviceAccountEmail?: string;
|
|
223
237
|
}
|
|
238
|
+
interface Operation {
|
|
239
|
+
/** If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */
|
|
240
|
+
done?: boolean;
|
|
241
|
+
/** The error result of the operation in case of failure or cancellation. */
|
|
242
|
+
error?: Status;
|
|
243
|
+
/** Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. */
|
|
244
|
+
metadata?: {[P in string]: any};
|
|
245
|
+
/** The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. */
|
|
246
|
+
name?: string;
|
|
247
|
+
/** The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */
|
|
248
|
+
response?: {[P in string]: any};
|
|
249
|
+
}
|
|
224
250
|
interface PathOverride {
|
|
225
251
|
/** The URI path (e.g., /users/1234). Default is an empty string. */
|
|
226
252
|
path?: string;
|
|
@@ -256,7 +282,7 @@ declare namespace gapi.client {
|
|
|
256
282
|
purgeTime?: string;
|
|
257
283
|
/** 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: * 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). * retry_config controls what happens to a particular task after its first attempt fails. That is, retry_config controls task retries (the second attempt, third attempt, etc). The 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 to `429` (Too Many Requests) or `503` (Service Unavailable) responses from the worker, high error rates, or to smooth sudden large traffic spikes. */
|
|
258
284
|
rateLimits?: RateLimits;
|
|
259
|
-
/** Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks.
|
|
285
|
+
/** Settings that determine the retry behavior. * For tasks created using Cloud Tasks: the queue-level retry settings apply to all tasks in the queue that were created using Cloud Tasks. Optionally, retry settings can be set on individual tasks and override the queue-level retry settings for the task. * For tasks created using the App Engine SDK: the queue-level retry settings apply to all tasks in the queue which do not have retry settings explicitly set on the task and were created by the App Engine SDK. See [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). */
|
|
260
286
|
retryConfig?: RetryConfig;
|
|
261
287
|
/** Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this field is unset, then no logs are written. */
|
|
262
288
|
stackdriverLoggingConfig?: StackdriverLoggingConfig;
|
|
@@ -345,6 +371,8 @@ declare namespace gapi.client {
|
|
|
345
371
|
pullMessage?: PullMessage;
|
|
346
372
|
/** Output only. The number of attempts which have received a response. */
|
|
347
373
|
responseCount?: number;
|
|
374
|
+
/** Optional. Specifies the task-level retry config. If present, this overrides the queue-level retry config for this task. */
|
|
375
|
+
retryConfig?: RetryConfig;
|
|
348
376
|
/** 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. */
|
|
349
377
|
scheduleTime?: string;
|
|
350
378
|
/** Output only. The view specifies which subset of the Task has been returned. */
|
|
@@ -373,7 +401,152 @@ declare namespace gapi.client {
|
|
|
373
401
|
uriOverrideEnforceMode?:
|
|
374
402
|
'URI_OVERRIDE_ENFORCE_MODE_UNSPECIFIED' | 'IF_NOT_EXISTS' | 'ALWAYS';
|
|
375
403
|
}
|
|
404
|
+
interface OperationsResource {
|
|
405
|
+
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
406
|
+
get(request?: {
|
|
407
|
+
/** V1 error format. */
|
|
408
|
+
'$.xgafv'?: '1' | '2';
|
|
409
|
+
/** OAuth access token. */
|
|
410
|
+
access_token?: string;
|
|
411
|
+
/** Data format for response. */
|
|
412
|
+
alt?: 'json' | 'media' | 'proto';
|
|
413
|
+
/** JSONP */
|
|
414
|
+
callback?: string;
|
|
415
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
416
|
+
fields?: string;
|
|
417
|
+
/** 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. */
|
|
418
|
+
key?: string;
|
|
419
|
+
/** The name of the operation resource. */
|
|
420
|
+
name: string;
|
|
421
|
+
/** OAuth 2.0 token for the current user. */
|
|
422
|
+
oauth_token?: string;
|
|
423
|
+
/** Returns response with indentations and line breaks. */
|
|
424
|
+
prettyPrint?: boolean;
|
|
425
|
+
/** 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. */
|
|
426
|
+
quotaUser?: string;
|
|
427
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
428
|
+
upload_protocol?: string;
|
|
429
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
430
|
+
uploadType?: string;
|
|
431
|
+
}): Request<Operation>;
|
|
432
|
+
}
|
|
376
433
|
interface TasksResource {
|
|
434
|
+
/** Creates a batch of tasks and adds them to a queue. This call is not atomic. All tasks must be for the same queue. A maximum of 100 tasks can be created in a single batch. */
|
|
435
|
+
batchCreate(request: {
|
|
436
|
+
/** V1 error format. */
|
|
437
|
+
'$.xgafv'?: '1' | '2';
|
|
438
|
+
/** OAuth access token. */
|
|
439
|
+
access_token?: string;
|
|
440
|
+
/** Data format for response. */
|
|
441
|
+
alt?: 'json' | 'media' | 'proto';
|
|
442
|
+
/** JSONP */
|
|
443
|
+
callback?: string;
|
|
444
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
445
|
+
fields?: string;
|
|
446
|
+
/** 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. */
|
|
447
|
+
key?: string;
|
|
448
|
+
/** OAuth 2.0 token for the current user. */
|
|
449
|
+
oauth_token?: string;
|
|
450
|
+
/** Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue must already exist. */
|
|
451
|
+
parent: string;
|
|
452
|
+
/** Returns response with indentations and line breaks. */
|
|
453
|
+
prettyPrint?: boolean;
|
|
454
|
+
/** 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. */
|
|
455
|
+
quotaUser?: string;
|
|
456
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
457
|
+
upload_protocol?: string;
|
|
458
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
459
|
+
uploadType?: string;
|
|
460
|
+
/** Request body */
|
|
461
|
+
resource: BatchCreateTasksRequest;
|
|
462
|
+
}): Request<Operation>;
|
|
463
|
+
batchCreate(
|
|
464
|
+
request: {
|
|
465
|
+
/** V1 error format. */
|
|
466
|
+
'$.xgafv'?: '1' | '2';
|
|
467
|
+
/** OAuth access token. */
|
|
468
|
+
access_token?: string;
|
|
469
|
+
/** Data format for response. */
|
|
470
|
+
alt?: 'json' | 'media' | 'proto';
|
|
471
|
+
/** JSONP */
|
|
472
|
+
callback?: string;
|
|
473
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
474
|
+
fields?: string;
|
|
475
|
+
/** 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. */
|
|
476
|
+
key?: string;
|
|
477
|
+
/** OAuth 2.0 token for the current user. */
|
|
478
|
+
oauth_token?: string;
|
|
479
|
+
/** Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue must already exist. */
|
|
480
|
+
parent: string;
|
|
481
|
+
/** Returns response with indentations and line breaks. */
|
|
482
|
+
prettyPrint?: boolean;
|
|
483
|
+
/** 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
|
+
quotaUser?: string;
|
|
485
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
486
|
+
upload_protocol?: string;
|
|
487
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
488
|
+
uploadType?: string;
|
|
489
|
+
},
|
|
490
|
+
body: BatchCreateTasksRequest,
|
|
491
|
+
): Request<Operation>;
|
|
492
|
+
/** Deletes a batch of tasks. This is a non-atomic operation: if deletion fails for some tasks, it can still succeed for others. The metadata field of google.longrunning.Operation contains details of failed deletions. A maximum of 1000 tasks can be deleted in a batch. */
|
|
493
|
+
batchDelete(request: {
|
|
494
|
+
/** V1 error format. */
|
|
495
|
+
'$.xgafv'?: '1' | '2';
|
|
496
|
+
/** OAuth access token. */
|
|
497
|
+
access_token?: string;
|
|
498
|
+
/** Data format for response. */
|
|
499
|
+
alt?: 'json' | 'media' | 'proto';
|
|
500
|
+
/** JSONP */
|
|
501
|
+
callback?: string;
|
|
502
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
503
|
+
fields?: string;
|
|
504
|
+
/** 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. */
|
|
505
|
+
key?: string;
|
|
506
|
+
/** OAuth 2.0 token for the current user. */
|
|
507
|
+
oauth_token?: string;
|
|
508
|
+
/** Required. The queue name. For example: Format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` */
|
|
509
|
+
parent: string;
|
|
510
|
+
/** Returns response with indentations and line breaks. */
|
|
511
|
+
prettyPrint?: boolean;
|
|
512
|
+
/** 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. */
|
|
513
|
+
quotaUser?: string;
|
|
514
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
515
|
+
upload_protocol?: string;
|
|
516
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
517
|
+
uploadType?: string;
|
|
518
|
+
/** Request body */
|
|
519
|
+
resource: BatchDeleteTasksRequest;
|
|
520
|
+
}): Request<Operation>;
|
|
521
|
+
batchDelete(
|
|
522
|
+
request: {
|
|
523
|
+
/** V1 error format. */
|
|
524
|
+
'$.xgafv'?: '1' | '2';
|
|
525
|
+
/** OAuth access token. */
|
|
526
|
+
access_token?: string;
|
|
527
|
+
/** Data format for response. */
|
|
528
|
+
alt?: 'json' | 'media' | 'proto';
|
|
529
|
+
/** JSONP */
|
|
530
|
+
callback?: string;
|
|
531
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
532
|
+
fields?: string;
|
|
533
|
+
/** 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. */
|
|
534
|
+
key?: string;
|
|
535
|
+
/** OAuth 2.0 token for the current user. */
|
|
536
|
+
oauth_token?: string;
|
|
537
|
+
/** Required. The queue name. For example: Format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` */
|
|
538
|
+
parent: string;
|
|
539
|
+
/** Returns response with indentations and line breaks. */
|
|
540
|
+
prettyPrint?: boolean;
|
|
541
|
+
/** 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. */
|
|
542
|
+
quotaUser?: string;
|
|
543
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
544
|
+
upload_protocol?: string;
|
|
545
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
546
|
+
uploadType?: string;
|
|
547
|
+
},
|
|
548
|
+
body: BatchDeleteTasksRequest,
|
|
549
|
+
): Request<Operation>;
|
|
377
550
|
/** 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. */
|
|
378
551
|
buffer(request: {
|
|
379
552
|
/** V1 error format. */
|
|
@@ -1272,6 +1445,7 @@ declare namespace gapi.client {
|
|
|
1272
1445
|
},
|
|
1273
1446
|
body: CmekConfig,
|
|
1274
1447
|
): Request<CmekConfig>;
|
|
1448
|
+
operations: OperationsResource;
|
|
1275
1449
|
queues: QueuesResource;
|
|
1276
1450
|
}
|
|
1277
1451
|
interface ProjectsResource {
|