REST Resource: projects.locations.repositories.workflowConfigs

Resource: WorkflowConfig
- JSON representation
ScheduledExecutionRecord
- JSON representation
Methods

Resource: WorkflowConfig

Represents a Dataform workflow configuration.

JSON representation

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

 { 
 "name" 
 : 
 string 
 , 
 "releaseConfig" 
 : 
 string 
 , 
 "invocationConfig" 
 : 
 { 
 object (  InvocationConfig 
 
) 
 } 
 , 
 "cronSchedule" 
 : 
 string 
 , 
 "timeZone" 
 : 
 string 
 , 
 "recentScheduledExecutionRecords" 
 : 
 [ 
 { 
 object (  ScheduledExecutionRecord 
 
) 
 } 
 ] 
 , 
 "disabled" 
 : 
 boolean 
 , 
 "createTime" 
 : 
 string 
 , 
 "updateTime" 
 : 
 string 
 , 
 "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 ( https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) . 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 uses 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 uses 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"` .
`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

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` . }

 { 
 "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 uses 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.

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.

REST Resource: projects.locations.repositories.workflowConfigs

Resource: WorkflowConfig

ScheduledExecutionRecord

Methods

`create`

`delete`

`get`

`list`

`patch`