Workflows Service, REST: Workflow methods
Set of methods for managing Workflows.
JSON Representation
{
"id": "string",
"folderId": "string",
"specification": {
"specYaml": "string"
},
"createdAt": "string",
"name": "string",
"description": "string",
"labels": "object",
"status": "string",
"logOptions": {
"disabled": true,
"minLevel": "string",
// `logOptions` includes only one of the fields `logGroupId`, `folderId`
"logGroupId": "string",
"folderId": "string",
// end of the list of possible fields`logOptions`
},
"networkId": "string",
"serviceAccountId": "string"
}
Field | Description |
---|---|
id | string ID of the Workflow. Generated at creation time. |
folderId | string ID of the folder that the Workflow belongs to. |
specification | object Specification of the Workflow |
specification. specYaml |
string Workflow specification in YAML format. |
createdAt | string (date-time) Creation timestamp for the Workflow. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits). |
name | string Name of the Workflow. The name is unique within the folder. |
description | string Description of the Workflow. |
labels | object Workflow labels as |
status | string Status of the Workflow.
|
logOptions | object Options for logging from the Workflow. |
logOptions. disabled |
boolean (boolean) Is logging from Workflow disabled. |
logOptions. minLevel |
string Minimum logs level. See [LogLevel.Level] for details.
|
logOptions. logGroupId |
string logOptions includes only one of the fields logGroupId , folderId ID of the logging group which should be used for Workflows logs. |
logOptions. folderId |
string logOptions includes only one of the fields logGroupId , folderId ID of the folder which default logging group should be used for Workflows. |
networkId | string ID of the VPC network Workflow will be executed in, in order to access private resources. |
serviceAccountId | string ID of the Service Account which will be used for resource access in Workflow execution. |
Methods
Method | Description |
---|---|
create | Creates Workflow in specified folder. |
delete | Deletes specified Workflow. |
get | Retrieves specified Workflow. |
list | Retrieves list of Workflows in specified folder. |
listOperations | Lists operations for specified Workflow. |
update | Updates specified Workflow. |