Google Cloud Dataplex V1 Client - Class TriggerSpec (0.1.6)

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.

Parameters
NameDescription
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.

Generated from protobuf field .google.cloud.dataplex.v1.Task.TriggerSpec.Type type = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
int

setType

Required. Immutable. Trigger type of the user-specified Task.

Generated from protobuf field .google.cloud.dataplex.v1.Task.TriggerSpec.Type type = 5 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter
NameDescription
var int
Returns
TypeDescription
$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.

Generated from protobuf field .google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Google\Protobuf\Timestamp|null

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.

Generated from protobuf field .google.protobuf.Timestamp start_time = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getDisabled

Optional. Prevent the task from executing.

This does not cancel already running tasks. It is intended to temporarily disable RECURRING tasks.

Generated from protobuf field bool disabled = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
bool

setDisabled

Optional. Prevent the task from executing.

This does not cancel already running tasks. It is intended to temporarily disable RECURRING tasks.

Generated from protobuf field bool disabled = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getMaxRetries

Optional. Number of retry attempts before aborting.

Set to zero to never attempt to retry a failed task.

Generated from protobuf field int32 max_retries = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

setMaxRetries

Optional. Number of retry attempts before aborting.

Set to zero to never attempt to retry a failed task.

Generated from protobuf field int32 max_retries = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
var int
Returns
TypeDescription
$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.

Generated from protobuf field string schedule = 100 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
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.

Generated from protobuf field string schedule = 100 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getTrigger

Returns
TypeDescription
string