class Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client
Client
for the WorkflowTemplateService
service.
The API interface for managing Workflow Templates in the Dataproc
API.
Attributes
Get the associated client for long-running operations.
@return [::Google::Cloud::Dataproc::V1::WorkflowTemplateService::Operations]
@private
Public Class Methods
Configure the WorkflowTemplateService
Client
class.
See {::Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client::Configuration} for a description of the configuration fields.
@example
# Modify the configuration for all WorkflowTemplateService clients ::Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client.configure do |config| config.timeout = 10.0 end
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/dataproc/v1/workflow_template_service/client.rb, line 57 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Dataproc", "V1"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.rpcs.create_workflow_template.timeout = 600.0 default_config.rpcs.create_workflow_template.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.get_workflow_template.timeout = 600.0 default_config.rpcs.get_workflow_template.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 13, 14] } default_config.rpcs.instantiate_workflow_template.timeout = 600.0 default_config.rpcs.instantiate_workflow_template.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.instantiate_inline_workflow_template.timeout = 600.0 default_config.rpcs.instantiate_inline_workflow_template.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.update_workflow_template.timeout = 600.0 default_config.rpcs.update_workflow_template.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14] } default_config.rpcs.list_workflow_templates.timeout = 600.0 default_config.rpcs.list_workflow_templates.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 13, 14] } default_config.rpcs.delete_workflow_template.timeout = 600.0 default_config.rpcs.delete_workflow_template.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14] } default_config end yield @configure if block_given? @configure end
Create a new WorkflowTemplateService
client object.
@example
# Create a client using the default configuration client = ::Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client.new do |config| config.timeout = 10.0 end
@yield [config] Configure the WorkflowTemplateService
client. @yieldparam config [Client::Configuration]
# File lib/google/cloud/dataproc/v1/workflow_template_service/client.rb, line 145 def initialize # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "gapic/grpc" require "google/cloud/dataproc/v1/workflow_templates_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint && !@config.endpoint.split(".").first.include?("-") credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @operations_client = Operations.new do |config| config.credentials = credentials config.endpoint = @config.endpoint end @workflow_template_service_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::Dataproc::V1::WorkflowTemplateService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end
Public Instance Methods
Configure the WorkflowTemplateService
Client
instance.
The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on {Client.configure}.
See {::Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client::Configuration} for a description of the configuration fields.
@yield [config] Configure the Client
client. @yieldparam config [Client::Configuration]
@return [Client::Configuration]
# File lib/google/cloud/dataproc/v1/workflow_template_service/client.rb, line 124 def configure yield @config if block_given? @config end
Creates new workflow template.
@overload create_workflow_template
(request, options = nil)
Pass arguments to `create_workflow_template` via a request object, either of type {::Google::Cloud::Dataproc::V1::CreateWorkflowTemplateRequest} or an equivalent Hash. @param request [::Google::Cloud::Dataproc::V1::CreateWorkflowTemplateRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload create_workflow_template
(parent: nil, template: nil)
Pass arguments to `create_workflow_template` 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 parent [::String] Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. * For `projects.regions.workflowTemplates,create`, the resource name of the region has the following format: `projects/{project_id}/regions/{region}` * For `projects.locations.workflowTemplates.create`, the resource name of the location has the following format: `projects/{project_id}/locations/{location}` @param template [::Google::Cloud::Dataproc::V1::WorkflowTemplate, ::Hash] Required. The Dataproc workflow template to create.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Dataproc::V1::WorkflowTemplate] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Dataproc::V1::WorkflowTemplate]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/dataproc/v1/workflow_template_service/client.rb, line 235 def create_workflow_template request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataproc::V1::CreateWorkflowTemplateRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.create_workflow_template.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dataproc::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.create_workflow_template.timeout, metadata: metadata, retry_policy: @config.rpcs.create_workflow_template.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @workflow_template_service_stub.call_rpc :create_workflow_template, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Deletes a workflow template. It does not cancel in-progress workflows.
@overload delete_workflow_template
(request, options = nil)
Pass arguments to `delete_workflow_template` via a request object, either of type {::Google::Cloud::Dataproc::V1::DeleteWorkflowTemplateRequest} or an equivalent Hash. @param request [::Google::Cloud::Dataproc::V1::DeleteWorkflowTemplateRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload delete_workflow_template
(name: nil, version: nil)
Pass arguments to `delete_workflow_template` 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 name [::String] Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. * For `projects.regions.workflowTemplates.delete`, the resource name of the template has the following format: `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}` * For `projects.locations.workflowTemplates.instantiate`, the resource name of the template has the following format: `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}` @param version [::Integer] Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Protobuf::Empty] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Protobuf::Empty]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/dataproc/v1/workflow_template_service/client.rb, line 786 def delete_workflow_template request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataproc::V1::DeleteWorkflowTemplateRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.delete_workflow_template.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dataproc::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.delete_workflow_template.timeout, metadata: metadata, retry_policy: @config.rpcs.delete_workflow_template.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @workflow_template_service_stub.call_rpc :delete_workflow_template, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Retrieves the latest workflow template.
Can retrieve previously instantiated template by specifying optional version parameter.
@overload get_workflow_template
(request, options = nil)
Pass arguments to `get_workflow_template` via a request object, either of type {::Google::Cloud::Dataproc::V1::GetWorkflowTemplateRequest} or an equivalent Hash. @param request [::Google::Cloud::Dataproc::V1::GetWorkflowTemplateRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload get_workflow_template
(name: nil, version: nil)
Pass arguments to `get_workflow_template` 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 name [::String] Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. * For `projects.regions.workflowTemplates.get`, the resource name of the template has the following format: `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}` * For `projects.locations.workflowTemplates.get`, the resource name of the template has the following format: `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}` @param version [::Integer] Optional. The version of workflow template to retrieve. Only previously instantiated versions can be retrieved. If unspecified, retrieves the current version.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Dataproc::V1::WorkflowTemplate] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Dataproc::V1::WorkflowTemplate]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/dataproc/v1/workflow_template_service/client.rb, line 320 def get_workflow_template request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataproc::V1::GetWorkflowTemplateRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.get_workflow_template.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dataproc::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.get_workflow_template.timeout, metadata: metadata, retry_policy: @config.rpcs.get_workflow_template.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @workflow_template_service_stub.call_rpc :get_workflow_template, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Instantiates a template and begins execution.
This method is equivalent to executing the sequence {::Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client#create_workflow_template CreateWorkflowTemplate}, {::Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client#instantiate_workflow_template InstantiateWorkflowTemplate}, {::Google::Cloud::Dataproc::V1::WorkflowTemplateService::Client#delete_workflow_template DeleteWorkflowTemplate}.
The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.
The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.
The {::Google::Longrunning::Operation#metadata Operation.metadata} will be [WorkflowMetadata](cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see [Using WorkflowMetadata](cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).
On successful completion, {::Google::Longrunning::Operation#response Operation.response} will be {::Google::Protobuf::Empty Empty}.
@overload instantiate_inline_workflow_template
(request, options = nil)
Pass arguments to `instantiate_inline_workflow_template` via a request object, either of type {::Google::Cloud::Dataproc::V1::InstantiateInlineWorkflowTemplateRequest} or an equivalent Hash. @param request [::Google::Cloud::Dataproc::V1::InstantiateInlineWorkflowTemplateRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload instantiate_inline_workflow_template
(parent: nil, template: nil, request_id: nil)
Pass arguments to `instantiate_inline_workflow_template` 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 parent [::String] Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. * For `projects.regions.workflowTemplates,instantiateinline`, the resource name of the region has the following format: `projects/{project_id}/regions/{region}` * For `projects.locations.workflowTemplates.instantiateinline`, the resource name of the location has the following format: `projects/{project_id}/locations/{location}` @param template [::Google::Cloud::Dataproc::V1::WorkflowTemplate, ::Hash] Required. The workflow template to instantiate. @param request_id [::String] Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries. It is recommended to always set this value to a [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier). The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/dataproc/v1/workflow_template_service/client.rb, line 550 def instantiate_inline_workflow_template request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataproc::V1::InstantiateInlineWorkflowTemplateRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.instantiate_inline_workflow_template.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dataproc::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.instantiate_inline_workflow_template.timeout, metadata: metadata, retry_policy: @config.rpcs.instantiate_inline_workflow_template.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @workflow_template_service_stub.call_rpc :instantiate_inline_workflow_template, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Instantiates a template and begins execution.
The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.
The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.
The {::Google::Longrunning::Operation#metadata Operation.metadata} will be [WorkflowMetadata](cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see [Using WorkflowMetadata](cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).
On successful completion, {::Google::Longrunning::Operation#response Operation.response} will be {::Google::Protobuf::Empty Empty}.
@overload instantiate_workflow_template
(request, options = nil)
Pass arguments to `instantiate_workflow_template` via a request object, either of type {::Google::Cloud::Dataproc::V1::InstantiateWorkflowTemplateRequest} or an equivalent Hash. @param request [::Google::Cloud::Dataproc::V1::InstantiateWorkflowTemplateRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload instantiate_workflow_template
(name: nil, version: nil, request_id: nil, parameters: nil)
Pass arguments to `instantiate_workflow_template` 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 name [::String] Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. * For `projects.regions.workflowTemplates.instantiate`, the resource name of the template has the following format: `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}` * For `projects.locations.workflowTemplates.instantiate`, the resource name of the template has the following format: `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}` @param version [::Integer] Optional. The version of workflow template to instantiate. If specified, the workflow will be instantiated only if the current version of the workflow template has the supplied version. This option cannot be used to instantiate a previous version of workflow template. @param request_id [::String] Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries. It is recommended to always set this value to a [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier). The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. @param parameters [::Hash{::String => ::String}] Optional. Map from parameter names to values that should be used for those parameters. Values may not exceed 1000 characters.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::Operation]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/dataproc/v1/workflow_template_service/client.rb, line 436 def instantiate_workflow_template request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataproc::V1::InstantiateWorkflowTemplateRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.instantiate_workflow_template.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dataproc::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "name" => request.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.instantiate_workflow_template.timeout, metadata: metadata, retry_policy: @config.rpcs.instantiate_workflow_template.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @workflow_template_service_stub.call_rpc :instantiate_workflow_template, request, options: options do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Lists workflows that match the specified filter in the request.
@overload list_workflow_templates
(request, options = nil)
Pass arguments to `list_workflow_templates` via a request object, either of type {::Google::Cloud::Dataproc::V1::ListWorkflowTemplatesRequest} or an equivalent Hash. @param request [::Google::Cloud::Dataproc::V1::ListWorkflowTemplatesRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload list_workflow_templates
(parent: nil, page_size: nil, page_token: nil)
Pass arguments to `list_workflow_templates` 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 parent [::String] Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. * For `projects.regions.workflowTemplates,list`, the resource name of the region has the following format: `projects/{project_id}/regions/{region}` * For `projects.locations.workflowTemplates.list`, the resource name of the location has the following format: `projects/{project_id}/locations/{location}` @param page_size [::Integer] Optional. The maximum number of results to return in each response. @param page_token [::String] Optional. The page token, returned by a previous call, to request the next page of results.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dataproc::V1::WorkflowTemplate>] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Gapic::PagedEnumerable<::Google::Cloud::Dataproc::V1::WorkflowTemplate>]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/dataproc/v1/workflow_template_service/client.rb, line 704 def list_workflow_templates request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataproc::V1::ListWorkflowTemplatesRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.list_workflow_templates.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dataproc::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "parent" => request.parent } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.list_workflow_templates.timeout, metadata: metadata, retry_policy: @config.rpcs.list_workflow_templates.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @workflow_template_service_stub.call_rpc :list_workflow_templates, request, options: options do |response, operation| response = ::Gapic::PagedEnumerable.new @workflow_template_service_stub, :list_workflow_templates, request, response, operation, options yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end
Updates (replaces) workflow template. The updated template must contain version that matches the current server version.
@overload update_workflow_template
(request, options = nil)
Pass arguments to `update_workflow_template` via a request object, either of type {::Google::Cloud::Dataproc::V1::UpdateWorkflowTemplateRequest} or an equivalent Hash. @param request [::Google::Cloud::Dataproc::V1::UpdateWorkflowTemplateRequest, ::Hash] A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash. @param options [::Gapic::CallOptions, ::Hash] Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
@overload update_workflow_template
(template: nil)
Pass arguments to `update_workflow_template` 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 template [::Google::Cloud::Dataproc::V1::WorkflowTemplate, ::Hash] Required. The updated workflow template. The `template.version` field must match the current version.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Dataproc::V1::WorkflowTemplate] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Dataproc::V1::WorkflowTemplate]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/dataproc/v1/workflow_template_service/client.rb, line 622 def update_workflow_template request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dataproc::V1::UpdateWorkflowTemplateRequest # Converts hash and nil to an options object options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults metadata = @config.rpcs.update_workflow_template.metadata.to_h # Set x-goog-api-client and x-goog-user-project headers metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dataproc::V1::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "template.name" => request.template.name } request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") metadata[:"x-goog-request-params"] ||= request_params_header options.apply_defaults timeout: @config.rpcs.update_workflow_template.timeout, metadata: metadata, retry_policy: @config.rpcs.update_workflow_template.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @workflow_template_service_stub.call_rpc :update_workflow_template, request, options: options do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end