generated/google-apis-dataproc_v1beta2/lib/google/apis/dataproc_v1beta2/service.rb
# 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 (https://cloud.
# google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#
# workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/
# dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On
# successful completion, Operation.response will be Empty.
# @param [String] parent
#   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 [Google::Apis::DataprocV1beta2::WorkflowTemplate] workflow_template_object
# @param [String] instance_id
#   Deprecated. Please use request_id field instead.
# @param [String] request_id
#   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 [String] fields
#   Selector specifying which fields to include in a partial response.
# @param [String] quota_user
#   Available to use for quota purposes for server-side applications. Can be any
#   arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
#   Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataprocV1beta2::Operation] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataprocV1beta2::Operation]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
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.
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 .
def instantiate_project_location_workflow_template_inline(parent, workflow_template_object = nil, instance_id: nil, request_id: nil, fields: nil, quota_user: nil, options: nil, &block)
          command = make_simple_command(:post, 'v1beta2/{+parent}/workflowTemplates:instantiateInline', options)
          command.request_representation = Google::Apis::DataprocV1beta2::WorkflowTemplate::Representation
          command.request_object = workflow_template_object
          command.response_representation = Google::Apis::DataprocV1beta2::Operation::Representation
          command.response_class = Google::Apis::DataprocV1beta2::Operation
          command.params['parent'] = parent unless parent.nil?
          command.query['instanceId'] = instance_id unless instance_id.nil?
          command.query['requestId'] = request_id unless request_id.nil?
          command.query['fields'] = fields unless fields.nil?
          command.query['quotaUser'] = quota_user unless quota_user.nil?
          execute_or_queue_command(command, &block)
        end
def instantiate_project_location_workflow_template_inline ( parent , workflow_template_object = nil , instance_id : nil , request_id : nil , fields : nil , quota_user : nil , options : nil , & block ) command = make_simple_command ( :post , 'v1beta2/{+parent}/workflowTemplates:instantiateInline' , options ) command . request_representation = Google :: Apis :: DataprocV1beta2 :: WorkflowTemplate :: Representation command . request_object = workflow_template_object command . response_representation = Google :: Apis :: DataprocV1beta2 :: Operation :: Representation command . response_class = Google :: Apis :: DataprocV1beta2 :: Operation command . params [ 'parent' ] = parent unless parent . nil? command . query [ 'instanceId' ] = instance_id unless instance_id . nil? command . query [ 'requestId' ] = request_id unless request_id . nil? command . query [ 'fields' ] = fields unless fields . nil? command . query [ 'quotaUser' ] = quota_user unless quota_user . nil? execute_or_queue_command ( command , & block ) end
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.
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 .
None
Google::Apis::DataprocV1beta2::Operation
[Google::Apis::ServerError] An error occurred on the server and the request can be retried
[ Google :: Apis :: ServerError ] An error occurred on the server and the request can be retried
[Google::Apis::ClientError] The request is invalid and should not be retried without modification
[ Google :: Apis :: ClientError ] The request is invalid and should not be retried without modification
[Google::Apis::AuthorizationError] Authorization is required
[ Google :: Apis :: AuthorizationError ] Authorization is required
parent
workflow_template_object
instance_id
request_id
fields
quota_user
options
block
options Request-specific options
options Request - specific options
]
Result & error if block supplied
Result & error if block supplied
result
parsed result object
parsed result object
err
error object if request failed
error object if request failed