@googleapis/dataform 16.0.0 → 17.1.0

package/build/v1.d.ts

@@ -241,6 +241,10 @@ export declare namespace dataform_v1 {
          * Optional. The default schema (BigQuery dataset ID).
          */
         defaultSchema?: string | null;
+        /**
+         * Optional. The pipeline options which defines the pipeline type and path within the Git repository.
+         */
+        pipelineConfig?: Schema$PipelineConfig;
         /**
          * Optional. The suffix that should be appended to all schema (BigQuery dataset ID) names.
          */
@@ -375,7 +379,7 @@ export declare namespace dataform_v1 {
      */
     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;
         /**
@@ -415,6 +419,10 @@ export declare namespace dataform_v1 {
          * Output only. The version of `@dataform/core` that was used for compilation.
          */
         dataformCoreVersion?: string | null;
+        /**
+         * Output only. Metadata about the repository snapshot used by scheduled notebooks.
+         */
+        gcsRepositorySnapshotMetadata?: Schema$GcsRepositorySnapshotMetadata;
         /**
          * Immutable. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1`
          */
@@ -805,6 +813,32 @@ export declare namespace dataform_v1 {
          */
         repository?: Schema$Repository;
     }
+    /**
+     * Configures the destination for a repository snapshot.
+     */
+    export interface Schema$GcsRepositorySnapshotDestination {
+        /**
+         * Optional. The Google Cloud Storage destination to upload the repository snapshot to. Format: `gs://bucket-name/path/`.
+         */
+        repositorySnapshotUri?: string | null;
+    }
+    /**
+     * Metadata about a repository snapshot stored in Google Cloud Storage.
+     */
+    export interface Schema$GcsRepositorySnapshotMetadata {
+        /**
+         * Output only. The crc32c checksum of the repository snapshot, big-endian base64 encoded.
+         */
+        crc32cChecksum?: string | null;
+        /**
+         * Output only. The generation number of the Cloud Storage object. See https://cloud.google.com/storage/docs/metadata#generation-number.
+         */
+        generation?: string | null;
+        /**
+         * Output only. The Google Cloud Storage URI of the repository snapshot.
+         */
+        repositorySnapshotUri?: string | null;
+    }
     /**
      * Controls Git remote configuration for a repository.
      */
@@ -814,13 +848,17 @@ export declare namespace dataform_v1 {
          */
         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.
          */
@@ -889,6 +927,10 @@ export declare namespace dataform_v1 {
      * `InstallNpmPackages` request message.
      */
     export interface Schema$InstallNpmPackagesRequest {
+        /**
+         * Optional. The pipeline options which defines the pipeline type and path within the Git repository.
+         */
+        pipelineConfig?: Schema$PipelineConfig;
     }
     /**
      * `InstallNpmPackages` response message.
@@ -954,7 +996,7 @@ export declare namespace dataform_v1 {
          */
         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;
     }
@@ -1001,7 +1043,7 @@ export declare namespace dataform_v1 {
          */
         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;
     }
@@ -1220,6 +1262,10 @@ export declare namespace dataform_v1 {
          * Output only. The code contents of a Notebook to be run.
          */
         contents?: string | null;
+        /**
+         * Output only. The path to the notebook file in the repository.
+         */
+        filePath?: string | null;
         /**
          * Output only. The ID of the Gemini Enterprise Agent Platform job that executed the notebook in contents and also the ID used for the outputs created in Google Cloud Storage buckets. Only set once the job has started to run.
          */
@@ -1237,6 +1283,10 @@ export declare namespace dataform_v1 {
          * Optional. The Google Cloud Storage location to upload the result to. Format: `gs://bucket-name`.
          */
         gcsOutputBucket?: string | null;
+        /**
+         * Optional. The Google Cloud Storage destination to upload the snapshot to. For empty URI it defaults to the provided gcs_output_bucket. Format: `gs://bucket-name/path/`.
+         */
+        gcsRepositorySnapshotDestination?: Schema$GcsRepositorySnapshotDestination;
     }
     /**
      * This resource represents a long-running operation that is the result of a network API call.
@@ -1329,6 +1379,19 @@ export declare namespace dataform_v1 {
          */
         tags?: string[] | null;
     }
+    /**
+     * Defines the pipeline type and path within the Git repository.
+     */
+    export interface Schema$PipelineConfig {
+        /**
+         * Required. The relative path within the Git repository where the pipeline is defined. For example, for a Dataform pipeline, it is a path to the folder where `workflow_settings.yaml` or `dataform.json` is located.
+         */
+        path?: string | null;
+        /**
+         * Required. The type of the pipeline.
+         */
+        pipelineType?: string | null;
+    }
     /**
      * An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] \}, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", \} \} ], "etag": "BwWWja0YfJA=", "version": 3 \} ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).
      */
@@ -1632,7 +1695,7 @@ export declare namespace dataform_v1 {
          */
         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;
         /**
@@ -1648,7 +1711,7 @@ export declare namespace dataform_v1 {
          */
         releaseCompilationResult?: string | null;
         /**
-         * Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
+         * Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the [time zone database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is `UTC`.
          */
         timeZone?: string | null;
     }
@@ -2046,7 +2109,7 @@ export declare namespace dataform_v1 {
          */
         releaseConfig?: string | null;
         /**
-         * Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC.
+         * Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the [time zone database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is `UTC`.
          */
         timeZone?: string | null;
         /**
@@ -2082,6 +2145,10 @@ export declare namespace dataform_v1 {
          * Output only. The workflow invocation's name.
          */
         name?: string | null;
+        /**
+         * Output only. The pipeline options which defines the pipeline type and path within the Git repository.
+         */
+        pipelineConfig?: Schema$PipelineConfig;
         /**
          * Output only. Metadata indicating whether this resource is user-scoped. `WorkflowInvocation` resource is `user_scoped` only if it is sourced from a compilation result and the compilation result is user-scoped.
          */
@@ -5161,6 +5228,7 @@ export declare namespace dataform_v1 {
          *         //   "createTime": "my_createTime",
          *         //   "dataEncryptionState": {},
          *         //   "dataformCoreVersion": "my_dataformCoreVersion",
+         *         //   "gcsRepositorySnapshotMetadata": {},
          *         //   "gitCommitish": "my_gitCommitish",
          *         //   "internalMetadata": "my_internalMetadata",
          *         //   "name": "my_name",
@@ -5180,6 +5248,7 @@ export declare namespace dataform_v1 {
          *   //   "createTime": "my_createTime",
          *   //   "dataEncryptionState": {},
          *   //   "dataformCoreVersion": "my_dataformCoreVersion",
+         *   //   "gcsRepositorySnapshotMetadata": {},
          *   //   "gitCommitish": "my_gitCommitish",
          *   //   "internalMetadata": "my_internalMetadata",
          *   //   "name": "my_name",
@@ -5243,7 +5312,7 @@ export declare namespace dataform_v1 {
          *   // 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);
@@ -5255,6 +5324,7 @@ export declare namespace dataform_v1 {
          *   //   "createTime": "my_createTime",
          *   //   "dataEncryptionState": {},
          *   //   "dataformCoreVersion": "my_dataformCoreVersion",
+         *   //   "gcsRepositorySnapshotMetadata": {},
          *   //   "gitCommitish": "my_gitCommitish",
          *   //   "internalMetadata": "my_internalMetadata",
          *   //   "name": "my_name",
@@ -5318,7 +5388,7 @@ export declare namespace dataform_v1 {
          *   // 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',
@@ -5442,13 +5512,13 @@ export declare namespace dataform_v1 {
     }
     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;
         /**
@@ -5527,7 +5597,7 @@ export declare namespace dataform_v1 {
          *       // 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
@@ -5615,7 +5685,7 @@ export declare namespace dataform_v1 {
          *   // 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);
@@ -5677,7 +5747,7 @@ export declare namespace dataform_v1 {
          *   // 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',
          *     },
          *   );
@@ -5752,7 +5822,7 @@ export declare namespace dataform_v1 {
          *     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:
@@ -5883,7 +5953,7 @@ export declare namespace dataform_v1 {
          */
         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;
         /**
@@ -5893,13 +5963,13 @@ export declare namespace dataform_v1 {
     }
     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;
     }
@@ -5909,7 +5979,7 @@ export declare namespace dataform_v1 {
          */
         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;
         /**
@@ -6500,6 +6570,7 @@ export declare namespace dataform_v1 {
          *         //   "invocationConfig": {},
          *         //   "invocationTiming": {},
          *         //   "name": "my_name",
+         *         //   "pipelineConfig": {},
          *         //   "privateResourceMetadata": {},
          *         //   "resolvedCompilationResult": "my_resolvedCompilationResult",
          *         //   "state": "my_state",
@@ -6517,6 +6588,7 @@ export declare namespace dataform_v1 {
          *   //   "invocationConfig": {},
          *   //   "invocationTiming": {},
          *   //   "name": "my_name",
+         *   //   "pipelineConfig": {},
          *   //   "privateResourceMetadata": {},
          *   //   "resolvedCompilationResult": "my_resolvedCompilationResult",
          *   //   "state": "my_state",
@@ -6652,6 +6724,7 @@ export declare namespace dataform_v1 {
          *   //   "invocationConfig": {},
          *   //   "invocationTiming": {},
          *   //   "name": "my_name",
+         *   //   "pipelineConfig": {},
          *   //   "privateResourceMetadata": {},
          *   //   "resolvedCompilationResult": "my_resolvedCompilationResult",
          *   //   "state": "my_state",
@@ -7491,7 +7564,9 @@ export declare namespace dataform_v1 {
          *         // Request body metadata
          *         requestBody: {
          *           // request body parameters
-         *           // {}
+         *           // {
+         *           //   "pipelineConfig": {}
+         *           // }
          *         },
          *       },
          *     );
@@ -9419,7 +9494,7 @@ export declare namespace dataform_v1 {
          *     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',
@@ -9690,7 +9765,7 @@ export declare namespace dataform_v1 {
          */
         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;
         /**