Reference documentation and code samples for the Google Cloud Dataplex V1 Client class TriggerSpec.
Task scheduling and trigger settings.
Generated from protobuf message google.cloud.dataplex.v1.Task.TriggerSpec
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ type
int
Required. Immutable. Trigger type of the user-specified Task.
↳ start_time
Google\Protobuf\Timestamp
Optional. The first run of the task will be after this time. If not specified, the task will run shortly after being submitted if ON_DEMAND and based on the schedule if RECURRING.
↳ disabled
bool
Optional. Prevent the task from executing. This does not cancel already running tasks. It is intended to temporarily disable RECURRING tasks.
↳ max_retries
int
Optional. Number of retry attempts before aborting. Set to zero to never attempt to retry a failed task.
↳ schedule
string
Optional. Cron schedule ( https://en.wikipedia.org/wiki/Cron
) for running tasks periodically. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, CRON_TZ=America/New_York 1 * * * *
, or TZ=America/New_York 1 * * * *
. This field is required for RECURRING tasks.
getType
Required. Immutable. Trigger type of the user-specified Task.
int
setType
Required. Immutable. Trigger type of the user-specified Task.
var
int
$this
getStartTime
Optional. The first run of the task will be after this time.
If not specified, the task will run shortly after being submitted if ON_DEMAND and based on the schedule if RECURRING.
hasStartTime
clearStartTime
setStartTime
Optional. The first run of the task will be after this time.
If not specified, the task will run shortly after being submitted if ON_DEMAND and based on the schedule if RECURRING.
$this
getDisabled
Optional. Prevent the task from executing.
This does not cancel already running tasks. It is intended to temporarily disable RECURRING tasks.
bool
setDisabled
Optional. Prevent the task from executing.
This does not cancel already running tasks. It is intended to temporarily disable RECURRING tasks.
var
bool
$this
getMaxRetries
Optional. Number of retry attempts before aborting.
Set to zero to never attempt to retry a failed task.
int
setMaxRetries
Optional. Number of retry attempts before aborting.
Set to zero to never attempt to retry a failed task.
var
int
$this
getSchedule
Optional. Cron schedule ( https://en.wikipedia.org/wiki/Cron
) for
running tasks periodically. To explicitly set a timezone to the cron
tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or
"TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid
string from IANA time zone database. For example, CRON_TZ=America/New_York 1 * * * *
,
or TZ=America/New_York 1 * * * *
.
This field is required for RECURRING tasks.
string
hasSchedule
setSchedule
Optional. Cron schedule ( https://en.wikipedia.org/wiki/Cron
) for
running tasks periodically. To explicitly set a timezone to the cron
tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or
"TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid
string from IANA time zone database. For example, CRON_TZ=America/New_York 1 * * * *
,
or TZ=America/New_York 1 * * * *
.
This field is required for RECURRING tasks.
var
string
$this
getTrigger
string
