Class: Google::Apis::WorkflowsV1::WorkflowsService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::WorkflowsV1::WorkflowsService
- Defined in:
- lib/google/apis/workflows_v1/service.rb
Overview
Workflows API
Manage workflow definitions. To execute workflows and manage executions, see the Workflows Executions API.
Constant Summary collapse
- DEFAULT_ENDPOINT_TEMPLATE =
"https://workflows.$UNIVERSE_DOMAIN$/"
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Instance Method Summary collapse
-
#create_project_location_workflow(parent, workflow_object = nil, workflow_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WorkflowsV1::Operation
Creates a new workflow.
-
#delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WorkflowsV1::Empty
Deletes a long-running operation.
-
#delete_project_location_workflow(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WorkflowsV1::Operation
Deletes a workflow with the specified name.
-
#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WorkflowsV1::Location
Gets information about a location.
-
#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WorkflowsV1::Operation
Gets the latest state of a long-running operation.
-
#get_project_location_workflow(name, revision_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WorkflowsV1::Workflow
Gets details of a single workflow.
-
#initialize ⇒ WorkflowsService
constructor
A new instance of WorkflowsService.
-
#list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WorkflowsV1::ListOperationsResponse
Lists operations that match the specified filter in the request.
-
#list_project_location_workflow_revisions(name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WorkflowsV1::ListWorkflowRevisionsResponse
Lists revisions for a given workflow.
-
#list_project_location_workflows(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WorkflowsV1::ListWorkflowsResponse
Lists workflows in a given project and location.
-
#list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WorkflowsV1::ListLocationsResponse
Lists information about the supported locations for this service.
-
#patch_project_location_workflow(name, workflow_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WorkflowsV1::Operation
Updates an existing workflow.
Constructor Details
#initialize ⇒ WorkflowsService
Returns a new instance of WorkflowsService.
48 49 50 51 52 53 |
# File 'lib/google/apis/workflows_v1/service.rb', line 48 def initialize super(DEFAULT_ENDPOINT_TEMPLATE, '', client_name: 'google-apis-workflows_v1', client_version: Google::Apis::WorkflowsV1::GEM_VERSION) @batch_path = 'batch' end |
Instance Attribute Details
#key ⇒ String
Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
41 42 43 |
# File 'lib/google/apis/workflows_v1/service.rb', line 41 def key @key end |
#quota_user ⇒ String
Returns 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.
46 47 48 |
# File 'lib/google/apis/workflows_v1/service.rb', line 46 def quota_user @quota_user end |
Instance Method Details
#create_project_location_workflow(parent, workflow_object = nil, workflow_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WorkflowsV1::Operation
Creates a new workflow. If a workflow with the specified name already exists in the specified project and location, the long running operation returns a ALREADY_EXISTS error.
262 263 264 265 266 267 268 269 270 271 272 273 |
# File 'lib/google/apis/workflows_v1/service.rb', line 262 def create_project_location_workflow(parent, workflow_object = nil, workflow_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+parent}/workflows', ) command.request_representation = Google::Apis::WorkflowsV1::Workflow::Representation command.request_object = workflow_object command.response_representation = Google::Apis::WorkflowsV1::Operation::Representation command.response_class = Google::Apis::WorkflowsV1::Operation command.params['parent'] = parent unless parent.nil? command.query['workflowId'] = workflow_id unless workflow_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 |
#delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WorkflowsV1::Empty
Deletes a long-running operation. This method indicates that the client is no
longer interested in the operation result. It does not cancel the operation.
If the server doesn't support this method, it returns google.rpc.Code.
UNIMPLEMENTED
.
151 152 153 154 155 156 157 158 159 |
# File 'lib/google/apis/workflows_v1/service.rb', line 151 def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) command.response_representation = Google::Apis::WorkflowsV1::Empty::Representation command.response_class = Google::Apis::WorkflowsV1::Empty command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#delete_project_location_workflow(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WorkflowsV1::Operation
Deletes a workflow with the specified name. This method also cancels and deletes all running executions of the workflow.
297 298 299 300 301 302 303 304 305 |
# File 'lib/google/apis/workflows_v1/service.rb', line 297 def delete_project_location_workflow(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) command.response_representation = Google::Apis::WorkflowsV1::Operation::Representation command.response_class = Google::Apis::WorkflowsV1::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WorkflowsV1::Location
Gets information about a location.
75 76 77 78 79 80 81 82 83 |
# File 'lib/google/apis/workflows_v1/service.rb', line 75 def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::WorkflowsV1::Location::Representation command.response_class = Google::Apis::WorkflowsV1::Location command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WorkflowsV1::Operation
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
182 183 184 185 186 187 188 189 190 |
# File 'lib/google/apis/workflows_v1/service.rb', line 182 def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::WorkflowsV1::Operation::Representation command.response_class = Google::Apis::WorkflowsV1::Operation command.params['name'] = name unless name.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#get_project_location_workflow(name, revision_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WorkflowsV1::Workflow
Gets details of a single workflow.
333 334 335 336 337 338 339 340 341 342 |
# File 'lib/google/apis/workflows_v1/service.rb', line 333 def get_project_location_workflow(name, revision_id: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) command.response_representation = Google::Apis::WorkflowsV1::Workflow::Representation command.response_class = Google::Apis::WorkflowsV1::Workflow command.params['name'] = name unless name.nil? command.query['revisionId'] = revision_id unless revision_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 |
#list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WorkflowsV1::ListOperationsResponse
Lists operations that match the specified filter in the request. If the server
doesn't support this method, it returns UNIMPLEMENTED
.
219 220 221 222 223 224 225 226 227 228 229 230 |
# File 'lib/google/apis/workflows_v1/service.rb', line 219 def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}/operations', ) command.response_representation = Google::Apis::WorkflowsV1::ListOperationsResponse::Representation command.response_class = Google::Apis::WorkflowsV1::ListOperationsResponse command.params['name'] = name unless name.nil? command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_location_workflow_revisions(name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WorkflowsV1::ListWorkflowRevisionsResponse
Lists revisions for a given workflow.
426 427 428 429 430 431 432 433 434 435 436 |
# File 'lib/google/apis/workflows_v1/service.rb', line 426 def list_project_location_workflow_revisions(name, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}:listRevisions', ) command.response_representation = Google::Apis::WorkflowsV1::ListWorkflowRevisionsResponse::Representation command.response_class = Google::Apis::WorkflowsV1::ListWorkflowRevisionsResponse command.params['name'] = name unless name.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_location_workflows(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WorkflowsV1::ListWorkflowsResponse
Lists workflows in a given project and location. The default order is not specified.
384 385 386 387 388 389 390 391 392 393 394 395 396 |
# File 'lib/google/apis/workflows_v1/service.rb', line 384 def list_project_location_workflows(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+parent}/workflows', ) command.response_representation = Google::Apis::WorkflowsV1::ListWorkflowsResponse::Representation command.response_class = Google::Apis::WorkflowsV1::ListWorkflowsResponse command.params['parent'] = parent unless parent.nil? command.query['filter'] = filter unless filter.nil? command.query['orderBy'] = order_by unless order_by.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WorkflowsV1::ListLocationsResponse
Lists information about the supported locations for this service.
115 116 117 118 119 120 121 122 123 124 125 126 |
# File 'lib/google/apis/workflows_v1/service.rb', line 115 def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}/locations', ) command.response_representation = Google::Apis::WorkflowsV1::ListLocationsResponse::Representation command.response_class = Google::Apis::WorkflowsV1::ListLocationsResponse command.params['name'] = name unless name.nil? command.query['filter'] = filter unless filter.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |
#patch_project_location_workflow(name, workflow_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WorkflowsV1::Operation
Updates an existing workflow. Running this method has no impact on already running executions of the workflow. A new revision of the workflow might be created as a result of a successful update operation. In that case, the new revision is used in new workflow executions.
467 468 469 470 471 472 473 474 475 476 477 478 |
# File 'lib/google/apis/workflows_v1/service.rb', line 467 def patch_project_location_workflow(name, workflow_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:patch, 'v1/{+name}', ) command.request_representation = Google::Apis::WorkflowsV1::Workflow::Representation command.request_object = workflow_object command.response_representation = Google::Apis::WorkflowsV1::Operation::Representation command.response_class = Google::Apis::WorkflowsV1::Operation command.params['name'] = name unless name.nil? command.query['updateMask'] = update_mask unless update_mask.nil? command.query['fields'] = fields unless fields.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? execute_or_queue_command(command, &block) end |