REST Resource: projects.locations.repositories.workflowConfigs

Resource: WorkflowConfig

Represents a Dataform workflow configuration.

JSON representation 
{
  "name": string,
  "releaseConfig": string,
  "invocationConfig": {
    object (InvocationConfig)
  },
  "cronSchedule": string,
  "timeZone": string,
  "recentScheduledExecutionRecords": [
    {
      object (ScheduledExecutionRecord)
    }
  ],
  "disabled": boolean,
  "createTime": string,
  "updateTime": string,
  "workflowTriggerConfig": {
    object (WorkflowTriggerConfig)
  },
  "internalMetadata": string
}
Fields
name

string

Identifier. The workflow config's name.
releaseConfig

string

Required. The name of the release config whose releaseCompilationResult should be executed. Must be in the format projects/*/locations/*/repositories/*/releaseConfigs/*.
invocationConfig

object (InvocationConfig)

Optional. If left unset, a default InvocationConfig will be used.
cronSchedule

string

Optional. Optional schedule (in cron format) for automatic execution of this workflow config.
timeZone

string

Optional. Specifies the time zone to be used when interpreting cronSchedule. Must be a time zone name from the time zone database. If left unspecified, the default is UTC.
recentScheduledExecutionRecords[]

object (ScheduledExecutionRecord)

Output only. Records of the 10 most recent scheduled execution attempts, ordered in descending order of executionTime. Updated whenever automatic creation of a workflow invocation is triggered by cronSchedule.
disabled

boolean

Optional. Disables automatic creation of workflow invocations.
createTime

string (Timestamp format)

Output only. The timestamp of when the WorkflowConfig was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. The timestamp of when the WorkflowConfig was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
workflowTriggerConfig

object (WorkflowTriggerConfig)

Optional. Trigger configuration for this workflow. If present, the workflow will be triggered based on the specified triggers.
internalMetadata

string

Output only. All the metadata information that is used internally to serve the resource. For example: timestamps, flags, status fields, etc. The format of this field is a JSON string.

ScheduledExecutionRecord

A record of an attempt to create a workflow invocation for this workflow config.

JSON representation 
{
  "executionTime": string,

  // Union field result can be only one of the following:
  "workflowInvocation": string,
  "errorStatus": {
    object (Status)
  }
  // End of list of possible types for union field result.
}
Fields
executionTime

string (Timestamp format)

Output only. The timestamp of this execution attempt.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
Union field result. The result of this execution attempt. result can be only one of the following:
workflowInvocation

string

The name of the created workflow invocation, if one was successfully created. Must be in the format projects/*/locations/*/repositories/*/workflowInvocations/*.
errorStatus

object (Status)

The error status encountered upon this attempt to create the workflow invocation, if the attempt was unsuccessful.

WorkflowTriggerConfig

Represents a trigger configuration for a workflow.

JSON representation 
{
  "condition": enum (Condition),
  "workflowTriggers": [
    {
      object (WorkflowTrigger)
    }
  ],
  "minExecutionDuration": string,
  "maxWaitDuration": string,
  "recentTriggerEvaluationRecords": [
    {
      object (TriggerEvaluationRecord)
    }
  ],
  "lastSuccessfulEvaluationTime": string
}
Fields
condition

enum (Condition)

Optional. The condition to use when triggering the workflow.
workflowTriggers[]

object (WorkflowTrigger)

Required. The trigger definitions to invoke a workflow.
minExecutionDuration

string (Duration format)

Optional. Minimum duration between two consecutive executions. If not specified, the workflow will be executed every time trigger conditions are met and there is no ongoing workflow execution.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
maxWaitDuration

string (Duration format)

Optional. The effective maximum wait time duration for the trigger condition to be met. If not specified, the workflow won't be triggered until conditions are met.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
recentTriggerEvaluationRecords[]

object (TriggerEvaluationRecord)

Output only. Records of the 10 most recent trigger evaluations, ordered in descending order of evaluationTime. Updated whenever the service evaluates the trigger conditions (via polling or upon receiving a push event).
lastSuccessfulEvaluationTime

string (Timestamp format)

Output only. The timestamp of the last successful trigger evaluation.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

Condition

The condition to use when triggering the workflow.

Enums
CONDITION_UNSPECIFIED If CONDITION_UNSPECIFIED, the default value is ANY.
ALL If ALL, all the trigger config conditions must be met before a workflow is invoked.
ANY If ANY, at least one of the trigger config conditions must be met before a workflow is invoked.

WorkflowTrigger

The trigger definition to invoke a workflow.

JSON representation 
{

  // Union field trigger can be only one of the following:
  "tableUpdateTrigger": {
    object (TableUpdateTrigger)
  }
  // End of list of possible types for union field trigger.
}
Fields
Union field trigger. The trigger defining the conditions to invoke a workflow. trigger can be only one of the following:
tableUpdateTrigger

object (TableUpdateTrigger)

The table update trigger configuration.

TableUpdateTrigger

Represents a table update trigger configuration.

JSON representation 
{
  "table": {
    object (Target)
  },
  "triggerUpdateTime": string
}
Fields
table

object (Target)

The target table to trigger the workflow.
triggerUpdateTime

string (Timestamp format)

Output only. The modification time of this table that resulted in an invocation of the workflow. This would be updated by the triggering service after a successful workflow invocation.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

TriggerEvaluationRecord

A record of an attempt to evaluate trigger conditions.

JSON representation 
{
  "evaluationTime": string,
  "status": {
    object (Status)
  }
}
Fields
evaluationTime

string (Timestamp format)

Output only. The timestamp of this trigger evaluation attempt.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
status

object (Status)

Output only. The status of the trigger evaluation. Success is indicated by a code of 0 (OK). Message will only be present if the status code is non-zero.

Methods

create

 Creates a new WorkflowConfig in a given Repository.

delete

 Deletes a single WorkflowConfig.

get

 Fetches a single WorkflowConfig.

list

 Lists WorkflowConfigs in a given Repository.

patch

 Updates a single WorkflowConfig.