Skip to main content

types

Execution​

Status​

  • STATUS_UNSPECIFIED

  • QUEUED

    Workflow execution is being queued.

  • RUNNING

    Workflow execution is running.

  • PAUSED

    Workflow execution is being paused.

  • STOPPED

    Workflow execution is stopped.

  • FAILED

    Workflow execution is failed.

  • FINISHED

    Workflow execution is finished.

id : string​

ID of the Workflow execution. Generated at creation time.

workflowId : string​

ID of the Workflow.

input : ExecutionInput​

Input data for the Workflow execution.

result : ExecutionResult​

Result of the Workflow execution.

error : ExecutionError​

Error details, in case Workflow execution failed.

status : Status​

Status of the Workflow execution

startedAt : google.protobuf.Timestamp​

Start timestamp for the Workflow execution.

duration : google.protobuf.Duration​

Duration of the Workflow execution.

ExecutionError​

message : string​

Error message of the Workflow execution.

errorCode : string​

Error code of the Workflow execution.

ExecutionInput​

One of input​

  • inputJson : string​

    JSON input data for the Workflow execution.

ExecutionPreview​

id : string​

ID of the Workflow execution. Generated at creation time.

workflowId : string​

ID of the Workflow.

status : Execution.Status​

Status of the Workflow execution

startedAt : google.protobuf.Timestamp​

Start timestamp for the Workflow execution.

duration : google.protobuf.Duration​

Duration of the Workflow execution.

ExecutionResult​

One of result​

  • resultJson : string​

    JSON result of the Workflow execution.

HistoryEntry​

Status​

  • STATUS_UNSPECIFIED

  • SCHEDULED

    Step execution is being scheduled.

  • STARTED

    Step execution is started.

  • COMPLETED

    Step execution is completed.

  • FAILED

    Step execution is failed.

  • CANCEL_REQUESTED

    Step execution is requested to be cancelled.

  • CANCELLED

    Step execution is canceled.

FailedAttempt​

startedAt : google.protobuf.Timestamp​

Start timestamp for the attempt.

duration : google.protobuf.Duration​

Duration of the attempt.

error : HistoryEntryError​

Error details.

id : string​

ID of the Workflow step.

title : string​

Title of the Workflow step.

description : string​

Description of the Workflow step.

startedAt : google.protobuf.Timestamp​

Start timestamp for the Workflow step.

duration : google.protobuf.Duration​

Duration of the Workflow step.

input : HistoryEntryInput​

Input data for the Workflow step.

output : HistoryEntryOutput​

Result of the Workflow step.

error : HistoryEntryError​

Error details, in case Workflow step failed.

status : Status​

Status of the Workflow step.

type : string​

Type of the Workflow step (for example, FunctionCall or HttpCall).

attempts : int64​

Number of attempts (including all retries of unsuccessful attempts). Value "1" means there were no retries.

lastError : HistoryEntryError​

Last received error details in case of retries.

HistoryEntryError​

message : string​

Error message of the Workflow step.

errorCode : string​

Error code of the Workflow step.

HistoryEntryInput​

  • inputJson : string​

    JSON input data for the Workflow step.

HistoryEntryOutput​

One of output​

  • outputJson : string​

    JSON result for the Workflow step.

LogOptions​

disabled : bool​

Is logging from Workflow disabled.

One of destination​

  • logGroupId : string​

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

  • folderId : string​

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

minLevel : yandex.cloud.logging.v1.LogLevel.Level​

Minimum logs level.

See LogLevel.Level for details.

Workflow​

Status​

  • STATUS_UNSPECIFIED

  • CREATING

    Workflow is being created.

  • ACTIVE

    Workflow is ready for use.

  • UPDATING

    Workflow is being updated.

  • DELETING

    Workflow is being deleted.

  • ERROR

    Workflow failed. The only allowed action is delete.

id : string​

ID of the Workflow. Generated at creation time.

folderId : string​

ID of the folder that the Workflow belongs to.

specification : WorkflowSpecification​

Specification of the Workflow

createdAt : google.protobuf.Timestamp​

Creation timestamp for the Workflow.

name : string​

Name of the Workflow. The name is unique within the folder.

description : string​

Description of the Workflow.

labels : string​

Workflow labels as key:value pairs.

status : Status​

Status of the Workflow.

logOptions : LogOptions​

Options for logging from the 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 resource access in Workflow execution.

WorkflowPreview​

id : string​

ID of the Workflow. Generated at creation time.

folderId : string​

ID of the folder that the Workflow belongs to.

createdAt : google.protobuf.Timestamp​

Creation timestamp for the Workflow.

name : string​

Name of the Workflow. The name is unique within the folder.

description : string​

Description of the Workflow.

labels : string​

Workflow labels as key:value pairs.

status : Workflow.Status​

Status of the Workflow.

logOptions : LogOptions​

Options for logging from the 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.

WorkflowSpecification​

One of spec​

  • specYaml : string​

    Workflow specification in YAML format.