@maxim_mazurok/gapi.client.cloudtasks-v2beta2 0.3.20260707 → 0.3.20260714

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +175 -1
  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=v2beta2
12
- // Revision: 20260707
12
+ // Revision: 20260714
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -76,6 +76,18 @@ declare namespace gapi.client {
76
76
  /** Output only. The time that this attempt was scheduled. `schedule_time` will be truncated to the nearest microsecond. */
77
77
  scheduleTime?: string;
78
78
  }
79
+ interface BatchCreateTasksRequest {
80
+ /** 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. */
81
+ requestId?: string;
82
+ /** 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. */
83
+ requests?: CreateTaskRequest[];
84
+ }
85
+ interface BatchDeleteTasksRequest {
86
+ /** 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` */
87
+ names?: string[];
88
+ /** 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. */
89
+ requestId?: string;
90
+ }
79
91
  interface Binding {
80
92
  /** 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). */
81
93
  condition?: Expr;
@@ -105,6 +117,8 @@ declare namespace gapi.client {
105
117
  name?: string;
106
118
  }
107
119
  interface CreateTaskRequest {
120
+ /** Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue must already exist. */
121
+ parent?: string;
108
122
  /** 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. */
109
123
  responseView?: 'VIEW_UNSPECIFIED' | 'BASIC' | 'FULL';
110
124
  /** 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 completed 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. */
@@ -245,6 +259,18 @@ declare namespace gapi.client {
245
259
  /** [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. */
246
260
  serviceAccountEmail?: string;
247
261
  }
262
+ interface Operation {
263
+ /** 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. */
264
+ done?: boolean;
265
+ /** The error result of the operation in case of failure or cancellation. */
266
+ error?: Status;
267
+ /** 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. */
268
+ metadata?: {[P in string]: any};
269
+ /** 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}`. */
270
+ name?: string;
271
+ /** 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`. */
272
+ response?: {[P in string]: any};
273
+ }
248
274
  interface PathOverride {
249
275
  /** The URI path (e.g., /users/1234). Default is an empty string. */
250
276
  path?: string;
@@ -364,6 +390,8 @@ declare namespace gapi.client {
364
390
  name?: string;
365
391
  /** LeaseTasks to process the task. Can be set only if pull_target is set on the queue. A pull task is a task that has PullMessage set. */
366
392
  pullMessage?: PullMessage;
393
+ /** Optional. Specifies the task-level retry config. If present, this overrides the queue-level retry config for this task. */
394
+ retryConfig?: RetryConfig;
367
395
  /** The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. For pull queues, this is the time when the task is available to be leased; if a task is currently leased, this is the time when the current lease expires, that is, the time that the task was leased plus the lease_duration. `schedule_time` will be truncated to the nearest microsecond. */
368
396
  scheduleTime?: string;
369
397
  /** Output only. The task status. */
@@ -467,6 +495,35 @@ declare namespace gapi.client {
467
495
  interface ApiResource {
468
496
  queue: QueueResource;
469
497
  }
498
+ interface OperationsResource {
499
+ /** 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. */
500
+ get(request?: {
501
+ /** V1 error format. */
502
+ '$.xgafv'?: '1' | '2';
503
+ /** OAuth access token. */
504
+ access_token?: string;
505
+ /** Data format for response. */
506
+ alt?: 'json' | 'media' | 'proto';
507
+ /** JSONP */
508
+ callback?: string;
509
+ /** Selector specifying which fields to include in a partial response. */
510
+ fields?: string;
511
+ /** 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. */
512
+ key?: string;
513
+ /** The name of the operation resource. */
514
+ name: string;
515
+ /** OAuth 2.0 token for the current user. */
516
+ oauth_token?: string;
517
+ /** Returns response with indentations and line breaks. */
518
+ prettyPrint?: boolean;
519
+ /** 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
+ quotaUser?: string;
521
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
522
+ upload_protocol?: string;
523
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
524
+ uploadType?: string;
525
+ }): Request<Operation>;
526
+ }
470
527
  interface TasksResource {
471
528
  /** Acknowledges a pull task. The worker, that is, the entity that leased this task must call this method to indicate that the work associated with the task has finished. The worker must acknowledge a task within the lease_duration or the lease will expire and the task will become available to be leased again. After the task is acknowledged, it will not be returned by a later LeaseTasks, GetTask, or ListTasks. */
472
529
  acknowledge(request: {
@@ -526,6 +583,122 @@ declare namespace gapi.client {
526
583
  },
527
584
  body: AcknowledgeTaskRequest,
528
585
  ): Request<{}>;
586
+ /** 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. */
587
+ batchCreate(request: {
588
+ /** V1 error format. */
589
+ '$.xgafv'?: '1' | '2';
590
+ /** OAuth access token. */
591
+ access_token?: string;
592
+ /** Data format for response. */
593
+ alt?: 'json' | 'media' | 'proto';
594
+ /** JSONP */
595
+ callback?: string;
596
+ /** Selector specifying which fields to include in a partial response. */
597
+ fields?: string;
598
+ /** 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. */
599
+ key?: string;
600
+ /** OAuth 2.0 token for the current user. */
601
+ oauth_token?: string;
602
+ /** Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue must already exist. */
603
+ parent: string;
604
+ /** Returns response with indentations and line breaks. */
605
+ prettyPrint?: boolean;
606
+ /** 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. */
607
+ quotaUser?: string;
608
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
609
+ upload_protocol?: string;
610
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
611
+ uploadType?: string;
612
+ /** Request body */
613
+ resource: BatchCreateTasksRequest;
614
+ }): Request<Operation>;
615
+ batchCreate(
616
+ request: {
617
+ /** V1 error format. */
618
+ '$.xgafv'?: '1' | '2';
619
+ /** OAuth access token. */
620
+ access_token?: string;
621
+ /** Data format for response. */
622
+ alt?: 'json' | 'media' | 'proto';
623
+ /** JSONP */
624
+ callback?: string;
625
+ /** Selector specifying which fields to include in a partial response. */
626
+ fields?: string;
627
+ /** 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. */
628
+ key?: string;
629
+ /** OAuth 2.0 token for the current user. */
630
+ oauth_token?: string;
631
+ /** Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue must already exist. */
632
+ parent: string;
633
+ /** Returns response with indentations and line breaks. */
634
+ prettyPrint?: boolean;
635
+ /** 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. */
636
+ quotaUser?: string;
637
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
638
+ upload_protocol?: string;
639
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
640
+ uploadType?: string;
641
+ },
642
+ body: BatchCreateTasksRequest,
643
+ ): Request<Operation>;
644
+ /** 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. */
645
+ batchDelete(request: {
646
+ /** V1 error format. */
647
+ '$.xgafv'?: '1' | '2';
648
+ /** OAuth access token. */
649
+ access_token?: string;
650
+ /** Data format for response. */
651
+ alt?: 'json' | 'media' | 'proto';
652
+ /** JSONP */
653
+ callback?: string;
654
+ /** Selector specifying which fields to include in a partial response. */
655
+ fields?: string;
656
+ /** 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. */
657
+ key?: string;
658
+ /** OAuth 2.0 token for the current user. */
659
+ oauth_token?: string;
660
+ /** Required. The queue name. For example: Format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` */
661
+ parent: string;
662
+ /** Returns response with indentations and line breaks. */
663
+ prettyPrint?: boolean;
664
+ /** 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. */
665
+ quotaUser?: string;
666
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
667
+ upload_protocol?: string;
668
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
669
+ uploadType?: string;
670
+ /** Request body */
671
+ resource: BatchDeleteTasksRequest;
672
+ }): Request<Operation>;
673
+ batchDelete(
674
+ request: {
675
+ /** V1 error format. */
676
+ '$.xgafv'?: '1' | '2';
677
+ /** OAuth access token. */
678
+ access_token?: string;
679
+ /** Data format for response. */
680
+ alt?: 'json' | 'media' | 'proto';
681
+ /** JSONP */
682
+ callback?: string;
683
+ /** Selector specifying which fields to include in a partial response. */
684
+ fields?: string;
685
+ /** 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. */
686
+ key?: string;
687
+ /** OAuth 2.0 token for the current user. */
688
+ oauth_token?: string;
689
+ /** Required. The queue name. For example: Format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` */
690
+ parent: string;
691
+ /** Returns response with indentations and line breaks. */
692
+ prettyPrint?: boolean;
693
+ /** 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. */
694
+ quotaUser?: string;
695
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
696
+ upload_protocol?: string;
697
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
698
+ uploadType?: string;
699
+ },
700
+ body: BatchDeleteTasksRequest,
701
+ ): Request<Operation>;
529
702
  /** 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. */
530
703
  buffer(request: {
531
704
  /** V1 error format. */
@@ -1598,6 +1771,7 @@ declare namespace gapi.client {
1598
1771
  },
1599
1772
  body: CmekConfig,
1600
1773
  ): Request<CmekConfig>;
1774
+ operations: OperationsResource;
1601
1775
  queues: QueuesResource;
1602
1776
  }
1603
1777
  interface ProjectsResource {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.cloudtasks-v2beta2",
3
- "version": "0.3.20260707",
3
+ "version": "0.3.20260714",
4
4
  "description": "TypeScript typings for Cloud Tasks API v2beta2",
5
5
  "repository": {
6
6
  "type": "git",