Class: Google::Cloud::Dataproc::V1::WorkflowTemplateServiceClient
- Inherits:
-
Object
- Object
- Google::Cloud::Dataproc::V1::WorkflowTemplateServiceClient
- Defined in:
- lib/google/cloud/dataproc/v1/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
-
.region_path(project, region) ⇒ String
Returns a fully-qualified region resource name string.
-
.workflow_template_path(project, region, workflow_template) ⇒ String
Returns a fully-qualified workflow_template resource name string.
Instance Method Summary collapse
-
#create_workflow_template(parent, template, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dataproc::V1::WorkflowTemplate
Creates new workflow template.
-
#delete_workflow_template(name, version: nil, options: nil) {|result, operation| ... } ⇒ Object
Deletes a workflow template.
-
#get_workflow_template(name, version: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dataproc::V1::WorkflowTemplate
Retrieves the latest workflow template.
-
#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ WorkflowTemplateServiceClient
constructor
A new instance of WorkflowTemplateServiceClient.
-
#instantiate_inline_workflow_template(parent, template, request_id: nil, options: nil) ⇒ Google::Gax::Operation
Instantiates a template and begins execution.
-
#instantiate_workflow_template(name, version: nil, request_id: nil, parameters: nil, options: nil) ⇒ Google::Gax::Operation
Instantiates a template and begins execution.
-
#list_workflow_templates(parent, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Cloud::Dataproc::V1::WorkflowTemplate>
Lists workflows that match the specified filter in the request.
-
#update_workflow_template(template, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dataproc::V1::WorkflowTemplate
Updates (replaces) workflow template.
Constructor Details
#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ WorkflowTemplateServiceClient
Returns a new instance of WorkflowTemplateServiceClient.
142 143 144 145 146 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 |
# File 'lib/google/cloud/dataproc/v1/workflow_template_service_client.rb', line 142 def initialize \ credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: 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/v1/workflow_templates_services_pb" credentials ||= Google::Cloud::Dataproc::V1::Credentials.default @operations_client = OperationsClient.new( credentials: credentials, scopes: scopes, client_config: client_config, timeout: timeout, lib_name: lib_name, lib_version: lib_version, ) if credentials.is_a?(String) || credentials.is_a?(Hash) updater_proc = Google::Cloud::Dataproc::V1::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 = Gem.loaded_specs['google-cloud-dataproc'].version.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!() unless .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.v1.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 = self.class::SERVICE_ADDRESS 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::V1::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 ) @get_workflow_template = Google::Gax.create_api_call( @workflow_template_service_stub.method(:get_workflow_template), defaults["get_workflow_template"], exception_transformer: exception_transformer ) @instantiate_workflow_template = Google::Gax.create_api_call( @workflow_template_service_stub.method(:instantiate_workflow_template), defaults["instantiate_workflow_template"], exception_transformer: exception_transformer ) @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 ) @update_workflow_template = Google::Gax.create_api_call( @workflow_template_service_stub.method(:update_workflow_template), defaults["update_workflow_template"], exception_transformer: exception_transformer ) @list_workflow_templates = Google::Gax.create_api_call( @workflow_template_service_stub.method(:list_workflow_templates), defaults["list_workflow_templates"], exception_transformer: exception_transformer ) @delete_workflow_template = Google::Gax.create_api_call( @workflow_template_service_stub.method(:delete_workflow_template), defaults["delete_workflow_template"], exception_transformer: exception_transformer ) end |
Class Method Details
.region_path(project, region) ⇒ String
Returns a fully-qualified region resource name string.
93 94 95 96 97 98 |
# File 'lib/google/cloud/dataproc/v1/workflow_template_service_client.rb', line 93 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.
105 106 107 108 109 110 111 |
# File 'lib/google/cloud/dataproc/v1/workflow_template_service_client.rb', line 105 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::V1::WorkflowTemplate
Creates new workflow template.
292 293 294 295 296 297 298 299 300 301 302 303 |
# File 'lib/google/cloud/dataproc/v1/workflow_template_service_client.rb', line 292 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::V1::CreateWorkflowTemplateRequest) @create_workflow_template.call(req, , &block) end |
#delete_workflow_template(name, version: nil, options: nil) {|result, operation| ... } ⇒ Object
Deletes a workflow template. It does not cancel in-progress workflows.
673 674 675 676 677 678 679 680 681 682 683 684 685 |
# File 'lib/google/cloud/dataproc/v1/workflow_template_service_client.rb', line 673 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::V1::DeleteWorkflowTemplateRequest) @delete_workflow_template.call(req, , &block) nil end |
#get_workflow_template(name, version: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dataproc::V1::WorkflowTemplate
Retrieves the latest workflow template.
Can retrieve previously instantiated template by specifying optional version parameter.
334 335 336 337 338 339 340 341 342 343 344 345 |
# File 'lib/google/cloud/dataproc/v1/workflow_template_service_client.rb', line 334 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::V1::GetWorkflowTemplateRequest) @get_workflow_template.call(req, , &block) end |
#instantiate_inline_workflow_template(parent, template, 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.
On successful completion, Operation#response will be Empty.
534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 |
# File 'lib/google/cloud/dataproc/v1/workflow_template_service_client.rb', line 534 def instantiate_inline_workflow_template \ parent, template, request_id: nil, options: nil req = { parent: parent, template: template, request_id: request_id }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Dataproc::V1::InstantiateInlineWorkflowTemplateRequest) operation = Google::Gax::Operation.new( @instantiate_inline_workflow_template.call(req, ), @operations_client, Google::Protobuf::Empty, Google::Cloud::Dataproc::V1::WorkflowMetadata, call_options: ) operation.on_done { |operation| yield(operation) } if block_given? operation end |
#instantiate_workflow_template(name, version: 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.
On successful completion, Operation#response will be Empty.
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 |
# File 'lib/google/cloud/dataproc/v1/workflow_template_service_client.rb', line 428 def instantiate_workflow_template \ name, version: nil, request_id: nil, parameters: nil, options: nil req = { name: name, version: version, request_id: request_id, parameters: parameters }.delete_if { |_, v| v.nil? } req = Google::Gax::to_proto(req, Google::Cloud::Dataproc::V1::InstantiateWorkflowTemplateRequest) operation = Google::Gax::Operation.new( @instantiate_workflow_template.call(req, ), @operations_client, Google::Protobuf::Empty, Google::Cloud::Dataproc::V1::WorkflowMetadata, call_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::V1::WorkflowTemplate>
Lists workflows that match the specified filter in the request.
636 637 638 639 640 641 642 643 644 645 646 647 |
# File 'lib/google/cloud/dataproc/v1/workflow_template_service_client.rb', line 636 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::V1::ListWorkflowTemplatesRequest) @list_workflow_templates.call(req, , &block) end |
#update_workflow_template(template, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Dataproc::V1::WorkflowTemplate
Updates (replaces) workflow template. The updated template must contain version that matches the current server version.
582 583 584 585 586 587 588 589 590 591 |
# File 'lib/google/cloud/dataproc/v1/workflow_template_service_client.rb', line 582 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::V1::UpdateWorkflowTemplateRequest) @update_workflow_template.call(req, , &block) end |