Contact UsGet started

Workflows Service, gRPC: WorkflowService.Update

Written by
Updated at October 17, 2024

Updates specified Workflow.

gRPC request

rpc Update (UpdateWorkflowRequest) returns (operation.Operation)

UpdateWorkflowRequest

{
  "workflowId": "string",
  "name": "string",
  "description": "string",
  "labels": "string",
  "specification": {
    // Includes only one of the fields `specYaml`
    "specYaml": "string"
    // end of the list of possible fields
  },
  "logOptions": {
    "disabled": "bool",
    // Includes only one of the fields `logGroupId`, `folderId`
    "logGroupId": "string",
    "folderId": "string",
    // end of the list of possible fields
    "minLevel": "Level"
  },
  "networkId": "string",
  "serviceAccountId": "string",
  "updateMask": "google.protobuf.FieldMask"
}

Field

Description

workflowId

string

Required field. ID of 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.

specification

WorkflowSpecification

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

updateMask

google.protobuf.FieldMask

Field mask that specifies which fields of the Workflow should be updated.

WorkflowSpecification

Field

Description

specYaml

string

Workflow specification in YAML format.

Includes only one of the fields specYaml.

LogOptions

Field

Description

disabled

bool

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.

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

operation.Operation

{
  "id": "string",
  "description": "string",
  "createdAt": "google.protobuf.Timestamp",
  "createdBy": "string",
  "modifiedAt": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "workflowId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "folderId": "string",
    "specification": {
      // Includes only one of the fields `specYaml`
      "specYaml": "string"
      // end of the list of possible fields
    },
    "createdAt": "google.protobuf.Timestamp",
    "name": "string",
    "description": "string",
    "labels": "string",
    "status": "Status",
    "logOptions": {
      "disabled": "bool",
      // Includes only one of the fields `logGroupId`, `folderId`
      "logGroupId": "string",
      "folderId": "string",
      // end of the list of possible fields
      "minLevel": "Level"
    },
    "networkId": "string",
    "serviceAccountId": "string"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

google.protobuf.Timestamp

Creation timestamp.

createdBy

string

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

modifiedAt

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

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

UpdateWorkflowMetadata

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

google.rpc.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

Workflow

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.

UpdateWorkflowMetadata

Field

Description

workflowId

string

Required field. ID of the Workflow.

Workflow

Field

Description

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

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.

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.

WorkflowSpecification

Field

Description

specYaml

string

Workflow specification in YAML format.

Includes only one of the fields specYaml.

LogOptions

Field

Description

disabled

bool

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.

  • 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
Create
Next
Get