@maxim_mazurok/gapi.client.cloudtasks-v2 0.0.20230929 → 0.0.20231027

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://cloudtasks.googleapis.com/$discovery/rest?version=v2
-// Revision: 20230929
+// Revision: 20231027
 
 /// <reference types="gapi.client" />
 
@@ -139,6 +139,16 @@ declare namespace gapi.client {
             role?:
                 string;
         }
+        interface BufferTaskRequest {
+            /** Optional. Body of the HTTP request. The body can take any generic value. The value is written to the HttpRequest of the [Task]. */
+            body?:
+                HttpBody;
+        }
+        interface BufferTaskResponse {
+            /** The created task. */
+            task?:
+                Task;
+        }
         interface CmekConfig {
             /**
              * Resource name of the Cloud KMS key, of the form `projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID`, that will be used to encrypt the Queues & Tasks
@@ -205,6 +215,30 @@ declare namespace gapi.client {
             requestedPolicyVersion?:
                 number;
         }
+        interface Header {
+            /** The Key of the header. */
+            key?:
+                string;
+            /** The Value of the header. */
+            value?:
+                string;
+        }
+        interface HeaderOverride {
+            /** header embodying a key and a value. */
+            header?:
+                Header;
+        }
+        interface HttpBody {
+            /** The HTTP Content-Type header value specifying the content type of the body. */
+            contentType?:
+                string;
+            /** The HTTP request/response body as raw binary. */
+            data?:
+                string;
+            /** Application specific response metadata. Must be set in the first response for streaming APIs. */
+            extensions?:
+                Array<{ [P in string]: any }>;
+        }
         interface HttpRequest {
             /** HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a task with an incompatible HttpMethod. */
             body?:
@@ -242,6 +276,40 @@ declare namespace gapi.client {
             url?:
                 string;
         }
+        interface HttpTarget {
+            /**
+             * 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.
+             */
+            headerOverrides?:
+                HeaderOverride[];
+            /**
+             * 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.
+             */
+            httpMethod?:
+                string;
+            /**
+             * If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as the `Authorization` header in the HTTP request. This type
+             * of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.
+             */
+            oauthToken?:
+                OAuthToken;
+            /**
+             * 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.
+             */
+            oidcToken?:
+                OidcToken;
+            /** URI override. When specified, overrides the execution URI for all the tasks in the queue. */
+            uriOverride?:
+                UriOverride;
+        }
         interface ListLocationsResponse {
             /** A list of locations that matches the specified filter in the request. */
             locations?:
@@ -311,6 +379,11 @@ declare namespace gapi.client {
             serviceAccountEmail?:
                 string;
         }
+        interface PathOverride {
+            /** The URI path (e.g., /users/1234). Default is an empty string. */
+            path?:
+                string;
+        }
         // tslint:disable-next-line:no-empty-interface
         interface PauseQueueRequest {
         }
@@ -346,6 +419,11 @@ declare namespace gapi.client {
         // tslint:disable-next-line:no-empty-interface
         interface PurgeQueueRequest {
         }
+        interface QueryOverride {
+            /** The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty string. */
+            queryParams?:
+                string;
+        }
         interface Queue {
             /**
              * Overrides for task-level app_engine_routing. These settings apply only to App Engine tasks in this queue. Http tasks are not affected. If set, `app_engine_routing_override` is used
@@ -353,6 +431,9 @@ declare namespace gapi.client {
              */
             appEngineRoutingOverride?:
                 AppEngineRouting;
+            /** Modifies HTTP target for HTTP tasks. */
+            httpTarget?:
+                HttpTarget;
             /**
              * Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format:
              * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more
@@ -576,7 +657,124 @@ declare namespace gapi.client {
             permissions?:
                 string[];
         }
+        interface UriOverride {
+            /**
+             * Host override. When specified, replaces the host part of the task URL. For example, if the task URL is "https://www.google.com," and host value is set to "example.net", the
+             * overridden URI will be changed to "https://example.net." Host value cannot be an empty string (INVALID_ARGUMENT).
+             */
+            host?:
+                string;
+            /** URI path. When specified, replaces the existing path of the task URL. Setting the path value to an empty string clears the URI path segment. */
+            pathOverride?:
+                PathOverride;
+            /**
+             * Port override. When specified, replaces the port part of the task URI. For instance, for a URI http://www.google.com/foo and port=123, the overridden URI becomes
+             * http://www.google.com:123/foo. Note that the port value must be a positive integer. Setting the port to 0 (Zero) clears the URI port.
+             */
+            port?:
+                string;
+            /** 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. */
+            queryOverride?:
+                QueryOverride;
+            /** Scheme override. When specified, the task URI scheme is replaced by the provided value (HTTP or HTTPS). */
+            scheme?:
+                string;
+            /** URI Override Enforce Mode When specified, determines the Target UriOverride mode. If not specified, it defaults to ALWAYS. */
+            uriOverrideEnforceMode?:
+                string;
+        }
         interface TasksResource {
+            /**
+             * 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.
+             */
+            buffer(request: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** 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. */
+                key?:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** Required. The parent queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue must already exist. */
+                queue:
+                    string;
+                /** 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. */
+                quotaUser?:
+                    string;
+                /** Optional. Task ID for the task being created. If not provided, Cloud Tasks generates an ID for the task. */
+                taskId:
+                    string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+                /** Request body */
+                resource:
+                    BufferTaskRequest;
+            }): Request<BufferTaskResponse>;
+            buffer(request: {
+                /** V1 error format. */
+                "$.xgafv"?:
+                    string;
+                /** OAuth access token. */
+                access_token?:
+                    string;
+                /** Data format for response. */
+                alt?:
+                    string;
+                /** JSONP */
+                callback?:
+                    string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?:
+                    string;
+                /** 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. */
+                key?:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** Required. The parent queue name. For example: projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue must already exist. */
+                queue:
+                    string;
+                /** 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. */
+                quotaUser?:
+                    string;
+                /** Optional. Task ID for the task being created. If not provided, Cloud Tasks generates an ID for the task. */
+                taskId:
+                    string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+            },
+            body: BufferTaskRequest): Request<BufferTaskResponse>;
             /** 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. */
             create(request: {
                 /** V1 error format. */
@@ -985,8 +1183,11 @@ declare namespace gapi.client {
             },
             body: Queue): Request<Queue>;
             /**
-             * Deletes a queue. This command will delete the queue even if it has tasks in it. Note: If you delete a queue, a queue with the same name can't be created for 7 days. 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
+             * 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.
              */
             delete(request?: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.cloudtasks-v2",
-  "version": "0.0.20230929",
+  "version": "0.0.20231027",
   "description": "TypeScript typings for Cloud Tasks API v2",
   "license": "MIT",
   "author": {

package/tests.ts

@@ -3,7 +3,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 
-// Revision: 20230929
+// Revision: 20231027
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -69,6 +69,37 @@ gapi.load('client', async () => {
                 service: "Test string",
                 version: "Test string",
             },
+            httpTarget: {
+                headerOverrides: [
+                    {
+                        header: {
+                            key: "Test string",
+                            value: "Test string",
+                        },
+                    }
+                ],
+                httpMethod: "Test string",
+                oauthToken: {
+                    scope: "Test string",
+                    serviceAccountEmail: "Test string",
+                },
+                oidcToken: {
+                    audience: "Test string",
+                    serviceAccountEmail: "Test string",
+                },
+                uriOverride: {
+                    host: "Test string",
+                    pathOverride: {
+                        path: "Test string",
+                    },
+                    port: "Test string",
+                    queryOverride: {
+                        queryParams: "Test string",
+                    },
+                    scheme: "Test string",
+                    uriOverrideEnforceMode: "Test string",
+                },
+            },
             name: "Test string",
             purgeTime: "Test string",
             rateLimits: {
@@ -89,8 +120,11 @@ gapi.load('client', async () => {
             state: "Test string",
         });
         /**
-         * Deletes a queue. This command will delete the queue even if it has tasks in it. Note: If you delete a queue, a queue with the same name can't be created for 7 days. 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
+         * 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.
          */
         await gapi.client.cloudtasks.projects.locations.queues.delete({
@@ -134,6 +168,37 @@ gapi.load('client', async () => {
                 service: "Test string",
                 version: "Test string",
             },
+            httpTarget: {
+                headerOverrides: [
+                    {
+                        header: {
+                            key: "Test string",
+                            value: "Test string",
+                        },
+                    }
+                ],
+                httpMethod: "Test string",
+                oauthToken: {
+                    scope: "Test string",
+                    serviceAccountEmail: "Test string",
+                },
+                oidcToken: {
+                    audience: "Test string",
+                    serviceAccountEmail: "Test string",
+                },
+                uriOverride: {
+                    host: "Test string",
+                    pathOverride: {
+                        path: "Test string",
+                    },
+                    port: "Test string",
+                    queryOverride: {
+                        queryParams: "Test string",
+                    },
+                    scheme: "Test string",
+                    uriOverrideEnforceMode: "Test string",
+                },
+            },
             name: "Test string",
             purgeTime: "Test string",
             rateLimits: {
@@ -215,6 +280,25 @@ gapi.load('client', async () => {
                 "Test string"
             ],
         });
+        /**
+         * 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.
+         */
+        await gapi.client.cloudtasks.projects.locations.queues.tasks.buffer({
+            queue: "Test string",
+            taskId: "Test string",
+        }, {
+            body: {
+                contentType: "Test string",
+                data: "Test string",
+                extensions: [
+                    {
+                        A: 42
+                    }
+                ],
+            },
+        });
         /** 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. */
         await gapi.client.cloudtasks.projects.locations.queues.tasks.create({
             parent: "Test string",