Reference documentation and code samples for the Google Cloud Dataform V1beta1 Client class WorkflowTriggerConfig.
Represents a trigger configuration for a workflow.
Generated from protobuf message google.cloud.dataform.v1beta1.WorkflowTriggerConfig
Namespace
Google \ Cloud \ Dataform \ V1beta1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ condition |
int
Optional. The condition to use when triggering the workflow. |
↳ workflow_triggers |
array<WorkflowTrigger>
Required. The trigger definitions to invoke a workflow. |
↳ min_execution_duration |
Google\Protobuf\Duration
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. |
↳ max_wait_duration |
Google\Protobuf\Duration
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. |
↳ recent_trigger_evaluation_records |
array<TriggerEvaluationRecord>
Output only. Records of the 10 most recent trigger evaluations, ordered in descending order of |
↳ last_successful_evaluation_time |
Google\Protobuf\Timestamp
Output only. The timestamp of the last successful trigger evaluation. |
getCondition
Optional. The condition to use when triggering the workflow.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type Condition. |
setCondition
Optional. The condition to use when triggering the workflow.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type Condition. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getWorkflowTriggers
Required. The trigger definitions to invoke a workflow.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<WorkflowTrigger> |
|
setWorkflowTriggers
Required. The trigger definitions to invoke a workflow.
| Parameter | |
|---|---|
| Name | Description |
var |
array<WorkflowTrigger>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMinExecutionDuration
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasMinExecutionDuration
clearMinExecutionDuration
setMinExecutionDuration
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMaxWaitDuration
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasMaxWaitDuration
clearMaxWaitDuration
setMaxWaitDuration
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRecentTriggerEvaluationRecords
Output only. Records of the 10 most recent trigger evaluations, ordered
in descending order of evaluation_time. Updated whenever the service
evaluates the trigger conditions (via polling or upon receiving a push
event).
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<TriggerEvaluationRecord> |
|
setRecentTriggerEvaluationRecords
Output only. Records of the 10 most recent trigger evaluations, ordered
in descending order of evaluation_time. Updated whenever the service
evaluates the trigger conditions (via polling or upon receiving a push
event).
| Parameter | |
|---|---|
| Name | Description |
var |
array<TriggerEvaluationRecord>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLastSuccessfulEvaluationTime
Output only. The timestamp of the last successful trigger evaluation.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasLastSuccessfulEvaluationTime
clearLastSuccessfulEvaluationTime
setLastSuccessfulEvaluationTime
Output only. The timestamp of the last successful trigger evaluation.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|