Workflows Service, REST: Workflow.Create

Field

Description

folderId

string

Required field. ID of the folder to create Workflow in.

name

string

Required field. Name of Workflow.
The name must be unique within the folder.

Value must match the regular expression |[a-z]([-a-z0-9]{0,61}[a-z0-9])?.

description

string

Description of Workflow.

The maximum string length in characters is 256.

labels

object (map<string, string>)

Workflow labels as key:value pairs.

The maximum string length in characters for each value is 63. The string length in characters for each key must be 1-63. Each key must match the regular expression [a-z][-_./\@0-9a-z]*. Each value must match the regular expression [-_./\@0-9a-z]*. No more than 64 per resource.

specification

WorkflowSpecification

Required field. Specification of Workflow

logOptions

LogOptions

Options for logging from Workflow.

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 resources access in Workflow execution.

express

boolean

Express execution mode.

schedule

WorkflowSchedule

Workflow schedule settings.

isPublic

boolean

Ability of the Workflow to be executed without authentication.

Field

Description

specYaml

string

Workflow specification in YAML format.

Includes only one of the fields specYaml.

Field

Description

disabled

boolean

Is logging from Workflow disabled.

logGroupId

string

ID of the logging group which should be used for Workflows logs.

Includes only one of the fields logGroupId, folderId.

folderId

string

ID of the folder which default logging group should be used for Workflows.

Includes only one of the fields logGroupId, folderId.

minLevel

enum (Level)

Minimum logs level.
See LogLevel.Level for details.

• TRACE: Trace log level.
  Possible use case: verbose logging of some business logic.
• DEBUG: Debug log level.
  Possible use case: debugging special cases in application logic.
• INFO: Info log level.
  Mostly used for information messages.
• WARN: Warn log level.
  May be used to alert about significant events.
• ERROR: Error log level.
  May be used to alert about errors in infrastructure, logic, etc.
• FATAL: Fatal log level.
  May be used to alert about unrecoverable failures and events.

Field

Description

cronExpression

string

Required field. Cron expression for the Workflow schedule.

The maximum string length in characters is 100.

timezone

string

Required field. Timezone for the Workflow schedule.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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).

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

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).

done

boolean

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.

metadata

object

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

object

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 the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.