Class: Google::Cloud::Dataproc::V1beta2::WorkflowTemplateServiceClient

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/dataproc/v1beta2/workflow_template_service_client.rb

Overview

The API interface for managing Workflow Templates in the Cloud Dataproc API.

Defined Under Namespace

Classes: OperationsClient

Constant Summary collapse

SERVICE_ADDRESS =

The default address of the service.

"dataproc.googleapis.com".freeze
DEFAULT_SERVICE_PORT =

The default port of the service.

443
GRPC_INTERCEPTORS =

The default set of gRPC interceptors.

[]
DEFAULT_TIMEOUT = 
30
ALL_SCOPES =

The scopes needed to make gRPC calls to all of the methods defined in this service.

[
  "https://www.googleapis.com/auth/cloud-platform"
].freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, service_address: nil, service_port: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ WorkflowTemplateServiceClient 



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/google/cloud/dataproc/v1beta2/workflow_template_service_client.rb', line 147

def initialize \
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    metadata: nil,
    service_address: nil,
    service_port: nil,
    exception_transformer: nil,
    lib_name: nil,
    lib_version: ""
  # 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 "google/gax/grpc"
  require "google/cloud/dataproc/v1beta2/workflow_templates_services_pb"

  credentials ||= Google::Cloud::Dataproc::V1beta2::Credentials.default

  @operations_client = OperationsClient.new(
    credentials: credentials,
    scopes: scopes,
    client_config: client_config,
    timeout: timeout,
    lib_name: lib_name,
    service_address: service_address,
    service_port: service_port,
    lib_version: lib_version,
    metadata: metadata,
  )

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Cloud::Dataproc::V1beta2::Credentials.new(credentials).updater_proc
  end
  if credentials.is_a?(GRPC::Core::Channel)
    channel = credentials
  end
  if credentials.is_a?(GRPC::Core::ChannelCredentials)
    chan_creds = credentials
  end
  if credentials.is_a?(Proc)
    updater_proc = credentials
  end
  if credentials.is_a?(Google::Auth::Credentials)
    updater_proc = credentials.updater_proc
  end

  package_version = Google::Cloud::Dataproc::VERSION

  google_api_client = "gl-ruby/#{RUBY_VERSION}"
  google_api_client << " #{lib_name}/#{lib_version}" if lib_name
  google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
  google_api_client << " grpc/#{GRPC::VERSION}"
  google_api_client.freeze

  headers = { :"x-goog-api-client" => google_api_client }
  headers.merge!(metadata) unless metadata.nil?
  client_config_file = Pathname.new(__dir__).join(
    "workflow_template_service_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.cloud.dataproc.v1beta2.WorkflowTemplateService",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      page_descriptors: PAGE_DESCRIPTORS,
      errors: Google::Gax::Grpc::API_ERRORS,
      metadata: headers
    )
  end

  # Allow overriding the service path/port in subclasses.
  service_path = service_address || self.class::SERVICE_ADDRESS
  port = service_port || self.class::DEFAULT_SERVICE_PORT
  interceptors = self.class::GRPC_INTERCEPTORS
  @workflow_template_service_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    interceptors: interceptors,
    &Google::Cloud::Dataproc::V1beta2::WorkflowTemplateService::Stub.method(:new)
  )

  @create_workflow_template = Google::Gax.create_api_call(
    @workflow_template_service_stub.method(:create_workflow_template),
    defaults["create_workflow_template"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @get_workflow_template = Google::Gax.create_api_call(
    @workflow_template_service_stub.method(:get_workflow_template),
    defaults["get_workflow_template"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @instantiate_workflow_template = Google::Gax.create_api_call(
    @workflow_template_service_stub.method(:instantiate_workflow_template),
    defaults["instantiate_workflow_template"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @instantiate_inline_workflow_template = Google::Gax.create_api_call(
    @workflow_template_service_stub.method(:instantiate_inline_workflow_template),
    defaults["instantiate_inline_workflow_template"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @update_workflow_template = Google::Gax.create_api_call(
    @workflow_template_service_stub.method(:update_workflow_template),
    defaults["update_workflow_template"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'template.name' => request.template.name}
    end
  )
  @list_workflow_templates = Google::Gax.create_api_call(
    @workflow_template_service_stub.method(:list_workflow_templates),
    defaults["list_workflow_templates"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @delete_workflow_template = Google::Gax.create_api_call(
    @workflow_template_service_stub.method(:delete_workflow_template),
    defaults["delete_workflow_template"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
end

Class Method Details

.region_path(project, region) ⇒ String

Returns a fully-qualified region resource name string.



94
95
96
97
98
99
 
# File 'lib/google/cloud/dataproc/v1beta2/workflow_template_service_client.rb', line 94

def self.region_path project, region
  REGION_PATH_TEMPLATE.render(
    :"project" => project,
    :"region" => region
  )
end

.workflow_template_path(project, region, workflow_template) ⇒ String

Returns a fully-qualified workflow_template resource name string.



106
107
108
109
110
111
112
 
# File 'lib/google/cloud/dataproc/v1beta2/workflow_template_service_client.rb', line 106

def self.workflow_template_path project, region, workflow_template
  WORKFLOW_TEMPLATE_PATH_TEMPLATE.render(
    :"project" => project,
    :"region" => region,
    :"workflow_template" => workflow_template
  )
end

Instance Method Details

#create_workflow_template(parent, template, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dataproc::V1beta2::WorkflowTemplate

Creates new workflow template.

Examples:

require "google/cloud/dataproc"

workflow_template_client = Google::Cloud::Dataproc::WorkflowTemplateService.new(version: :v1beta2)
formatted_parent = Google::Cloud::Dataproc::V1beta2::WorkflowTemplateServiceClient.region_path("[PROJECT]", "[REGION]")

# TODO: Initialize `template`:
template = {}
response = workflow_template_client.create_workflow_template(formatted_parent, template)

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/google/cloud/dataproc/v1beta2/workflow_template_service_client.rb', line 330

def create_workflow_template \
    parent,
    template,
    options: nil,
    &block
  req = {
    parent: parent,
    template: template
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dataproc::V1beta2::CreateWorkflowTemplateRequest)
  @create_workflow_template.call(req, options, &block)
end

#delete_workflow_template(name, version: nil, options: nil) {|result, operation| ... } ⇒ Object

Deletes a workflow template. It does not cancel in-progress workflows.

Examples:

require "google/cloud/dataproc"

workflow_template_client = Google::Cloud::Dataproc::WorkflowTemplateService.new(version: :v1beta2)
formatted_name = Google::Cloud::Dataproc::V1beta2::WorkflowTemplateServiceClient.workflow_template_path("[PROJECT]", "[REGION]", "[WORKFLOW_TEMPLATE]")
workflow_template_client.delete_workflow_template(formatted_name)

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • result —

    []

  • operation (GRPC::ActiveCall::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



758
759
760
761
762
763
764
765
766
767
768
769
770
 
# File 'lib/google/cloud/dataproc/v1beta2/workflow_template_service_client.rb', line 758

def delete_workflow_template \
    name,
    version: nil,
    options: nil,
    &block
  req = {
    name: name,
    version: version
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dataproc::V1beta2::DeleteWorkflowTemplateRequest)
  @delete_workflow_template.call(req, options, &block)
  nil
end

#get_workflow_template(name, version: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dataproc::V1beta2::WorkflowTemplate

Retrieves the latest workflow template.

Can retrieve previously instantiated template by specifying optional version parameter.

Examples:

require "google/cloud/dataproc"

workflow_template_client = Google::Cloud::Dataproc::WorkflowTemplateService.new(version: :v1beta2)
formatted_name = Google::Cloud::Dataproc::V1beta2::WorkflowTemplateServiceClient.workflow_template_path("[PROJECT]", "[REGION]", "[WORKFLOW_TEMPLATE]")
response = workflow_template_client.get_workflow_template(formatted_name)

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/google/cloud/dataproc/v1beta2/workflow_template_service_client.rb', line 379

def get_workflow_template \
    name,
    version: nil,
    options: nil,
    &block
  req = {
    name: name,
    version: version
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dataproc::V1beta2::GetWorkflowTemplateRequest)
  @get_workflow_template.call(req, options, &block)
end

#instantiate_inline_workflow_template(parent, template, instance_id: nil, request_id: nil, options: nil) ⇒ Google::Gax::Operation

Instantiates a template and begins execution.

This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, 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 Operation#metadata will be WorkflowMetadata. Also see Using WorkflowMetadata.

On successful completion, Operation#response will be Empty.

Examples:

require "google/cloud/dataproc"

workflow_template_client = Google::Cloud::Dataproc::WorkflowTemplateService.new(version: :v1beta2)
formatted_parent = Google::Cloud::Dataproc::V1beta2::WorkflowTemplateServiceClient.region_path("[PROJECT]", "[REGION]")

# TODO: Initialize `template`:
template = {}

# Register a callback during the method call.
operation = workflow_template_client.instantiate_inline_workflow_template(formatted_parent, template) do |op|
  raise op.results.message if op.error?
  op_results = op.results
  # Process the results.

  metadata = op.metadata
  # Process the metadata.
end

# Or use the return value to register a callback.
operation.on_done do |op|
  raise op.results.message if op.error?
  op_results = op.results
  # Process the results.

  metadata = op.metadata
  # Process the metadata.
end

# Manually reload the operation.
operation.reload!

# Or block until the operation completes, triggering callbacks on
# completion.
operation.wait_until_done!

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
 
# File 'lib/google/cloud/dataproc/v1beta2/workflow_template_service_client.rb', line 603

def instantiate_inline_workflow_template \
    parent,
    template,
    instance_id: nil,
    request_id: nil,
    options: nil
  req = {
    parent: parent,
    template: template,
    instance_id: instance_id,
    request_id: request_id
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dataproc::V1beta2::InstantiateInlineWorkflowTemplateRequest)
  operation = Google::Gax::Operation.new(
    @instantiate_inline_workflow_template.call(req, options),
    @operations_client,
    Google::Protobuf::Empty,
    Google::Cloud::Dataproc::V1beta2::WorkflowMetadata,
    call_options: options
  )
  operation.on_done { |operation| yield(operation) } if block_given?
  operation
end

#instantiate_workflow_template(name, version: nil, instance_id: nil, request_id: nil, parameters: nil, options: nil) ⇒ Google::Gax::Operation

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 Operation#metadata will be WorkflowMetadata. Also see Using WorkflowMetadata.

On successful completion, Operation#response will be Empty.

Examples:

require "google/cloud/dataproc"

workflow_template_client = Google::Cloud::Dataproc::WorkflowTemplateService.new(version: :v1beta2)
formatted_name = Google::Cloud::Dataproc::V1beta2::WorkflowTemplateServiceClient.workflow_template_path("[PROJECT]", "[REGION]", "[WORKFLOW_TEMPLATE]")

# Register a callback during the method call.
operation = workflow_template_client.instantiate_workflow_template(formatted_name) do |op|
  raise op.results.message if op.error?
  op_results = op.results
  # Process the results.

  metadata = op.metadata
  # Process the metadata.
end

# Or use the return value to register a callback.
operation.on_done do |op|
  raise op.results.message if op.error?
  op_results = op.results
  # Process the results.

  metadata = op.metadata
  # Process the metadata.
end

# Manually reload the operation.
operation.reload!

# Or block until the operation completes, triggering callbacks on
# completion.
operation.wait_until_done!

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
 
# File 'lib/google/cloud/dataproc/v1beta2/workflow_template_service_client.rb', line 484

def instantiate_workflow_template \
    name,
    version: nil,
    instance_id: nil,
    request_id: nil,
    parameters: nil,
    options: nil
  req = {
    name: name,
    version: version,
    instance_id: instance_id,
    request_id: request_id,
    parameters: parameters
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dataproc::V1beta2::InstantiateWorkflowTemplateRequest)
  operation = Google::Gax::Operation.new(
    @instantiate_workflow_template.call(req, options),
    @operations_client,
    Google::Protobuf::Empty,
    Google::Cloud::Dataproc::V1beta2::WorkflowMetadata,
    call_options: options
  )
  operation.on_done { |operation| yield(operation) } if block_given?
  operation
end

#list_workflow_templates(parent, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Cloud::Dataproc::V1beta2::WorkflowTemplate>

Lists workflows that match the specified filter in the request.

Examples:

require "google/cloud/dataproc"

workflow_template_client = Google::Cloud::Dataproc::WorkflowTemplateService.new(version: :v1beta2)
formatted_parent = Google::Cloud::Dataproc::V1beta2::WorkflowTemplateServiceClient.region_path("[PROJECT]", "[REGION]")

# Iterate over all results.
workflow_template_client.list_workflow_templates(formatted_parent).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
workflow_template_client.list_workflow_templates(formatted_parent).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



714
715
716
717
718
719
720
721
722
723
724
725
 
# File 'lib/google/cloud/dataproc/v1beta2/workflow_template_service_client.rb', line 714

def list_workflow_templates \
    parent,
    page_size: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dataproc::V1beta2::ListWorkflowTemplatesRequest)
  @list_workflow_templates.call(req, options, &block)
end

#update_workflow_template(template, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dataproc::V1beta2::WorkflowTemplate

Updates (replaces) workflow template. The updated template must contain version that matches the current server version.

Examples:

require "google/cloud/dataproc"

workflow_template_client = Google::Cloud::Dataproc::WorkflowTemplateService.new(version: :v1beta2)

# TODO: Initialize `template`:
template = {}
response = workflow_template_client.update_workflow_template(template)

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



653
654
655
656
657
658
659
660
661
662
 
# File 'lib/google/cloud/dataproc/v1beta2/workflow_template_service_client.rb', line 653

def update_workflow_template \
    template,
    options: nil,
    &block
  req = {
    template: template
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Dataproc::V1beta2::UpdateWorkflowTemplateRequest)
  @update_workflow_template.call(req, options, &block)
end