REST Resource: projects.locations.repositories.workflowInvocations

Resource: WorkflowInvocation

Represents a single invocation of a compilation result.

JSON representation
{
  "name": string,
  "invocationConfig": {
    object (InvocationConfig)
  },
  "state": enum (State),
  "invocationTiming": {
    object (Interval)
  },
  "resolvedCompilationResult": string,
  "dataEncryptionState": {
    object (DataEncryptionState)
  },

  // Union field compilation_source can be only one of the following:
  "compilationResult": string,
  "workflowConfig": string
  // End of list of possible types for union field compilation_source.
}
Fields
name

string

Output only. The workflow invocation's name.

invocationConfig

object (InvocationConfig)

Immutable. If left unset, a default InvocationConfig will be used.

state

enum (State)

Output only. This workflow invocation's current state.

invocationTiming

object (Interval)

Output only. This workflow invocation's timing details.

resolvedCompilationResult

string

Output only. The resolved compilation result that was used to create this invocation. Will be in the format projects/*/locations/*/repositories/*/compilationResults/*.

dataEncryptionState

object (DataEncryptionState)

Output only. Only set if the repository has a KMS Key.

Union field compilation_source.

compilation_source can be only one of the following:

compilationResult

string

Immutable. The name of the compilation result to use for this invocation. Must be in the format projects/*/locations/*/repositories/*/compilationResults/*.

workflowConfig

string

Immutable. The name of the workflow config to invoke. Must be in the format projects/*/locations/*/repositories/*/workflowConfigs/*.

State

Represents the current state of a workflow invocation.

Enums
STATE_UNSPECIFIED Default value. This value is unused.
RUNNING The workflow invocation is currently running.
SUCCEEDED The workflow invocation succeeded. A terminal state.
CANCELLED The workflow invocation was cancelled. A terminal state.
FAILED The workflow invocation failed. A terminal state.
CANCELING The workflow invocation is being cancelled, but some actions are still running.

Interval

Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).

The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time.

JSON representation
{
  "startTime": string,
  "endTime": string
}
Fields
startTime

string (Timestamp format)

Optional. Inclusive start of the interval.

If specified, a Timestamp matching this interval will have to be the same or after the start.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

Optional. Exclusive end of the interval.

If specified, a Timestamp matching this interval will have to be before the end.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Methods

cancel

Requests cancellation of a running WorkflowInvocation.

create

Creates a new WorkflowInvocation in a given Repository.

delete

Deletes a single WorkflowInvocation.

get

Fetches a single WorkflowInvocation.

list

Lists WorkflowInvocations in a given Repository.

query

Returns WorkflowInvocationActions in a given WorkflowInvocation.