Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -3343,13 +3343,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::V1beta1::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::V1beta1::InstallNpmPackagesResponse]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3113,13 +3113,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::V1beta1::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::V1beta1::InstallNpmPackagesResponse]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -1231,6 +1231,10 @@ class WriteFileResponse
# @!attribute [rw] workspace
# @return [::String]
# Required. The workspace's name.
# @!attribute [rw] pipeline_config
# @return [::Google::Cloud::Dataform::V1beta1::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
Expand Down Expand Up @@ -1264,9 +1268,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::V1beta1::ReleaseConfig::ScheduledReleaseRecord>]
# Output only. Records of the 10 most recent scheduled release attempts,
Expand Down Expand Up @@ -1459,6 +1463,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::V1beta1::GcsRepositorySnapshotMetadata]
# Output only. Metadata about the repository snapshot used by scheduled
# notebooks.
class CompilationResult
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
Expand All @@ -1484,6 +1492,88 @@ class CompilationError
end
end

# Represents a trigger configuration for a workflow.
# @!attribute [rw] condition
# @return [::Google::Cloud::Dataform::V1beta1::WorkflowTriggerConfig::Condition]
# Optional. The condition to use when triggering the workflow.
# @!attribute [rw] workflow_triggers
# @return [::Array<::Google::Cloud::Dataform::V1beta1::WorkflowTrigger>]
# Required. The trigger definitions to invoke a workflow.
# @!attribute [rw] min_execution_duration
# @return [::Google::Protobuf::Duration]
# Optional. Minimum duration between two consecutive executions. If not
# specified, the workflow will be executed every time trigger conditions are
# met and there is no ongoing workflow execution.
# @!attribute [rw] max_wait_duration
# @return [::Google::Protobuf::Duration]
# 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.
# @!attribute [r] recent_trigger_evaluation_records
# @return [::Array<::Google::Cloud::Dataform::V1beta1::TriggerEvaluationRecord>]
# 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).
# @!attribute [r] last_successful_evaluation_time
# @return [::Google::Protobuf::Timestamp]
# Output only. The timestamp of the last successful trigger evaluation.
class WorkflowTriggerConfig
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods

# The condition to use when triggering the workflow.
module Condition
# If CONDITION_UNSPECIFIED, the default value is ANY.
CONDITION_UNSPECIFIED = 0

# If ALL, all the trigger config conditions must be met before a workflow
# is invoked.
ALL = 1

# If ANY, at least one of the trigger config conditions must be met
# before a workflow is invoked.
ANY = 2
end
end

# A record of an attempt to evaluate trigger conditions.
# @!attribute [r] evaluation_time
# @return [::Google::Protobuf::Timestamp]
# Output only. The timestamp of this trigger evaluation attempt.
# @!attribute [r] status
# @return [::Google::Rpc::Status]
# 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.
class TriggerEvaluationRecord
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end

# The trigger definition to invoke a workflow.
# @!attribute [rw] table_update_trigger
# @return [::Google::Cloud::Dataform::V1beta1::TableUpdateTrigger]
# The table update trigger configuration.
class WorkflowTrigger
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end

# Represents a table update trigger configuration.
# @!attribute [rw] table
# @return [::Google::Cloud::Dataform::V1beta1::Target]
# The target table to trigger the workflow.
# @!attribute [r] trigger_update_time
# @return [::Google::Protobuf::Timestamp]
# 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.
class TableUpdateTrigger
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end

# Configures various aspects of Dataform code compilation.
# @!attribute [rw] default_database
# @return [::String]
Expand Down Expand Up @@ -1520,6 +1610,10 @@ class CompilationError
# @!attribute [rw] default_notebook_runtime_options
# @return [::Google::Cloud::Dataform::V1beta1::NotebookRuntimeOptions]
# Optional. The default notebook runtime options.
# @!attribute [rw] pipeline_config
# @return [::Google::Cloud::Dataform::V1beta1::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
Expand All @@ -1534,11 +1628,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::V1beta1::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]
Expand All @@ -1550,6 +1676,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::V1beta1::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]
Expand Down Expand Up @@ -2116,9 +2272,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::V1beta1::WorkflowConfig::ScheduledExecutionRecord>]
# Output only. Records of the 10 most recent scheduled execution attempts,
Expand All @@ -2138,6 +2294,10 @@ class QueryCompilationResultActionsResponse
# 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.
# @!attribute [rw] workflow_trigger_config
# @return [::Google::Cloud::Dataform::V1beta1::WorkflowTriggerConfig]
# Optional. Trigger configuration for this workflow.
# If present, the workflow will be triggered based on the specified triggers.
class WorkflowConfig
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
Expand Down Expand Up @@ -2346,6 +2506,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::V1beta1::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
Expand Down Expand Up @@ -2536,6 +2700,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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1867,6 +1867,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"
Expand All @@ -1882,27 +1883,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::V1beta1::InstallNpmPackagesRequest.new(workspace: workspace) do |_result, response|
c.install_npm_packages ::Google::Cloud::Dataform::V1beta1::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::V1beta1::InstallNpmPackagesRequest.new(workspace: workspace), call_options) do |_result, response|
c.install_npm_packages(::Google::Cloud::Dataform::V1beta1::InstallNpmPackagesRequest.new(workspace: workspace, pipeline_config: pipeline_config), call_options) do |_result, response|
assert_equal http_response, response.underlying_op
end

Expand Down
Loading
Loading