@maxim_mazurok/gapi.client.cloudtasks-v2beta2 0.0.20250103 → 0.0.20250124
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 +20 -20
- package/package.json +1 -1
- package/readme.md +2 -2
package/index.d.ts
CHANGED
|
@@ -9,14 +9,14 @@
|
|
|
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=v2beta2
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20250124
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
16
16
|
declare namespace gapi.client {
|
|
17
17
|
/** Load Cloud Tasks API v2beta2 */
|
|
18
18
|
function load(
|
|
19
|
-
urlOrObject: 'https://cloudtasks.googleapis.com/$discovery/rest?version=v2beta2'
|
|
19
|
+
urlOrObject: 'https://cloudtasks.googleapis.com/$discovery/rest?version=v2beta2',
|
|
20
20
|
): Promise<void>;
|
|
21
21
|
/** @deprecated Please load APIs with discovery documents. */
|
|
22
22
|
function load(name: 'cloudtasks', version: 'v2beta2'): Promise<void>;
|
|
@@ -24,7 +24,7 @@ declare namespace gapi.client {
|
|
|
24
24
|
function load(
|
|
25
25
|
name: 'cloudtasks',
|
|
26
26
|
version: 'v2beta2',
|
|
27
|
-
callback: () => any
|
|
27
|
+
callback: () => any,
|
|
28
28
|
): void;
|
|
29
29
|
|
|
30
30
|
namespace cloudtasks {
|
|
@@ -436,7 +436,7 @@ declare namespace gapi.client {
|
|
|
436
436
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
437
437
|
uploadType?: string;
|
|
438
438
|
},
|
|
439
|
-
body: HttpBody
|
|
439
|
+
body: HttpBody,
|
|
440
440
|
): Request<{}>;
|
|
441
441
|
}
|
|
442
442
|
interface ApiResource {
|
|
@@ -499,7 +499,7 @@ declare namespace gapi.client {
|
|
|
499
499
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
500
500
|
uploadType?: string;
|
|
501
501
|
},
|
|
502
|
-
body: AcknowledgeTaskRequest
|
|
502
|
+
body: AcknowledgeTaskRequest,
|
|
503
503
|
): Request<{}>;
|
|
504
504
|
/** 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. */
|
|
505
505
|
buffer(request: {
|
|
@@ -561,7 +561,7 @@ declare namespace gapi.client {
|
|
|
561
561
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
562
562
|
uploadType?: string;
|
|
563
563
|
},
|
|
564
|
-
body: BufferTaskRequest
|
|
564
|
+
body: BufferTaskRequest,
|
|
565
565
|
): Request<BufferTaskResponse>;
|
|
566
566
|
/** Cancel a pull task's lease. The worker can use this method to cancel a task's lease by setting its schedule_time to now. This will make the task available to be leased to the next caller of LeaseTasks. */
|
|
567
567
|
cancelLease(request: {
|
|
@@ -619,7 +619,7 @@ declare namespace gapi.client {
|
|
|
619
619
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
620
620
|
uploadType?: string;
|
|
621
621
|
},
|
|
622
|
-
body: CancelLeaseRequest
|
|
622
|
+
body: CancelLeaseRequest,
|
|
623
623
|
): Request<Task>;
|
|
624
624
|
/** Creates a task and adds it to a queue. Tasks cannot be updated after creation; there is no UpdateTask command. * For App Engine queues, the maximum task size is 100KB. * For pull queues, the maximum task size is 1MB. */
|
|
625
625
|
create(request: {
|
|
@@ -677,7 +677,7 @@ declare namespace gapi.client {
|
|
|
677
677
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
678
678
|
uploadType?: string;
|
|
679
679
|
},
|
|
680
|
-
body: CreateTaskRequest
|
|
680
|
+
body: CreateTaskRequest,
|
|
681
681
|
): Request<Task>;
|
|
682
682
|
/** Deletes a task. A task can be deleted if it is scheduled or dispatched. A task cannot be deleted if it has completed successfully or permanently failed. */
|
|
683
683
|
delete(request?: {
|
|
@@ -791,7 +791,7 @@ declare namespace gapi.client {
|
|
|
791
791
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
792
792
|
uploadType?: string;
|
|
793
793
|
},
|
|
794
|
-
body: LeaseTasksRequest
|
|
794
|
+
body: LeaseTasksRequest,
|
|
795
795
|
): Request<LeaseTasksResponse>;
|
|
796
796
|
/** 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. */
|
|
797
797
|
list(request?: {
|
|
@@ -882,7 +882,7 @@ declare namespace gapi.client {
|
|
|
882
882
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
883
883
|
uploadType?: string;
|
|
884
884
|
},
|
|
885
|
-
body: RenewLeaseRequest
|
|
885
|
+
body: RenewLeaseRequest,
|
|
886
886
|
): Request<Task>;
|
|
887
887
|
/** 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. RunTask cannot be called on a pull task. */
|
|
888
888
|
run(request: {
|
|
@@ -940,7 +940,7 @@ declare namespace gapi.client {
|
|
|
940
940
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
941
941
|
uploadType?: string;
|
|
942
942
|
},
|
|
943
|
-
body: RunTaskRequest
|
|
943
|
+
body: RunTaskRequest,
|
|
944
944
|
): Request<Task>;
|
|
945
945
|
}
|
|
946
946
|
interface QueuesResource {
|
|
@@ -1000,7 +1000,7 @@ declare namespace gapi.client {
|
|
|
1000
1000
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1001
1001
|
uploadType?: string;
|
|
1002
1002
|
},
|
|
1003
|
-
body: Queue
|
|
1003
|
+
body: Queue,
|
|
1004
1004
|
): Request<Queue>;
|
|
1005
1005
|
/** 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. */
|
|
1006
1006
|
delete(request?: {
|
|
@@ -1086,7 +1086,7 @@ declare namespace gapi.client {
|
|
|
1086
1086
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1087
1087
|
uploadType?: string;
|
|
1088
1088
|
},
|
|
1089
|
-
body: GetIamPolicyRequest
|
|
1089
|
+
body: GetIamPolicyRequest,
|
|
1090
1090
|
): Request<Policy>;
|
|
1091
1091
|
/** Lists queues. Queues are returned in lexicographical order. */
|
|
1092
1092
|
list(request?: {
|
|
@@ -1183,7 +1183,7 @@ declare namespace gapi.client {
|
|
|
1183
1183
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1184
1184
|
uploadType?: string;
|
|
1185
1185
|
},
|
|
1186
|
-
body: Queue
|
|
1186
|
+
body: Queue,
|
|
1187
1187
|
): Request<Queue>;
|
|
1188
1188
|
/** 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. */
|
|
1189
1189
|
pause(request: {
|
|
@@ -1241,7 +1241,7 @@ declare namespace gapi.client {
|
|
|
1241
1241
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1242
1242
|
uploadType?: string;
|
|
1243
1243
|
},
|
|
1244
|
-
body: PauseQueueRequest
|
|
1244
|
+
body: PauseQueueRequest,
|
|
1245
1245
|
): Request<Queue>;
|
|
1246
1246
|
/** 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. */
|
|
1247
1247
|
purge(request: {
|
|
@@ -1299,7 +1299,7 @@ declare namespace gapi.client {
|
|
|
1299
1299
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1300
1300
|
uploadType?: string;
|
|
1301
1301
|
},
|
|
1302
|
-
body: PurgeQueueRequest
|
|
1302
|
+
body: PurgeQueueRequest,
|
|
1303
1303
|
): Request<Queue>;
|
|
1304
1304
|
/** 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). */
|
|
1305
1305
|
resume(request: {
|
|
@@ -1357,7 +1357,7 @@ declare namespace gapi.client {
|
|
|
1357
1357
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1358
1358
|
uploadType?: string;
|
|
1359
1359
|
},
|
|
1360
|
-
body: ResumeQueueRequest
|
|
1360
|
+
body: ResumeQueueRequest,
|
|
1361
1361
|
): Request<Queue>;
|
|
1362
1362
|
/** Sets the access control policy for a Queue. Replaces any existing policy. Note: The Cloud Console does not check queue-level IAM permissions yet. Project-level permissions are required to use the Cloud Console. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission on the specified resource parent: * `cloudtasks.queues.setIamPolicy` */
|
|
1363
1363
|
setIamPolicy(
|
|
@@ -1387,7 +1387,7 @@ declare namespace gapi.client {
|
|
|
1387
1387
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1388
1388
|
uploadType?: string;
|
|
1389
1389
|
},
|
|
1390
|
-
body: SetIamPolicyRequest
|
|
1390
|
+
body: SetIamPolicyRequest,
|
|
1391
1391
|
): Request<Policy>;
|
|
1392
1392
|
/** Returns permissions that a caller has on a Queue. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. */
|
|
1393
1393
|
testIamPermissions(
|
|
@@ -1417,7 +1417,7 @@ declare namespace gapi.client {
|
|
|
1417
1417
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1418
1418
|
uploadType?: string;
|
|
1419
1419
|
},
|
|
1420
|
-
body: TestIamPermissionsRequest
|
|
1420
|
+
body: TestIamPermissionsRequest,
|
|
1421
1421
|
): Request<TestIamPermissionsResponse>;
|
|
1422
1422
|
tasks: TasksResource;
|
|
1423
1423
|
}
|
|
@@ -1569,7 +1569,7 @@ declare namespace gapi.client {
|
|
|
1569
1569
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1570
1570
|
uploadType?: string;
|
|
1571
1571
|
},
|
|
1572
|
-
body: CmekConfig
|
|
1572
|
+
body: CmekConfig,
|
|
1573
1573
|
): Request<CmekConfig>;
|
|
1574
1574
|
queues: QueuesResource;
|
|
1575
1575
|
}
|
package/package.json
CHANGED
package/readme.md
CHANGED