| { |
| "name": "workflowexecutions", |
| "fullyEncodeReservedExpansion": true, |
| "ownerDomain": "google.com", |
| "protocol": "rest", |
| "canonicalName": "Workflow Executions", |
| "schemas": { |
| "Error": { |
| "id": "Error", |
| "properties": { |
| "payload": { |
| "description": "Error payload returned by the execution, represented as a JSON string.", |
| "type": "string" |
| }, |
| "context": { |
| "description": "Human readable error context, helpful for debugging purposes.", |
| "type": "string" |
| } |
| }, |
| "description": "Error describes why the execution was abnormally terminated.", |
| "type": "object" |
| }, |
| "CancelExecutionRequest": { |
| "properties": {}, |
| "type": "object", |
| "description": "Request for the CancelExecution method.", |
| "id": "CancelExecutionRequest" |
| }, |
| "Execution": { |
| "properties": { |
| "workflowRevisionId": { |
| "readOnly": true, |
| "description": "Output only. Revision of the workflow this execution is using.", |
| "type": "string" |
| }, |
| "name": { |
| "readOnly": true, |
| "type": "string", |
| "description": "Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}" |
| }, |
| "startTime": { |
| "readOnly": true, |
| "description": "Output only. Marks the beginning of execution.", |
| "format": "google-datetime", |
| "type": "string" |
| }, |
| "result": { |
| "description": "Output only. Output of the execution represented as a JSON string. The value can only be present if the execution's state is `SUCCEEDED`.", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "error": { |
| "readOnly": true, |
| "$ref": "Error", |
| "description": "Output only. The error which caused the execution to finish prematurely. The value is only present if the execution's state is `FAILED` or `CANCELLED`." |
| }, |
| "argument": { |
| "description": "Input parameters of the execution represented as a JSON string. The size limit is 32KB.", |
| "type": "string" |
| }, |
| "endTime": { |
| "format": "google-datetime", |
| "type": "string", |
| "readOnly": true, |
| "description": "Output only. Marks the end of execution, successful or not." |
| }, |
| "state": { |
| "enum": [ |
| "STATE_UNSPECIFIED", |
| "ACTIVE", |
| "SUCCEEDED", |
| "FAILED", |
| "CANCELLED" |
| ], |
| "enumDescriptions": [ |
| "Invalid state.", |
| "The execution is in progress.", |
| "The execution finished successfully.", |
| "The execution failed with an error.", |
| "The execution was stopped intentionally." |
| ], |
| "type": "string", |
| "description": "Output only. Current state of the execution.", |
| "readOnly": true |
| } |
| }, |
| "id": "Execution", |
| "description": "A running instance of a [Workflow](/workflows/docs/reference/rest/v1beta/projects.locations.workflows).", |
| "type": "object" |
| }, |
| "ListExecutionsResponse": { |
| "type": "object", |
| "id": "ListExecutionsResponse", |
| "description": "Response for the ListExecutions method.", |
| "properties": { |
| "nextPageToken": { |
| "type": "string", |
| "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." |
| }, |
| "executions": { |
| "items": { |
| "$ref": "Execution" |
| }, |
| "description": "The executions which match the request.", |
| "type": "array" |
| } |
| } |
| } |
| }, |
| "documentationLink": "https://cloud.google.com/workflows", |
| "basePath": "", |
| "kind": "discovery#restDescription", |
| "servicePath": "", |
| "version": "v1beta", |
| "version_module": true, |
| "baseUrl": "https://workflowexecutions.googleapis.com/", |
| "revision": "20200923", |
| "batchPath": "batch", |
| "discoveryVersion": "v1", |
| "icons": { |
| "x32": "http://www.google.com/images/icons/product/search-32.gif", |
| "x16": "http://www.google.com/images/icons/product/search-16.gif" |
| }, |
| "id": "workflowexecutions:v1beta", |
| "rootUrl": "https://workflowexecutions.googleapis.com/", |
| "ownerName": "Google", |
| "title": "Workflow Executions API", |
| "resources": { |
| "projects": { |
| "resources": { |
| "locations": { |
| "resources": { |
| "workflows": { |
| "resources": { |
| "executions": { |
| "methods": { |
| "cancel": { |
| "description": "Cancels an execution of the given name.", |
| "path": "v1beta/{+name}:cancel", |
| "request": { |
| "$ref": "CancelExecutionRequest" |
| }, |
| "id": "workflowexecutions.projects.locations.workflows.executions.cancel", |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the execution to be cancelled. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}", |
| "pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+/executions/[^/]+$", |
| "required": true, |
| "type": "string", |
| "location": "path" |
| } |
| }, |
| "response": { |
| "$ref": "Execution" |
| }, |
| "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}/executions/{executionsId}:cancel", |
| "parameterOrder": [ |
| "name" |
| ], |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "httpMethod": "POST" |
| }, |
| "create": { |
| "description": "Creates a new execution using the latest revision of the given workflow.", |
| "parameters": { |
| "parent": { |
| "pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+$", |
| "description": "Required. Name of the workflow for which an execution should be created. Format: projects/{project}/locations/{location}/workflows/{workflow} The latest revision of the workflow will be used.", |
| "type": "string", |
| "location": "path", |
| "required": true |
| } |
| }, |
| "path": "v1beta/{+parent}/executions", |
| "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}/executions", |
| "httpMethod": "POST", |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "response": { |
| "$ref": "Execution" |
| }, |
| "request": { |
| "$ref": "Execution" |
| }, |
| "id": "workflowexecutions.projects.locations.workflows.executions.create", |
| "parameterOrder": [ |
| "parent" |
| ] |
| }, |
| "list": { |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "httpMethod": "GET", |
| "response": { |
| "$ref": "ListExecutionsResponse" |
| }, |
| "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}/executions", |
| "description": "Returns a list of executions which belong to the workflow with the given name. The method returns executions of all workflow revisions. Returned executions are ordered by their start time (newest first).", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "path": "v1beta/{+parent}/executions", |
| "id": "workflowexecutions.projects.locations.workflows.executions.list", |
| "parameters": { |
| "pageToken": { |
| "location": "query", |
| "description": "A page token, received from a previous `ListExecutions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListExecutions` must match the call that provided the page token.", |
| "type": "string" |
| }, |
| "pageSize": { |
| "format": "int32", |
| "description": "Maximum number of executions to return per call. Max supported value depends on the selected Execution view: it's 10000 for BASIC and 100 for FULL. The default value used if the field is not specified is 100, regardless of the selected view. Values greater than the max value will be coerced down to it.", |
| "location": "query", |
| "type": "integer" |
| }, |
| "view": { |
| "description": "Optional. A view defining which fields should be filled in the returned executions. The API will default to the BASIC view.", |
| "location": "query", |
| "enumDescriptions": [ |
| "The default / unset value.", |
| "Includes only basic metadata about the execution. Following fields are returned: name, start_time, end_time, state and workflow_revision_id.", |
| "Includes all data." |
| ], |
| "enum": [ |
| "EXECUTION_VIEW_UNSPECIFIED", |
| "BASIC", |
| "FULL" |
| ], |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}", |
| "required": true, |
| "location": "path", |
| "pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+$", |
| "type": "string" |
| } |
| } |
| }, |
| "get": { |
| "path": "v1beta/{+name}", |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "parameterOrder": [ |
| "name" |
| ], |
| "response": { |
| "$ref": "Execution" |
| }, |
| "parameters": { |
| "name": { |
| "pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+/executions/[^/]+$", |
| "required": true, |
| "type": "string", |
| "description": "Required. Name of the execution to be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}", |
| "location": "path" |
| }, |
| "view": { |
| "type": "string", |
| "enum": [ |
| "EXECUTION_VIEW_UNSPECIFIED", |
| "BASIC", |
| "FULL" |
| ], |
| "enumDescriptions": [ |
| "The default / unset value.", |
| "Includes only basic metadata about the execution. Following fields are returned: name, start_time, end_time, state and workflow_revision_id.", |
| "Includes all data." |
| ], |
| "description": "Optional. A view defining which fields should be filled in the returned execution. The API will default to the FULL view.", |
| "location": "query" |
| } |
| }, |
| "httpMethod": "GET", |
| "id": "workflowexecutions.projects.locations.workflows.executions.get", |
| "description": "Returns an execution of the given name.", |
| "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}/executions/{executionsId}" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "mtlsRootUrl": "https://workflowexecutions.mtls.googleapis.com/", |
| "auth": { |
| "oauth2": { |
| "scopes": { |
| "https://www.googleapis.com/auth/cloud-platform": { |
| "description": "View and manage your data across Google Cloud Platform services" |
| } |
| } |
| } |
| }, |
| "parameters": { |
| "uploadType": { |
| "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
| "type": "string", |
| "location": "query" |
| }, |
| "quotaUser": { |
| "location": "query", |
| "type": "string", |
| "description": "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." |
| }, |
| "key": { |
| "location": "query", |
| "description": "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.", |
| "type": "string" |
| }, |
| "alt": { |
| "enum": [ |
| "json", |
| "media", |
| "proto" |
| ], |
| "enumDescriptions": [ |
| "Responses with Content-Type of application/json", |
| "Media download with context-dependent Content-Type", |
| "Responses with Content-Type of application/x-protobuf" |
| ], |
| "default": "json", |
| "location": "query", |
| "description": "Data format for response.", |
| "type": "string" |
| }, |
| "access_token": { |
| "type": "string", |
| "location": "query", |
| "description": "OAuth access token." |
| }, |
| "oauth_token": { |
| "location": "query", |
| "type": "string", |
| "description": "OAuth 2.0 token for the current user." |
| }, |
| "$.xgafv": { |
| "enum": [ |
| "1", |
| "2" |
| ], |
| "description": "V1 error format.", |
| "enumDescriptions": [ |
| "v1 error format", |
| "v2 error format" |
| ], |
| "type": "string", |
| "location": "query" |
| }, |
| "upload_protocol": { |
| "type": "string", |
| "location": "query", |
| "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." |
| }, |
| "callback": { |
| "location": "query", |
| "type": "string", |
| "description": "JSONP" |
| }, |
| "fields": { |
| "description": "Selector specifying which fields to include in a partial response.", |
| "location": "query", |
| "type": "string" |
| }, |
| "prettyPrint": { |
| "location": "query", |
| "type": "boolean", |
| "description": "Returns response with indentations and line breaks.", |
| "default": "true" |
| } |
| }, |
| "description": "Execute workflows created with Workflows API." |
| } |
