@googleapis/dataform 16.0.0 → 17.0.0

package/build/v1beta1.d.ts

@@ -375,7 +375,7 @@ export declare namespace dataform_v1beta1 {
      */
     export interface Schema$CompilationError {
         /**
-         * Output only. The identifier of the action where this error occurred, if available. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:CompilationError)
+         * Output only. The identifier of the action where this error occurred, if available.
          */
         actionTarget?: Schema$Target;
         /**
@@ -823,13 +823,17 @@ export declare namespace dataform_v1beta1 {
          */
         authenticationTokenSecretVersion?: string | null;
         /**
-         * Optional. The Git remote's default branch name. If not set `main` will be used.
+         * Optional. The Git remote's default branch name. If not set, `main` will be used.
          */
         defaultBranch?: string | null;
         /**
          * Output only. The Git remote's effective default branch name. This is the default branch name of the Git remote if it is set, otherwise it is `main`.
          */
         effectiveDefaultBranch?: string | null;
+        /**
+         * Optional. Resource name for the `GitRepositoryLink` used for machine credentials. Must be in the format `projects/x/locations/x/connections/x/gitRepositoryLinks/x`
+         */
+        gitRepositoryLink?: string | null;
         /**
          * Optional. Authentication fields for remote uris using SSH protocol.
          */
@@ -963,7 +967,7 @@ export declare namespace dataform_v1beta1 {
          */
         nextPageToken?: string | null;
         /**
-         * Locations which could not be reached. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListCompilationResultsResponse)
+         * Locations which could not be reached.
          */
         unreachable?: string[] | null;
     }
@@ -1010,7 +1014,7 @@ export declare namespace dataform_v1beta1 {
          */
         releaseConfigs?: Schema$ReleaseConfig[];
         /**
-         * Locations which could not be reached. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListReleaseConfigsResponse)
+         * Locations which could not be reached.
          */
         unreachable?: string[] | null;
     }
@@ -1641,7 +1645,7 @@ export declare namespace dataform_v1beta1 {
          */
         gitCommitish?: string | null;
         /**
-         * Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ReleaseConfig)
+         * Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.
          */
         internalMetadata?: string | null;
         /**
@@ -1919,6 +1923,19 @@ export declare namespace dataform_v1beta1 {
          */
         message?: string | null;
     }
+    /**
+     * Represents a table update trigger configuration.
+     */
+    export interface Schema$TableUpdateTrigger {
+        /**
+         * The target table to trigger the workflow.
+         */
+        table?: Schema$Target;
+        /**
+         * Output only. The modification time of this table that resulted in an invocation of the workflow. This would be updated by the triggering service after a successful workflow invocation.
+         */
+        triggerUpdateTime?: string | null;
+    }
     /**
      * Represents an action identifier. If the action writes output, the output will be written to the referenced database object.
      */
@@ -2005,6 +2022,19 @@ export declare namespace dataform_v1beta1 {
          */
         permissions?: string[] | null;
     }
+    /**
+     * A record of an attempt to evaluate trigger conditions.
+     */
+    export interface Schema$TriggerEvaluationRecord {
+        /**
+         * Output only. The timestamp of this trigger evaluation attempt.
+         */
+        evaluationTime?: string | null;
+        /**
+         * Output only. The status of the trigger evaluation. Success is indicated by a code of 0 (OK). Message will only be present if the status code is non-zero.
+         */
+        status?: Schema$Status;
+    }
     /**
      * Represents the Git state of a file with uncommitted changes.
      */
@@ -2062,6 +2092,10 @@ export declare namespace dataform_v1beta1 {
          * Output only. The timestamp of when the WorkflowConfig was last updated.
          */
         updateTime?: string | null;
+        /**
+         * Optional. Optional trigger configuration for this workflow. If present, the workflow will be triggered based on the specified triggers.
+         */
+        workflowTriggerConfig?: Schema$WorkflowTriggerConfig;
     }
     /**
      * Represents a single invocation of a compilation result.
@@ -2149,6 +2183,44 @@ export declare namespace dataform_v1beta1 {
          */
         target?: Schema$Target;
     }
+    /**
+     * The trigger definition to invoke a workflow.
+     */
+    export interface Schema$WorkflowTrigger {
+        /**
+         * The table update trigger configuration.
+         */
+        tableUpdateTrigger?: Schema$TableUpdateTrigger;
+    }
+    /**
+     * Represents a trigger configuration for a workflow.
+     */
+    export interface Schema$WorkflowTriggerConfig {
+        /**
+         * Optional. The condition to use when triggering the workflow.
+         */
+        condition?: string | null;
+        /**
+         * Output only. The timestamp of the last successful trigger evaluation.
+         */
+        lastSuccessfulEvaluationTime?: string | null;
+        /**
+         * Optional. The effective maximum wait time duration for the trigger condition to be met. If not specified, the workflow won't be triggered until conditions are met.
+         */
+        maxWaitDuration?: string | null;
+        /**
+         * Optional. Minimum duration between two consecutive executions. If not specified, the workflow will be executed every time trigger conditions are met and no ongoing workflow execution.
+         */
+        minExecutionDuration?: string | null;
+        /**
+         * Output only. Records of the 10 most recent trigger evaluations, ordered in descending order of `evaluation_time`. Updated whenever the service evaluates the trigger conditions (via polling or upon receiving a push event).
+         */
+        recentTriggerEvaluationRecords?: Schema$TriggerEvaluationRecord[];
+        /**
+         * Required. The trigger definitions to invoke a workflow.
+         */
+        workflowTriggers?: Schema$WorkflowTrigger[];
+    }
     /**
      * Represents a Dataform Git workspace.
      */
@@ -4136,7 +4208,7 @@ export declare namespace dataform_v1beta1 {
         delete(params: Params$Resource$Projects$Locations$Repositories$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
         delete(callback: BodyResponseCallback<Schema$Empty>): void;
         /**
-         * Deletes a single Repository asynchronously.
+         * Deletes a single repository asynchronously.
          * @example
          * ```js
          * // Before running the sample:
@@ -5343,7 +5415,7 @@ export declare namespace dataform_v1beta1 {
          *   // Do the magic
          *   const res =
          *     await dataform.projects.locations.repositories.compilationResults.get({
-         *       // Required. The compilation result's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:GetCompilationResultRequest)
+         *       // Required. The compilation result's name.
          *       name: 'projects/my-project/locations/my-location/repositories/my-repositorie/compilationResults/my-compilationResult',
          *     });
          *   console.log(res.data);
@@ -5418,7 +5490,7 @@ export declare namespace dataform_v1beta1 {
          *   // Do the magic
          *   const res =
          *     await dataform.projects.locations.repositories.compilationResults.list({
-         *       // Optional. Filter for the returned list. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListCompilationResultsRequest)
+         *       // Optional. Filter for the returned list.
          *       filter: 'placeholder-value',
          *       // Optional. This field only supports ordering by `name` and `create_time`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field.
          *       orderBy: 'placeholder-value',
@@ -5542,13 +5614,13 @@ export declare namespace dataform_v1beta1 {
     }
     export interface Params$Resource$Projects$Locations$Repositories$Compilationresults$Get extends StandardParameters {
         /**
-         * Required. The compilation result's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:GetCompilationResultRequest)
+         * Required. The compilation result's name.
          */
         name?: string;
     }
     export interface Params$Resource$Projects$Locations$Repositories$Compilationresults$List extends StandardParameters {
         /**
-         * Optional. Filter for the returned list. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListCompilationResultsRequest)
+         * Optional. Filter for the returned list.
          */
         filter?: string;
         /**
@@ -5627,7 +5699,7 @@ export declare namespace dataform_v1beta1 {
          *       // Required. The repository in which to create the release config. Must be in the format `projects/x/locations/x/repositories/x`.
          *       parent:
          *         'projects/my-project/locations/my-location/repositories/my-repositorie',
-         *       // Required. The ID to use for the release config, which will become the final component of the release config's resource name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:CreateReleaseConfigRequest)
+         *       // Required. The ID to use for the release config, which will become the final component of the release config's resource name.
          *       releaseConfigId: 'placeholder-value',
          *
          *       // Request body metadata
@@ -5715,7 +5787,7 @@ export declare namespace dataform_v1beta1 {
          *   // Do the magic
          *   const res =
          *     await dataform.projects.locations.repositories.releaseConfigs.delete({
-         *       // Required. The release config's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:DeleteReleaseConfigRequest)
+         *       // Required. The release config's name.
          *       name: 'projects/my-project/locations/my-location/repositories/my-repositorie/releaseConfigs/my-releaseConfig',
          *     });
          *   console.log(res.data);
@@ -5777,7 +5849,7 @@ export declare namespace dataform_v1beta1 {
          *   // Do the magic
          *   const res = await dataform.projects.locations.repositories.releaseConfigs.get(
          *     {
-         *       // Required. The release config's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:GetReleaseConfigRequest)
+         *       // Required. The release config's name.
          *       name: 'projects/my-project/locations/my-location/repositories/my-repositorie/releaseConfigs/my-releaseConfig',
          *     },
          *   );
@@ -5852,7 +5924,7 @@ export declare namespace dataform_v1beta1 {
          *     await dataform.projects.locations.repositories.releaseConfigs.list({
          *       // Optional. Maximum number of release configs to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.
          *       pageSize: 'placeholder-value',
-         *       // Optional. Page token received from a previous `ListReleaseConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReleaseConfigs`, with the exception of `page_size`, must match the call that provided the page token. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListReleaseConfigsRequest)
+         *       // Optional. Page token received from a previous `ListReleaseConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReleaseConfigs`, with the exception of `page_size`, must match the call that provided the page token.
          *       pageToken: 'placeholder-value',
          *       // Required. The repository in which to list release configs. Must be in the format `projects/x/locations/x/repositories/x`.
          *       parent:
@@ -5983,7 +6055,7 @@ export declare namespace dataform_v1beta1 {
          */
         parent?: string;
         /**
-         * Required. The ID to use for the release config, which will become the final component of the release config's resource name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:CreateReleaseConfigRequest)
+         * Required. The ID to use for the release config, which will become the final component of the release config's resource name.
          */
         releaseConfigId?: string;
         /**
@@ -5993,13 +6065,13 @@ export declare namespace dataform_v1beta1 {
     }
     export interface Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Delete extends StandardParameters {
         /**
-         * Required. The release config's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:DeleteReleaseConfigRequest)
+         * Required. The release config's name.
          */
         name?: string;
     }
     export interface Params$Resource$Projects$Locations$Repositories$Releaseconfigs$Get extends StandardParameters {
         /**
-         * Required. The release config's name. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:GetReleaseConfigRequest)
+         * Required. The release config's name.
          */
         name?: string;
     }
@@ -6009,7 +6081,7 @@ export declare namespace dataform_v1beta1 {
          */
         pageSize?: number;
         /**
-         * Optional. Page token received from a previous `ListReleaseConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReleaseConfigs`, with the exception of `page_size`, must match the call that provided the page token. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:ListReleaseConfigsRequest)
+         * Optional. Page token received from a previous `ListReleaseConfigs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReleaseConfigs`, with the exception of `page_size`, must match the call that provided the page token.
          */
         pageToken?: string;
         /**
@@ -6088,7 +6160,8 @@ export declare namespace dataform_v1beta1 {
          *         //   "recentScheduledExecutionRecords": [],
          *         //   "releaseConfig": "my_releaseConfig",
          *         //   "timeZone": "my_timeZone",
-         *         //   "updateTime": "my_updateTime"
+         *         //   "updateTime": "my_updateTime",
+         *         //   "workflowTriggerConfig": {}
          *         // }
          *       },
          *     });
@@ -6105,7 +6178,8 @@ export declare namespace dataform_v1beta1 {
          *   //   "recentScheduledExecutionRecords": [],
          *   //   "releaseConfig": "my_releaseConfig",
          *   //   "timeZone": "my_timeZone",
-         *   //   "updateTime": "my_updateTime"
+         *   //   "updateTime": "my_updateTime",
+         *   //   "workflowTriggerConfig": {}
          *   // }
          * }
          *
@@ -6240,7 +6314,8 @@ export declare namespace dataform_v1beta1 {
          *   //   "recentScheduledExecutionRecords": [],
          *   //   "releaseConfig": "my_releaseConfig",
          *   //   "timeZone": "my_timeZone",
-         *   //   "updateTime": "my_updateTime"
+         *   //   "updateTime": "my_updateTime",
+         *   //   "workflowTriggerConfig": {}
          *   // }
          * }
          *
@@ -6386,7 +6461,8 @@ export declare namespace dataform_v1beta1 {
          *         //   "recentScheduledExecutionRecords": [],
          *         //   "releaseConfig": "my_releaseConfig",
          *         //   "timeZone": "my_timeZone",
-         *         //   "updateTime": "my_updateTime"
+         *         //   "updateTime": "my_updateTime",
+         *         //   "workflowTriggerConfig": {}
          *         // }
          *       },
          *     });
@@ -6403,7 +6479,8 @@ export declare namespace dataform_v1beta1 {
          *   //   "recentScheduledExecutionRecords": [],
          *   //   "releaseConfig": "my_releaseConfig",
          *   //   "timeZone": "my_timeZone",
-         *   //   "updateTime": "my_updateTime"
+         *   //   "updateTime": "my_updateTime",
+         *   //   "workflowTriggerConfig": {}
          *   // }
          * }
          *
@@ -9521,7 +9598,7 @@ export declare namespace dataform_v1beta1 {
          *     location: 'projects/my-project/locations/my-location',
          *     // Optional. Field to additionally sort results by. Supported keywords: `display_name` (default), `create_time`, `last_modified_time`. Examples: * `orderBy="display_name"` * `orderBy="display_name desc"`
          *     orderBy: 'placeholder-value',
-         *     // Optional. Maximum number of TeamFolders to return. The server may return fewer items than requested. If unspecified, the server will pick a default of page_size = 50.
+         *     // Optional. Maximum number of `TeamFolders` to return. The server may return fewer items than requested. If unspecified, the server will pick a default of `page_size` = 50.
          *     pageSize: 'placeholder-value',
          *     // Optional. Page token received from a previous `SearchTeamFolders` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchTeamFolders`, with the exception of `page_size`, must match the call that provided the page token.
          *     pageToken: 'placeholder-value',
@@ -9796,7 +9873,7 @@ export declare namespace dataform_v1beta1 {
          */
         orderBy?: string;
         /**
-         * Optional. Maximum number of TeamFolders to return. The server may return fewer items than requested. If unspecified, the server will pick a default of page_size = 50.
+         * Optional. Maximum number of `TeamFolders` to return. The server may return fewer items than requested. If unspecified, the server will pick a default of `page_size` = 50.
          */
         pageSize?: number;
         /**