Contact UsGet started
© 2025 Direct Cursus Technology L.L.C.

Workflows Service, gRPC: WorkflowService.Get

Written by
Updated at December 17, 2024

Retrieves specified Workflow.

gRPC request

rpc Get (GetWorkflowRequest) returns (GetWorkflowResponse)

GetWorkflowRequest

{
  "workflow_id": "string"
}

Field

Description

workflow_id

string

Required field. ID of the Workflow.

GetWorkflowResponse

{
  "workflow": {
    "id": "string",
    "folder_id": "string",
    "specification": {
      // Includes only one of the fields `spec_yaml`
      "spec_yaml": "string"
      // end of the list of possible fields
    },
    "created_at": "google.protobuf.Timestamp",
    "name": "string",
    "description": "string",
    "labels": "map<string, string>",
    "status": "Status",
    "log_options": {
      "disabled": "bool",
      // Includes only one of the fields `log_group_id`, `folder_id`
      "log_group_id": "string",
      "folder_id": "string",
      // end of the list of possible fields
      "min_level": "Level"
    },
    "network_id": "string",
    "service_account_id": "string"
  }
}

Field

Description

workflow

Workflow

Workflow properties.

Workflow

Field

Description

id

string

ID of the Workflow. Generated at creation time.

folder_id

string

ID of the folder that the Workflow belongs to.

specification

WorkflowSpecification

Specification of the Workflow

created_at

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

object (map<string, string>)

Workflow labels as key:value pairs.

status

enum Status

Status of the Workflow.

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

log_options

LogOptions

Options for logging from the Workflow.

network_id

string

ID of the VPC network Workflow will be executed in, in order to access private resources.

service_account_id

string

ID of the Service Account which will be used for resource access in Workflow execution.

WorkflowSpecification

Field

Description

spec_yaml

string

Workflow specification in YAML format.

Includes only one of the fields spec_yaml.

LogOptions

Field

Description

disabled

bool

Is logging from Workflow disabled.

log_group_id

string

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

Includes only one of the fields log_group_id, folder_id.

folder_id

string

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

Includes only one of the fields log_group_id, folder_id.

min_level

enum Level

Minimum logs level.

See LogLevel.Level for details.

  • LEVEL_UNSPECIFIED: Default log level.

    Equivalent to not specifying log level at all.

  • 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.
Previous
Update
Next
Delete