| { |
| "version": "v1beta", |
| "fullyEncodeReservedExpansion": true, |
| "auth": { |
| "oauth2": { |
| "scopes": { |
| "https://www.googleapis.com/auth/cloud-platform": { |
| "description": "View and manage your data across Google Cloud Platform services" |
| } |
| } |
| } |
| }, |
| "mtlsRootUrl": "https://workflows.mtls.googleapis.com/", |
| "basePath": "", |
| "discoveryVersion": "v1", |
| "title": "Workflows API", |
| "documentationLink": "https://cloud.google.com/workflows", |
| "version_module": true, |
| "description": "Orchestrate Workflows consisting of Google Cloud APIs, SaaS APIs or private API endpoints.", |
| "schemas": { |
| "Workflow": { |
| "properties": { |
| "description": { |
| "description": "Description of the workflow provided by the user. Must be at most 1000 unicode characters long.", |
| "type": "string" |
| }, |
| "serviceAccount": { |
| "description": "Name of the service account associated with the latest workflow version. This service account represents the identity of the workflow and determines what permissions the workflow has. Format: projects/{project}/serviceAccounts/{account} Using `-` as a wildcard for the `{project}` will infer the project from the account. The `{account}` value can be the `email` address or the `unique_id` of the service account. If not provided, workflow will use the project's default service account. Modifying this field for an existing workflow results in a new workflow revision.", |
| "type": "string" |
| }, |
| "labels": { |
| "type": "object", |
| "description": "Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores and dashes. Label keys must start with a letter. International characters are allowed.", |
| "additionalProperties": { |
| "type": "string" |
| } |
| }, |
| "createTime": { |
| "description": "Output only. The timestamp of when the workflow was created.", |
| "type": "string", |
| "format": "google-datetime", |
| "readOnly": true |
| }, |
| "sourceContents": { |
| "type": "string", |
| "description": "Workflow code to be executed. The size limit is 32KB." |
| }, |
| "revisionCreateTime": { |
| "format": "google-datetime", |
| "description": "Output only. The timestamp that the latest revision of the workflow was created.", |
| "type": "string", |
| "readOnly": true |
| }, |
| "revisionId": { |
| "description": "Output only. The revision of the workflow. A new revision of a workflow is created as a result of updating the following fields of a workflow: - `source_code` - `service_account` The format is \"000001-a4d\", where the first 6 characters define the zero-padded revision ordinal number. They are followed by a hyphen and 3 hexadecimal random characters.", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "state": { |
| "type": "string", |
| "description": "Output only. State of the workflow deployment.", |
| "readOnly": true, |
| "enum": [ |
| "STATE_UNSPECIFIED", |
| "ACTIVE" |
| ], |
| "enumDescriptions": [ |
| "Invalid state.", |
| "The workflow has been deployed successfully and is serving." |
| ] |
| }, |
| "name": { |
| "description": "The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}", |
| "type": "string" |
| }, |
| "updateTime": { |
| "description": "Output only. The last update timestamp of the workflow.", |
| "readOnly": true, |
| "type": "string", |
| "format": "google-datetime" |
| } |
| }, |
| "id": "Workflow", |
| "type": "object", |
| "description": "Workflow program to be executed by Workflows." |
| }, |
| "Location": { |
| "type": "object", |
| "properties": { |
| "name": { |
| "type": "string", |
| "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`" |
| }, |
| "displayName": { |
| "type": "string", |
| "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\"." |
| }, |
| "locationId": { |
| "type": "string", |
| "description": "The canonical id for this location. For example: `\"us-east1\"`." |
| }, |
| "labels": { |
| "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", |
| "additionalProperties": { |
| "type": "string" |
| }, |
| "type": "object" |
| }, |
| "metadata": { |
| "additionalProperties": { |
| "description": "Properties of the object. Contains field @type with type URL.", |
| "type": "any" |
| }, |
| "description": "Service-specific metadata. For example the available capacity at the given location.", |
| "type": "object" |
| } |
| }, |
| "id": "Location", |
| "description": "A resource that represents Google Cloud Platform location." |
| }, |
| "ListOperationsResponse": { |
| "type": "object", |
| "description": "The response message for Operations.ListOperations.", |
| "id": "ListOperationsResponse", |
| "properties": { |
| "operations": { |
| "type": "array", |
| "items": { |
| "$ref": "Operation" |
| }, |
| "description": "A list of operations that matches the specified filter in the request." |
| }, |
| "nextPageToken": { |
| "type": "string", |
| "description": "The standard List next-page token." |
| } |
| } |
| }, |
| "OperationMetadata": { |
| "id": "OperationMetadata", |
| "description": "Represents the metadata of the long-running operation.", |
| "type": "object", |
| "properties": { |
| "verb": { |
| "description": "Name of the verb executed by the operation.", |
| "type": "string" |
| }, |
| "target": { |
| "description": "Server-defined resource path for the target of the operation.", |
| "type": "string" |
| }, |
| "apiVersion": { |
| "description": "API version used to start the operation.", |
| "type": "string" |
| }, |
| "createTime": { |
| "description": "The time the operation was created.", |
| "format": "google-datetime", |
| "type": "string" |
| }, |
| "endTime": { |
| "type": "string", |
| "description": "The time the operation finished running.", |
| "format": "google-datetime" |
| } |
| } |
| }, |
| "ListWorkflowsResponse": { |
| "id": "ListWorkflowsResponse", |
| "properties": { |
| "workflows": { |
| "items": { |
| "$ref": "Workflow" |
| }, |
| "type": "array", |
| "description": "The workflows which match the request." |
| }, |
| "unreachable": { |
| "items": { |
| "type": "string" |
| }, |
| "description": "Unreachable resources.", |
| "type": "array" |
| }, |
| "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." |
| } |
| }, |
| "type": "object", |
| "description": "Response for the ListWorkflows method." |
| }, |
| "ListLocationsResponse": { |
| "properties": { |
| "nextPageToken": { |
| "description": "The standard List next-page token.", |
| "type": "string" |
| }, |
| "locations": { |
| "description": "A list of locations that matches the specified filter in the request.", |
| "items": { |
| "$ref": "Location" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object", |
| "id": "ListLocationsResponse", |
| "description": "The response message for Locations.ListLocations." |
| }, |
| "Empty": { |
| "type": "object", |
| "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.", |
| "properties": {}, |
| "id": "Empty" |
| }, |
| "Status": { |
| "type": "object", |
| "id": "Status", |
| "properties": { |
| "details": { |
| "type": "array", |
| "items": { |
| "additionalProperties": { |
| "description": "Properties of the object. Contains field @type with type URL.", |
| "type": "any" |
| }, |
| "type": "object" |
| }, |
| "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use." |
| }, |
| "code": { |
| "description": "The status code, which should be an enum value of google.rpc.Code.", |
| "format": "int32", |
| "type": "integer" |
| }, |
| "message": { |
| "type": "string", |
| "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client." |
| } |
| }, |
| "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors)." |
| }, |
| "Operation": { |
| "id": "Operation", |
| "description": "This resource represents a long-running operation that is the result of a network API call.", |
| "properties": { |
| "error": { |
| "description": "The error result of the operation in case of failure or cancellation.", |
| "$ref": "Status" |
| }, |
| "response": { |
| "additionalProperties": { |
| "type": "any", |
| "description": "Properties of the object. Contains field @type with type URL." |
| }, |
| "type": "object", |
| "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`." |
| }, |
| "name": { |
| "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", |
| "type": "string" |
| }, |
| "metadata": { |
| "additionalProperties": { |
| "description": "Properties of the object. Contains field @type with type URL.", |
| "type": "any" |
| }, |
| "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", |
| "type": "object" |
| }, |
| "done": { |
| "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", |
| "type": "boolean" |
| } |
| }, |
| "type": "object" |
| } |
| }, |
| "icons": { |
| "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| }, |
| "baseUrl": "https://workflows.googleapis.com/", |
| "protocol": "rest", |
| "servicePath": "", |
| "parameters": { |
| "alt": { |
| "location": "query", |
| "default": "json", |
| "enumDescriptions": [ |
| "Responses with Content-Type of application/json", |
| "Media download with context-dependent Content-Type", |
| "Responses with Content-Type of application/x-protobuf" |
| ], |
| "description": "Data format for response.", |
| "type": "string", |
| "enum": [ |
| "json", |
| "media", |
| "proto" |
| ] |
| }, |
| "quotaUser": { |
| "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.", |
| "type": "string", |
| "location": "query" |
| }, |
| "oauth_token": { |
| "location": "query", |
| "description": "OAuth 2.0 token for the current user.", |
| "type": "string" |
| }, |
| "$.xgafv": { |
| "enumDescriptions": [ |
| "v1 error format", |
| "v2 error format" |
| ], |
| "type": "string", |
| "description": "V1 error format.", |
| "location": "query", |
| "enum": [ |
| "1", |
| "2" |
| ] |
| }, |
| "fields": { |
| "description": "Selector specifying which fields to include in a partial response.", |
| "type": "string", |
| "location": "query" |
| }, |
| "key": { |
| "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", |
| "location": "query" |
| }, |
| "upload_protocol": { |
| "location": "query", |
| "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", |
| "type": "string" |
| }, |
| "prettyPrint": { |
| "type": "boolean", |
| "default": "true", |
| "location": "query", |
| "description": "Returns response with indentations and line breaks." |
| }, |
| "access_token": { |
| "location": "query", |
| "description": "OAuth access token.", |
| "type": "string" |
| }, |
| "uploadType": { |
| "location": "query", |
| "type": "string", |
| "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." |
| }, |
| "callback": { |
| "type": "string", |
| "description": "JSONP", |
| "location": "query" |
| } |
| }, |
| "batchPath": "batch", |
| "name": "workflows", |
| "canonicalName": "Workflows", |
| "ownerName": "Google", |
| "id": "workflows:v1beta", |
| "ownerDomain": "google.com", |
| "resources": { |
| "projects": { |
| "resources": { |
| "locations": { |
| "resources": { |
| "workflows": { |
| "methods": { |
| "create": { |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "parameters": { |
| "workflowId": { |
| "type": "string", |
| "location": "query", |
| "description": "Required. The ID of the workflow to be created. It has to fulfill the following requirements: * Must contain only letters, numbers, underscores and hyphens. * Must start with a letter. * Must be between 1-64 characters. * Must end with a number or a letter. * Must be unique within the customer project and location." |
| }, |
| "parent": { |
| "location": "path", |
| "type": "string", |
| "description": "Required. Project and location in which the workflow should be created. Format: projects/{project}/locations/{location}", |
| "required": true, |
| "pattern": "^projects/[^/]+/locations/[^/]+$" |
| } |
| }, |
| "parameterOrder": [ |
| "parent" |
| ], |
| "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/workflows", |
| "httpMethod": "POST", |
| "response": { |
| "$ref": "Operation" |
| }, |
| "request": { |
| "$ref": "Workflow" |
| }, |
| "path": "v1beta/{+parent}/workflows", |
| "id": "workflows.projects.locations.workflows.create", |
| "description": "Creates a new workflow. If a workflow with the specified name already exists in the specified project and location, the long running operation will return ALREADY_EXISTS error." |
| }, |
| "list": { |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "parameterOrder": [ |
| "parent" |
| ], |
| "httpMethod": "GET", |
| "path": "v1beta/{+parent}/workflows", |
| "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/workflows", |
| "response": { |
| "$ref": "ListWorkflowsResponse" |
| }, |
| "description": "Lists Workflows in a given project and location. The default order is not specified.", |
| "id": "workflows.projects.locations.workflows.list", |
| "parameters": { |
| "orderBy": { |
| "description": "Comma-separated list of fields that that specify the order of the results. Default sorting order for a field is ascending. To specify descending order for a field, append a \" desc\" suffix. If not specified, the results will be returned in an unspecified order.", |
| "location": "query", |
| "type": "string" |
| }, |
| "pageToken": { |
| "type": "string", |
| "location": "query", |
| "description": "A page token, received from a previous `ListWorkflows` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWorkflows` must match the call that provided the page token." |
| }, |
| "parent": { |
| "type": "string", |
| "location": "path", |
| "description": "Required. Project and location from which the workflows should be listed. Format: projects/{project}/locations/{location}", |
| "pattern": "^projects/[^/]+/locations/[^/]+$", |
| "required": true |
| }, |
| "pageSize": { |
| "type": "integer", |
| "description": "Maximum number of workflows to return per call. The service may return fewer than this value. If the value is not specified, a default value of 500 will be used. The maximum permitted value is 1000 and values greater than 1000 will be coerced down to 1000.", |
| "format": "int32", |
| "location": "query" |
| }, |
| "filter": { |
| "type": "string", |
| "location": "query", |
| "description": "Filter to restrict results to specific workflows." |
| } |
| } |
| }, |
| "delete": { |
| "description": "Deletes a workflow with the specified name. This method also cancels and deletes all running executions of the workflow.", |
| "httpMethod": "DELETE", |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}", |
| "parameterOrder": [ |
| "name" |
| ], |
| "id": "workflows.projects.locations.workflows.delete", |
| "path": "v1beta/{+name}", |
| "response": { |
| "$ref": "Operation" |
| }, |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the workflow to be deleted. Format: projects/{project}/locations/{location}/workflows/{workflow}", |
| "required": true, |
| "pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+$", |
| "location": "path", |
| "type": "string" |
| } |
| } |
| }, |
| "get": { |
| "response": { |
| "$ref": "Workflow" |
| }, |
| "path": "v1beta/{+name}", |
| "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}", |
| "httpMethod": "GET", |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the workflow which information should be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}", |
| "location": "path", |
| "type": "string", |
| "pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+$", |
| "required": true |
| } |
| }, |
| "parameterOrder": [ |
| "name" |
| ], |
| "description": "Gets details of a single Workflow.", |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "id": "workflows.projects.locations.workflows.get" |
| }, |
| "patch": { |
| "request": { |
| "$ref": "Workflow" |
| }, |
| "response": { |
| "$ref": "Operation" |
| }, |
| "id": "workflows.projects.locations.workflows.patch", |
| "path": "v1beta/{+name}", |
| "description": "Updates an existing workflow. Running this method has no impact on already running executions of the workflow. A new revision of the workflow may be created as a result of a successful update operation. In that case, such revision will be used in new workflow executions.", |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "parameters": { |
| "updateMask": { |
| "description": "List of fields to be updated. If not present, the entire workflow will be updated.", |
| "type": "string", |
| "format": "google-fieldmask", |
| "location": "query" |
| }, |
| "name": { |
| "description": "The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}", |
| "pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+$", |
| "type": "string", |
| "location": "path", |
| "required": true |
| } |
| }, |
| "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}", |
| "parameterOrder": [ |
| "name" |
| ], |
| "httpMethod": "PATCH" |
| } |
| } |
| }, |
| "operations": { |
| "methods": { |
| "delete": { |
| "id": "workflows.projects.locations.operations.delete", |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "description": "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`.", |
| "parameters": { |
| "name": { |
| "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", |
| "type": "string", |
| "location": "path", |
| "required": true, |
| "description": "The name of the operation resource to be deleted." |
| } |
| }, |
| "httpMethod": "DELETE", |
| "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", |
| "parameterOrder": [ |
| "name" |
| ], |
| "response": { |
| "$ref": "Empty" |
| }, |
| "path": "v1beta/{+name}" |
| }, |
| "list": { |
| "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `\"/v1/{name=users/*}/operations\"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", |
| "path": "v1beta/{+name}/operations", |
| "httpMethod": "GET", |
| "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations", |
| "response": { |
| "$ref": "ListOperationsResponse" |
| }, |
| "id": "workflows.projects.locations.operations.list", |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "parameters": { |
| "name": { |
| "type": "string", |
| "location": "path", |
| "pattern": "^projects/[^/]+/locations/[^/]+$", |
| "description": "The name of the operation's parent resource.", |
| "required": true |
| }, |
| "pageToken": { |
| "location": "query", |
| "type": "string", |
| "description": "The standard list page token." |
| }, |
| "pageSize": { |
| "format": "int32", |
| "description": "The standard list page size.", |
| "type": "integer", |
| "location": "query" |
| }, |
| "filter": { |
| "type": "string", |
| "location": "query", |
| "description": "The standard list filter." |
| } |
| }, |
| "parameterOrder": [ |
| "name" |
| ] |
| }, |
| "get": { |
| "response": { |
| "$ref": "Operation" |
| }, |
| "description": "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.", |
| "path": "v1beta/{+name}", |
| "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "parameters": { |
| "name": { |
| "location": "path", |
| "description": "The name of the operation resource.", |
| "type": "string", |
| "required": true, |
| "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" |
| } |
| }, |
| "httpMethod": "GET", |
| "parameterOrder": [ |
| "name" |
| ], |
| "id": "workflows.projects.locations.operations.get" |
| } |
| } |
| } |
| }, |
| "methods": { |
| "list": { |
| "parameterOrder": [ |
| "name" |
| ], |
| "flatPath": "v1beta/projects/{projectsId}/locations", |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "id": "workflows.projects.locations.list", |
| "httpMethod": "GET", |
| "parameters": { |
| "pageSize": { |
| "type": "integer", |
| "format": "int32", |
| "description": "The standard list page size.", |
| "location": "query" |
| }, |
| "filter": { |
| "description": "The standard list filter.", |
| "location": "query", |
| "type": "string" |
| }, |
| "name": { |
| "description": "The resource that owns the locations collection, if applicable.", |
| "type": "string", |
| "location": "path", |
| "required": true, |
| "pattern": "^projects/[^/]+$" |
| }, |
| "pageToken": { |
| "location": "query", |
| "description": "The standard list page token.", |
| "type": "string" |
| } |
| }, |
| "description": "Lists information about the supported locations for this service.", |
| "path": "v1beta/{+name}/locations", |
| "response": { |
| "$ref": "ListLocationsResponse" |
| } |
| }, |
| "get": { |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ], |
| "response": { |
| "$ref": "Location" |
| }, |
| "httpMethod": "GET", |
| "parameterOrder": [ |
| "name" |
| ], |
| "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}", |
| "description": "Gets information about a location.", |
| "path": "v1beta/{+name}", |
| "id": "workflows.projects.locations.get", |
| "parameters": { |
| "name": { |
| "location": "path", |
| "description": "Resource name for the location.", |
| "pattern": "^projects/[^/]+/locations/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "kind": "discovery#restDescription", |
| "revision": "20201008", |
| "rootUrl": "https://workflows.googleapis.com/" |
| } |
