class Google::Cloud::LifeSciences::V2beta::WorkflowsService::Client
Client
for the WorkflowsService
service.
A service for running workflows, such as pipelines consisting of Docker containers.
Attributes
Get the associated client for long-running operations.
@return [::Google::Cloud::LifeSciences::V2beta::WorkflowsService::Operations]
@private
Public Class Methods
Configure the WorkflowsService
Client
class.
See {::Google::Cloud::LifeSciences::V2beta::WorkflowsService::Client::Configuration} for a description of the configuration fields.
@example
# Modify the configuration for all WorkflowsService clients ::Google::Cloud::LifeSciences::V2beta::WorkflowsService::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/life_sciences/v2beta/workflows_service/client.rb, line 55 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "LifeSciences", "V2beta"] 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.timeout = 60.0 default_config end yield @configure if block_given? @configure end
Create a new WorkflowsService
client object.
@example
# Create a client using the default configuration client = ::Google::Cloud::LifeSciences::V2beta::WorkflowsService::Client.new # Create a client using a custom configuration client = ::Google::Cloud::LifeSciences::V2beta::WorkflowsService::Client.new do |config| config.timeout = 10.0 end
@yield [config] Configure the WorkflowsService
client. @yieldparam config [Client::Configuration]
# File lib/google/cloud/life_sciences/v2beta/workflows_service/client.rb, line 110 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/lifesciences/v2beta/workflows_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 @workflows_service_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::LifeSciences::V2beta::WorkflowsServiceV2Beta::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end
Public Instance Methods
Configure the WorkflowsService
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::LifeSciences::V2beta::WorkflowsService::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/life_sciences/v2beta/workflows_service/client.rb, line 89 def configure yield @config if block_given? @config end
Runs a pipeline. The returned Operation's [metadata]
- google.longrunning.Operation.metadata
-
field will contain a
{::Google::Cloud::LifeSciences::V2beta::Metadata google.cloud.lifesciences.v2beta.Metadata} object describing the status of the pipeline execution. The {::Google::Longrunning::Operation#response response} field will contain a {::Google::Cloud::LifeSciences::V2beta::RunPipelineResponse google.cloud.lifesciences.v2beta.RunPipelineResponse} object if the pipeline completes successfully.
Note: Before you can use this method, the *Life Sciences Service Agent* must have access to your project. This is done automatically when the Cloud
Life Sciences API is first enabled, but if you delete this permission you must disable and re-enable the API to grant the Life Sciences Service Agent the required permissions. Authorization requires the following [Google IAM](cloud.google.com/iam/) permission:
-
`lifesciences.workflows.run`
@overload run_pipeline
(request, options = nil)
Pass arguments to `run_pipeline` via a request object, either of type {::Google::Cloud::LifeSciences::V2beta::RunPipelineRequest} or an equivalent Hash. @param request [::Google::Cloud::LifeSciences::V2beta::RunPipelineRequest, ::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 run_pipeline
(parent: nil, pipeline: nil, labels: nil, pub_sub_topic: nil)
Pass arguments to `run_pipeline` 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] The project and location that this request should be executed against. @param pipeline [::Google::Cloud::LifeSciences::V2beta::Pipeline, ::Hash] Required. The description of the pipeline to run. @param labels [::Hash{::String => ::String}] User-defined labels to associate with the returned operation. These labels are not propagated to any Google Cloud Platform resources used by the operation, and can be modified at any time. To associate labels with resources created while executing the operation, see the appropriate resource message (for example, `VirtualMachine`). @param pub_sub_topic [::String] The name of an existing Pub/Sub topic. The server will publish messages to this topic whenever the status of the operation changes. The Life Sciences Service Agent account must have publisher permissions to the specified topic or notifications will not be sent.
@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/life_sciences/v2beta/workflows_service/client.rb, line 219 def run_pipeline request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::LifeSciences::V2beta::RunPipelineRequest # 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.run_pipeline.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::LifeSciences::V2beta::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.run_pipeline.timeout, metadata: metadata, retry_policy: @config.rpcs.run_pipeline.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @workflows_service_stub.call_rpc :run_pipeline, 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