@maxim_mazurok/gapi.client.workflowexecutions-v1 0.0.20231003 → 0.0.20231017

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://workflowexecutions.googleapis.com/$discovery/rest?version=v1
-// Revision: 20231003
+// Revision: 20231017
 
 /// <reference types="gapi.client" />
 
@@ -50,6 +50,11 @@ declare namespace gapi.client {
             stackTrace?:
                 StackTrace;
         }
+        interface Exception {
+            /** Error message represented as a JSON string. */
+            payload?:
+                string;
+        }
         interface Execution {
             /**
              * Input parameters of the execution represented as a JSON string. The size limit is 32KB. *Note*: If you are using the REST API directly to run your workflow, you must escape any JSON
@@ -122,6 +127,34 @@ declare namespace gapi.client {
             nextPageToken?:
                 string;
         }
+        interface ListStepEntriesResponse {
+            /**
+             * A token to retrieve next page of results. Pass this value in the ListStepEntriesRequest.page_token field in the subsequent call to `ListStepEntries` method to retrieve the next page
+             * of results.
+             */
+            nextPageToken?:
+                string;
+            /** The list of entries. */
+            stepEntries?:
+                StepEntry[];
+            /** Indicates the total number of StepEntries that matched the request filter. For running executions, this number shows the number of StepEntries that are executed thus far. */
+            totalSize?:
+                number;
+        }
+        interface NavigationInfo {
+            /** Step entries that can be reached by "stepping into" e.g. a subworkflow call. */
+            children?:
+                string[];
+            /** The index of the next step in the current workflow, if any. */
+            next?:
+                string;
+            /** The step entry, if any, that can be reached by "stepping out" of the current workflow being executed. */
+            parent?:
+                string;
+            /** The index of the previous step in the current workflow, if any. */
+            previous?:
+                string;
+        }
         interface Position {
             /** The source code column position (of the line) the current instruction was generated from. */
             column?:
@@ -198,6 +231,55 @@ declare namespace gapi.client {
             step?:
                 string;
         }
+        interface StepEntry {
+            /** Output only. The creation time of the step entry. */
+            createTime?:
+                string;
+            /** Output only. The numeric ID of this step entry, used for navigation. */
+            entryId?:
+                string;
+            /** Output only. The exception thrown by the step entry. */
+            exception?:
+                Exception;
+            /**
+             * Output only. The full resource name of the step entry. Each step entry has a unique entry ID, which is a monotonically increasing counter. Step entry names have the format:
+             * `projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}/stepEntries/{step_entry}`.
+             */
+            name?:
+                string;
+            /** Output only. The NavigationInfo associated to this step. */
+            navigationInfo?:
+                NavigationInfo;
+            /** Output only. The name of the routine this step entry belongs to. A routine name is the subworkflow name defined in the YAML source code. The top level routine name is `main`. */
+            routine?:
+                string;
+            /** Output only. The state of the step entry. */
+            state?:
+                string;
+            /** Output only. The name of the step this step entry belongs to. */
+            step?:
+                string;
+            /** Output only. The StepEntryMetadata associated to this step. */
+            stepEntryMetadata?:
+                StepEntryMetadata;
+            /** Output only. The type of the step this step entry belongs to. */
+            stepType?:
+                string;
+            /** Output only. The most recently updated time of the step entry. */
+            updateTime?:
+                string;
+        }
+        interface StepEntryMetadata {
+            /** Progress number represents the current state of the current progress. eg: A step entry represents the 4th iteration in a progress of PROGRESS_TYPE_FOR. */
+            progressNumber?:
+                string;
+            /** Progress type of this step entry. */
+            progressType?:
+                string;
+            /** Child thread id that this step entry belongs to. */
+            threadId?:
+                string;
+        }
         interface TriggerPubsubExecutionRequest {
             /**
              * The number of attempts that have been made to deliver this message. This is set by Pub/Sub for subscriptions that have the "dead letter" feature enabled, and hence provided here for
@@ -265,6 +347,114 @@ declare namespace gapi.client {
                     string;
             }): Request<ListCallbacksResponse>;
         }
+        interface StepEntriesResource {
+            /** Gets a step entry. */
+            get(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;
+                /** Required. The name of the step entry to retrieve. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}/stepEntries/{step_entry} */
+                name:
+                    string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** 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;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+            }): Request<StepEntry>;
+            /** Lists step entries for the corresponding workflow execution. Returned entries are ordered by their create_time. */
+            list(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;
+                /**
+                 * Optional. Filters applied to the `[StepEntries.ListStepEntries]` results. The following fields are supported for filtering: `entryId`, `createTime`, `updateTime`, `routine`,
+                 * `step`, `stepType`, `state`. For details, see AIP-160. For example, if you are using the Google APIs Explorer: `state="SUCCEEDED"` or `createTime>"2023-08-01" AND
+                 * state="FAILED"`
+                 */
+                filter?:
+                    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;
+                /**
+                 * Optional. Comma-separated list of fields that specify the ordering applied to the `[StepEntries.ListStepEntries]` results. By default the ordering is based on ascending
+                 * `entryId`. The following fields are supported for ordering: `entryId`, `createTime`, `updateTime`, `routine`, `step`, `stepType`, `state`. For details, see AIP-132.
+                 */
+                orderBy?:
+                    string;
+                /** Optional. Number of step entries to return per call. The default max is 1000. */
+                pageSize?:
+                    number;
+                /**
+                 * Optional. A page token, received from a previous `ListStepEntries` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to
+                 * `ListStepEntries` must match the call that provided the page token.
+                 */
+                pageToken?:
+                    string;
+                /** Required. Name of the workflow execution to list entries for. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}/stepEntries/ */
+                parent:
+                    string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?:
+                    boolean;
+                /** 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. The number of step entries to skip. It can be used with or without a pageToken. If used with a pageToken, then it indicates the number of step entries to skip starting
+                 * from the requested page.
+                 */
+                skip?:
+                    number;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?:
+                    string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?:
+                    string;
+            }): Request<ListStepEntriesResponse>;
+        }
         interface ExecutionsResource {
             /** Cancels an execution of the given name. */
             cancel(request: {
@@ -536,8 +726,9 @@ declare namespace gapi.client {
                 fields?:
                     string;
                 /**
-                 * Optional. Filters applied to the [Executions.ListExecutions] results. The following fields are supported for filtering: executionID, state, startTime, endTime, duration,
-                 * workflowRevisionID, stepName, and label.
+                 * Optional. Filters applied to the `[Executions.ListExecutions]` results. The following fields are supported for filtering: `executionId`, `state`, `startTime`, `endTime`,
+                 * `duration`, `workflowRevisionId`, `stepName`, and `label`. For details, see AIP-160. For example, if you are using the Google APIs Explorer: `state="SUCCEEDED"` or
+                 * `startTime>"2023-08-01" AND state="FAILED"`
                  */
                 filter?:
                     string;
@@ -548,8 +739,8 @@ declare namespace gapi.client {
                 oauth_token?:
                     string;
                 /**
-                 * Optional. The ordering applied to the [Executions.ListExecutions] results. By default the ordering is based on descending start time. The following fields are supported for
-                 * order by: executionID, startTime, endTime, duration, state, and workflowRevisionID.
+                 * Optional. Comma-separated list of fields that specify the ordering applied to the `[Executions.ListExecutions]` results. By default the ordering is based on descending
+                 * `startTime`. The following fields are supported for ordering: `executionId`, `state`, `startTime`, `endTime`, `duration`, and `workflowRevisionId`. For details, see AIP-132.
                  */
                 orderBy?:
                     string;
@@ -586,6 +777,8 @@ declare namespace gapi.client {
             }): Request<ListExecutionsResponse>;
             callbacks:
                 CallbacksResource;
+            stepEntries:
+                StepEntriesResource;
         }
         interface WorkflowsResource {
             /** Triggers a new execution using the latest revision of the given workflow by a Pub/Sub push notification. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.workflowexecutions-v1",
-  "version": "0.0.20231003",
+  "version": "0.0.20231017",
   "description": "TypeScript typings for Workflow Executions API v1",
   "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: 20231003
+// Revision: 20231017
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -124,5 +124,18 @@ gapi.load('client', async () => {
             pageToken: "Test string",
             parent: "Test string",
         });
+        /** Gets a step entry. */
+        await gapi.client.workflowexecutions.projects.locations.workflows.executions.stepEntries.get({
+            name: "Test string",
+        });
+        /** Lists step entries for the corresponding workflow execution. Returned entries are ordered by their create_time. */
+        await gapi.client.workflowexecutions.projects.locations.workflows.executions.stepEntries.list({
+            filter: "Test string",
+            orderBy: "Test string",
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+            skip: 42,
+        });
     }
 });