feat: add PipelineConfig to support different pipeline types and paths

google-cloud-dataform-v1/lib/google/cloud/dataform/v1/dataform/client.rb

@@ -3231,13 +3231,16 @@ def delete_workspace request, options = nil
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload install_npm_packages(workspace: nil)
+            # @overload install_npm_packages(workspace: nil, pipeline_config: nil)
             #   Pass arguments to `install_npm_packages` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param workspace [::String]
             #     Required. The workspace's name.
+            #   @param pipeline_config [::Google::Cloud::Dataform::V1::PipelineConfig, ::Hash]
+            #     Optional. The pipeline options which defines the pipeline type and path
+            #     within the Git repository.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::Dataform::V1::InstallNpmPackagesResponse]

google-cloud-dataform-v1/lib/google/cloud/dataform/v1/dataform/rest/client.rb

@@ -3008,13 +3008,16 @@ def delete_workspace request, options = nil
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
               #
-              # @overload install_npm_packages(workspace: nil)
+              # @overload install_npm_packages(workspace: nil, pipeline_config: nil)
               #   Pass arguments to `install_npm_packages` via keyword arguments. Note that at
               #   least one keyword argument is required. To specify no parameters, or to keep all
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param workspace [::String]
               #     Required. The workspace's name.
+              #   @param pipeline_config [::Google::Cloud::Dataform::V1::PipelineConfig, ::Hash]
+              #     Optional. The pipeline options which defines the pipeline type and path
+              #     within the Git repository.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Google::Cloud::Dataform::V1::InstallNpmPackagesResponse]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]

google-cloud-dataform-v1/proto_docs/google/cloud/dataform/v1/dataform.rb

@@ -1197,6 +1197,10 @@ class WriteFileResponse
         # @!attribute [rw] workspace
         #   @return [::String]
         #     Required. The workspace's name.
+        # @!attribute [rw] pipeline_config
+        #   @return [::Google::Cloud::Dataform::V1::PipelineConfig]
+        #     Optional. The pipeline options which defines the pipeline type and path
+        #     within the Git repository.
         class InstallNpmPackagesRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1230,9 +1234,9 @@ class InstallNpmPackagesResponse
         # @!attribute [rw] time_zone
         #   @return [::String]
         #     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.
+        #     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`.
         # @!attribute [r] recent_scheduled_release_records
         #   @return [::Array<::Google::Cloud::Dataform::V1::ReleaseConfig::ScheduledReleaseRecord>]
         #     Output only. Records of the 10 most recent scheduled release attempts,
@@ -1425,6 +1429,10 @@ class DeleteReleaseConfigRequest
         #     Output only. Metadata indicating whether this resource is user-scoped.
         #     `CompilationResult` resource is `user_scoped` only if it is sourced
         #     from a workspace.
+        # @!attribute [r] gcs_repository_snapshot_metadata
+        #   @return [::Google::Cloud::Dataform::V1::GcsRepositorySnapshotMetadata]
+        #     Output only. Metadata about the repository snapshot used by scheduled
+        #     notebooks.
         class CompilationResult
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1486,6 +1494,10 @@ class CompilationError
         # @!attribute [rw] default_notebook_runtime_options
         #   @return [::Google::Cloud::Dataform::V1::NotebookRuntimeOptions]
         #     Optional. The default notebook runtime options.
+        # @!attribute [rw] pipeline_config
+        #   @return [::Google::Cloud::Dataform::V1::PipelineConfig]
+        #     Optional. The pipeline options which defines the pipeline type and path
+        #     within the Git repository.
         class CodeCompilationConfig
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1500,11 +1512,43 @@ class VarsEntry
           end
         end
 
+        # Metadata about a repository snapshot stored in Google Cloud Storage.
+        # @!attribute [r] repository_snapshot_uri
+        #   @return [::String]
+        #     Output only. The Google Cloud Storage URI of the repository snapshot.
+        # @!attribute [r] crc32c_checksum
+        #   @return [::String]
+        #     Output only. The crc32c checksum of the repository snapshot, big-endian
+        #     base64 encoded.
+        # @!attribute [r] generation
+        #   @return [::Integer]
+        #     Output only. The generation number of the Cloud Storage object. See
+        #     https://cloud.google.com/storage/docs/metadata#generation-number.
+        class GcsRepositorySnapshotMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Configures the destination for a repository snapshot.
+        # @!attribute [rw] repository_snapshot_uri
+        #   @return [::String]
+        #     Optional. The Google Cloud Storage destination to upload the repository
+        #     snapshot to. Format: `gs://bucket-name/path/`.
+        class GcsRepositorySnapshotDestination
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Configures various aspects of Dataform notebook runtime.
         # @!attribute [rw] gcs_output_bucket
         #   @return [::String]
         #     Optional. The Google Cloud Storage location to upload the result to.
         #     Format: `gs://bucket-name`.
+        # @!attribute [rw] gcs_repository_snapshot_destination
+        #   @return [::Google::Cloud::Dataform::V1::GcsRepositorySnapshotDestination]
+        #     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/`.
         # @!attribute [rw] ai_platform_notebook_runtime_template
         #   @return [::String]
         #     Optional. The resource name of the [Colab runtime template]
@@ -1516,6 +1560,36 @@ class NotebookRuntimeOptions
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Defines the pipeline type and path within the Git repository.
+        # @!attribute [rw] pipeline_type
+        #   @return [::Google::Cloud::Dataform::V1::PipelineConfig::PipelineType]
+        #     Required. The type of the pipeline.
+        # @!attribute [rw] path
+        #   @return [::String]
+        #     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.
+        class PipelineConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The type of the pipeline. This may be extended in the future.
+          # In case of UNSPECIFIED, the error will be thrown.
+          module PipelineType
+            # Default value. This value is unused.
+            PIPELINE_TYPE_UNSPECIFIED = 0
+
+            # Regular Dataform pipeline.
+            DATAFORM = 1
+
+            # SQL single file asset.
+            SQL = 3
+
+            # Notebook single file asset.
+            NOTEBOOK = 4
+          end
+        end
+
         # `ListCompilationResults` request message.
         # @!attribute [rw] parent
         #   @return [::String]
@@ -2082,9 +2156,9 @@ class QueryCompilationResultActionsResponse
         # @!attribute [rw] time_zone
         #   @return [::String]
         #     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.
+        #     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`.
         # @!attribute [r] recent_scheduled_execution_records
         #   @return [::Array<::Google::Cloud::Dataform::V1::WorkflowConfig::ScheduledExecutionRecord>]
         #     Output only. Records of the 10 most recent scheduled execution attempts,
@@ -2312,6 +2386,10 @@ class DeleteWorkflowConfigRequest
         #     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.
+        # @!attribute [r] pipeline_config
+        #   @return [::Google::Cloud::Dataform::V1::PipelineConfig]
+        #     Output only. The pipeline options which defines the pipeline type and path
+        #     within the Git repository.
         class WorkflowInvocation
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -2502,6 +2580,9 @@ class BigQueryAction
           #     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.
+          # @!attribute [r] file_path
+          #   @return [::String]
+          #     Output only. The path to the notebook file in the repository.
           class NotebookAction
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

google-cloud-dataform-v1/test/google/cloud/dataform/v1/dataform_rest_test.rb

@@ -1810,6 +1810,7 @@ def test_install_npm_packages
 
     # Create request parameters for a unary method.
     workspace = "hello world"
+    pipeline_config = {}
 
     install_npm_packages_client_stub = ClientStub.new http_response do |_verb, uri:, body:, params:, options:, method_name:|
       assert options.metadata.key? :"x-goog-api-client"
@@ -1825,27 +1826,27 @@ def test_install_npm_packages
         end
 
         # Use hash object
-        c.install_npm_packages({ workspace: workspace }) do |_result, response|
+        c.install_npm_packages({ workspace: workspace, pipeline_config: pipeline_config }) do |_result, response|
           assert_equal http_response, response.underlying_op
         end
 
         # Use named arguments
-        c.install_npm_packages workspace: workspace do |_result, response|
+        c.install_npm_packages workspace: workspace, pipeline_config: pipeline_config do |_result, response|
           assert_equal http_response, response.underlying_op
         end
 
         # Use protobuf object
-        c.install_npm_packages ::Google::Cloud::Dataform::V1::InstallNpmPackagesRequest.new(workspace: workspace) do |_result, response|
+        c.install_npm_packages ::Google::Cloud::Dataform::V1::InstallNpmPackagesRequest.new(workspace: workspace, pipeline_config: pipeline_config) do |_result, response|
           assert_equal http_response, response.underlying_op
         end
 
         # Use hash object with options
-        c.install_npm_packages({ workspace: workspace }, call_options) do |_result, response|
+        c.install_npm_packages({ workspace: workspace, pipeline_config: pipeline_config }, call_options) do |_result, response|
           assert_equal http_response, response.underlying_op
         end
 
         # Use protobuf object with options
-        c.install_npm_packages(::Google::Cloud::Dataform::V1::InstallNpmPackagesRequest.new(workspace: workspace), call_options) do |_result, response|
+        c.install_npm_packages(::Google::Cloud::Dataform::V1::InstallNpmPackagesRequest.new(workspace: workspace, pipeline_config: pipeline_config), call_options) do |_result, response|
           assert_equal http_response, response.underlying_op
         end
 

google-cloud-dataform-v1/test/google/cloud/dataform/v1/dataform_test.rb

@@ -2030,11 +2030,13 @@ def test_install_npm_packages
 
     # Create request parameters for a unary method.
     workspace = "hello world"
+    pipeline_config = {}
 
     install_npm_packages_client_stub = ClientStub.new grpc_response, grpc_operation do |name, request, options:|
       assert_equal :install_npm_packages, name
       assert_kind_of ::Google::Cloud::Dataform::V1::InstallNpmPackagesRequest, request
       assert_equal "hello world", request["workspace"]
+      assert_equal Gapic::Protobuf.coerce({}, to: ::Google::Cloud::Dataform::V1::PipelineConfig), request["pipeline_config"]
       refute_nil options
     end
 
@@ -2045,31 +2047,31 @@ def test_install_npm_packages
       end
 
       # Use hash object
-      c.install_npm_packages({ workspace: workspace }) do |response, operation|
+      c.install_npm_packages({ workspace: workspace, pipeline_config: pipeline_config }) do |response, operation|
         assert_equal grpc_response, response
         assert_equal grpc_operation, operation
       end
 
       # Use named arguments
-      c.install_npm_packages workspace: workspace do |response, operation|
+      c.install_npm_packages workspace: workspace, pipeline_config: pipeline_config do |response, operation|
         assert_equal grpc_response, response
         assert_equal grpc_operation, operation
       end
 
       # Use protobuf object
-      c.install_npm_packages ::Google::Cloud::Dataform::V1::InstallNpmPackagesRequest.new(workspace: workspace) do |response, operation|
+      c.install_npm_packages ::Google::Cloud::Dataform::V1::InstallNpmPackagesRequest.new(workspace: workspace, pipeline_config: pipeline_config) do |response, operation|
         assert_equal grpc_response, response
         assert_equal grpc_operation, operation
       end
 
       # Use hash object with options
-      c.install_npm_packages({ workspace: workspace }, grpc_options) do |response, operation|
+      c.install_npm_packages({ workspace: workspace, pipeline_config: pipeline_config }, grpc_options) do |response, operation|
         assert_equal grpc_response, response
         assert_equal grpc_operation, operation
       end
 
       # Use protobuf object with options
-      c.install_npm_packages(::Google::Cloud::Dataform::V1::InstallNpmPackagesRequest.new(workspace: workspace), grpc_options) do |response, operation|
+      c.install_npm_packages(::Google::Cloud::Dataform::V1::InstallNpmPackagesRequest.new(workspace: workspace, pipeline_config: pipeline_config), grpc_options) do |response, operation|
         assert_equal grpc_response, response
         assert_equal grpc_operation, operation
       end