| { |
| "auth": { |
| "oauth2": { |
| "scopes": { |
| "https://www.googleapis.com/auth/cloud-platform": { |
| "description": "View and manage your data across Google Cloud Platform services" |
| } |
| } |
| } |
| }, |
| "basePath": "", |
| "baseUrl": "https://workflows.googleapis.com/", |
| "batchPath": "batch", |
| "canonicalName": "Workflows", |
| "description": "", |
| "discoveryVersion": "v1", |
| "documentationLink": "https://cloud.google.com/workflows", |
| "fullyEncodeReservedExpansion": true, |
| "icons": { |
| "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| }, |
| "id": "workflows:v1beta", |
| "kind": "discovery#restDescription", |
| "mtlsRootUrl": "https://workflows.mtls.googleapis.com/", |
| "name": "workflows", |
| "ownerDomain": "google.com", |
| "ownerName": "Google", |
| "parameters": { |
| "$.xgafv": { |
| "description": "V1 error format.", |
| "enum": [ |
| "1", |
| "2" |
| ], |
| "enumDescriptions": [ |
| "v1 error format", |
| "v2 error format" |
| ], |
| "location": "query", |
| "type": "string" |
| }, |
| "access_token": { |
| "description": "OAuth access token.", |
| "location": "query", |
| "type": "string" |
| }, |
| "alt": { |
| "default": "json", |
| "description": "Data format for response.", |
| "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" |
| ], |
| "location": "query", |
| "type": "string" |
| }, |
| "callback": { |
| "description": "JSONP", |
| "location": "query", |
| "type": "string" |
| }, |
| "fields": { |
| "description": "Selector specifying which fields to include in a partial response.", |
| "location": "query", |
| "type": "string" |
| }, |
| "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.", |
| "location": "query", |
| "type": "string" |
| }, |
| "oauth_token": { |
| "description": "OAuth 2.0 token for the current user.", |
| "location": "query", |
| "type": "string" |
| }, |
| "prettyPrint": { |
| "default": "true", |
| "description": "Returns response with indentations and line breaks.", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "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.", |
| "location": "query", |
| "type": "string" |
| }, |
| "uploadType": { |
| "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
| "location": "query", |
| "type": "string" |
| }, |
| "upload_protocol": { |
| "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "protocol": "rest", |
| "resources": { |
| "projects": { |
| "resources": { |
| "locations": { |
| "methods": { |
| "get": { |
| "description": "Gets information about a location.", |
| "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}", |
| "httpMethod": "GET", |
| "id": "workflows.projects.locations.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Resource name for the location.", |
| "location": "path", |
| "pattern": "^projects/[^/]+/locations/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1beta/{+name}", |
| "response": { |
| "$ref": "Location" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "list": { |
| "description": "Lists information about the supported locations for this service.", |
| "flatPath": "v1beta/projects/{projectsId}/locations", |
| "httpMethod": "GET", |
| "id": "workflows.projects.locations.list", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "filter": { |
| "description": "The standard list filter.", |
| "location": "query", |
| "type": "string" |
| }, |
| "name": { |
| "description": "The resource that owns the locations collection, if applicable.", |
| "location": "path", |
| "pattern": "^projects/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "pageSize": { |
| "description": "The standard list page size.", |
| "format": "int32", |
| "location": "query", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "description": "The standard list page token.", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1beta/{+name}/locations", |
| "response": { |
| "$ref": "ListLocationsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| }, |
| "resources": { |
| "operations": { |
| "methods": { |
| "delete": { |
| "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`.", |
| "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", |
| "httpMethod": "DELETE", |
| "id": "workflows.projects.locations.operations.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "The name of the operation resource to be deleted.", |
| "location": "path", |
| "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1beta/{+name}", |
| "response": { |
| "$ref": "Empty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "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.", |
| "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", |
| "httpMethod": "GET", |
| "id": "workflows.projects.locations.operations.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "The name of the operation resource.", |
| "location": "path", |
| "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1beta/{+name}", |
| "response": { |
| "$ref": "Operation" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "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.", |
| "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/operations", |
| "httpMethod": "GET", |
| "id": "workflows.projects.locations.operations.list", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "filter": { |
| "description": "The standard list filter.", |
| "location": "query", |
| "type": "string" |
| }, |
| "name": { |
| "description": "The name of the operation's parent resource.", |
| "location": "path", |
| "pattern": "^projects/[^/]+/locations/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "pageSize": { |
| "description": "The standard list page size.", |
| "format": "int32", |
| "location": "query", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "description": "The standard list page token.", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1beta/{+name}/operations", |
| "response": { |
| "$ref": "ListOperationsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| }, |
| "workflows": { |
| "methods": { |
| "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.", |
| "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/workflows", |
| "httpMethod": "POST", |
| "id": "workflows.projects.locations.workflows.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. Project and location in which the workflow should be created. Format: projects/{project}/locations/{location}", |
| "location": "path", |
| "pattern": "^projects/[^/]+/locations/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "workflowId": { |
| "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.", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1beta/{+parent}/workflows", |
| "request": { |
| "$ref": "Workflow" |
| }, |
| "response": { |
| "$ref": "Operation" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes a workflow with the specified name. This method also cancels and deletes all running executions of the workflow.", |
| "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}", |
| "httpMethod": "DELETE", |
| "id": "workflows.projects.locations.workflows.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the workflow to be deleted. Format: projects/{project}/locations/{location}/workflows/{workflow}", |
| "location": "path", |
| "pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1beta/{+name}", |
| "response": { |
| "$ref": "Operation" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "get": { |
| "description": "Gets details of a single Workflow.", |
| "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}", |
| "httpMethod": "GET", |
| "id": "workflows.projects.locations.workflows.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Name of the workflow which information should be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}", |
| "location": "path", |
| "pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1beta/{+name}", |
| "response": { |
| "$ref": "Workflow" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "list": { |
| "description": "Lists Workflows in a given project and location. The default order is not specified.", |
| "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/workflows", |
| "httpMethod": "GET", |
| "id": "workflows.projects.locations.workflows.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "filter": { |
| "description": "Filter to restrict results to specific workflows.", |
| "location": "query", |
| "type": "string" |
| }, |
| "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" |
| }, |
| "pageSize": { |
| "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", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "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.", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. Project and location from which the workflows should be listed. Format: projects/{project}/locations/{location}", |
| "location": "path", |
| "pattern": "^projects/[^/]+/locations/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1beta/{+parent}/workflows", |
| "response": { |
| "$ref": "ListWorkflowsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| }, |
| "patch": { |
| "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.", |
| "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/workflows/{workflowsId}", |
| "httpMethod": "PATCH", |
| "id": "workflows.projects.locations.workflows.patch", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}", |
| "location": "path", |
| "pattern": "^projects/[^/]+/locations/[^/]+/workflows/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "updateMask": { |
| "description": "List of fields to be updated. If not present, the entire workflow will be updated.", |
| "format": "google-fieldmask", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1beta/{+name}", |
| "request": { |
| "$ref": "Workflow" |
| }, |
| "response": { |
| "$ref": "Operation" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/cloud-platform" |
| ] |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "revision": "20200828", |
| "rootUrl": "https://workflows.googleapis.com/", |
| "schemas": { |
| "Empty": { |
| "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 `{}`.", |
| "id": "Empty", |
| "properties": {}, |
| "type": "object" |
| }, |
| "ListLocationsResponse": { |
| "description": "The response message for Locations.ListLocations.", |
| "id": "ListLocationsResponse", |
| "properties": { |
| "locations": { |
| "description": "A list of locations that matches the specified filter in the request.", |
| "items": { |
| "$ref": "Location" |
| }, |
| "type": "array" |
| }, |
| "nextPageToken": { |
| "description": "The standard List next-page token.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "ListOperationsResponse": { |
| "description": "The response message for Operations.ListOperations.", |
| "id": "ListOperationsResponse", |
| "properties": { |
| "nextPageToken": { |
| "description": "The standard List next-page token.", |
| "type": "string" |
| }, |
| "operations": { |
| "description": "A list of operations that matches the specified filter in the request.", |
| "items": { |
| "$ref": "Operation" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "ListWorkflowsResponse": { |
| "description": "Response for the ListWorkflows method.", |
| "id": "ListWorkflowsResponse", |
| "properties": { |
| "nextPageToken": { |
| "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": "string" |
| }, |
| "unreachable": { |
| "description": "Unreachable resources.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "workflows": { |
| "description": "The workflows which match the request.", |
| "items": { |
| "$ref": "Workflow" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "Location": { |
| "description": "A resource that represents Google Cloud Platform location.", |
| "id": "Location", |
| "properties": { |
| "displayName": { |
| "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", |
| "type": "string" |
| }, |
| "labels": { |
| "additionalProperties": { |
| "type": "string" |
| }, |
| "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", |
| "type": "object" |
| }, |
| "locationId": { |
| "description": "The canonical id for this location. For example: `\"us-east1\"`.", |
| "type": "string" |
| }, |
| "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" |
| }, |
| "name": { |
| "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "Operation": { |
| "description": "This resource represents a long-running operation that is the result of a network API call.", |
| "id": "Operation", |
| "properties": { |
| "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" |
| }, |
| "error": { |
| "$ref": "Status", |
| "description": "The error result of the operation in case of failure or cancellation." |
| }, |
| "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" |
| }, |
| "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" |
| }, |
| "response": { |
| "additionalProperties": { |
| "description": "Properties of the object. Contains field @type with type URL.", |
| "type": "any" |
| }, |
| "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`.", |
| "type": "object" |
| } |
| }, |
| "type": "object" |
| }, |
| "OperationMetadata": { |
| "description": "Represents the metadata of the long-running operation.", |
| "id": "OperationMetadata", |
| "properties": { |
| "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": { |
| "description": "The time the operation finished running.", |
| "format": "google-datetime", |
| "type": "string" |
| }, |
| "target": { |
| "description": "Server-defined resource path for the target of the operation.", |
| "type": "string" |
| }, |
| "verb": { |
| "description": "Name of the verb executed by the operation.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "Status": { |
| "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).", |
| "id": "Status", |
| "properties": { |
| "code": { |
| "description": "The status code, which should be an enum value of google.rpc.Code.", |
| "format": "int32", |
| "type": "integer" |
| }, |
| "details": { |
| "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", |
| "items": { |
| "additionalProperties": { |
| "description": "Properties of the object. Contains field @type with type URL.", |
| "type": "any" |
| }, |
| "type": "object" |
| }, |
| "type": "array" |
| }, |
| "message": { |
| "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.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "Workflow": { |
| "description": "Workflow program to be executed by Workflows.", |
| "id": "Workflow", |
| "properties": { |
| "createTime": { |
| "description": "Output only. The timestamp of when the workflow was created.", |
| "format": "google-datetime", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "description": { |
| "description": "Description of the workflow provided by the user. Must be at most 1000 unicode characters long.", |
| "type": "string" |
| }, |
| "labels": { |
| "additionalProperties": { |
| "type": "string" |
| }, |
| "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.", |
| "type": "object" |
| }, |
| "name": { |
| "description": "The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow}", |
| "type": "string" |
| }, |
| "revisionCreateTime": { |
| "description": "Output only. The timestamp that the latest revision of the workflow was created.", |
| "format": "google-datetime", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "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" |
| }, |
| "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" |
| }, |
| "sourceContents": { |
| "description": "Workflow code to be executed. The size limit is 32KB.", |
| "type": "string" |
| }, |
| "state": { |
| "description": "Output only. State of the workflow deployment.", |
| "enum": [ |
| "STATE_UNSPECIFIED", |
| "ACTIVE" |
| ], |
| "enumDescriptions": [ |
| "Invalid state.", |
| "The workflow has been deployed successfully and is serving." |
| ], |
| "readOnly": true, |
| "type": "string" |
| }, |
| "updateTime": { |
| "description": "Output only. The last update timestamp of the workflow.", |
| "format": "google-datetime", |
| "readOnly": true, |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| } |
| }, |
| "servicePath": "", |
| "title": "Workflows API", |
| "version": "v1beta", |
| "version_module": true |
| } |
