Interface Task.TriggerSpecOrBuilder (1.50.0)

Version latest

• 1.50.0 (latest)
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.2
• 1.0.1
• 0.2.2

public static interface Task.TriggerSpecOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDisabled()

public abstract boolean getDisabled()

Optional. Prevent the task from executing. This does not cancel already running tasks. It is intended to temporarily disable RECURRING tasks.

bool disabled = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The disabled.

getMaxRetries()

public abstract int getMaxRetries()

Optional. Number of retry attempts before aborting. Set to zero to never attempt to retry a failed task.

int32 max_retries = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The maxRetries.

getSchedule()

public abstract String 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 schedule = 100 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The schedule.

getScheduleBytes()

public abstract ByteString getScheduleBytes()

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 schedule = 100 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for schedule.

getStartTime()

public abstract Timestamp 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.

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

Returns
Type	Description
Timestamp	The startTime.

getStartTimeOrBuilder()

public abstract TimestampOrBuilder getStartTimeOrBuilder()

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.

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

Returns
Type	Description
TimestampOrBuilder

getTriggerCase()

public abstract Task.TriggerSpec.TriggerCase getTriggerCase()

Returns
Type	Description
Task.TriggerSpec.TriggerCase

getType()

public abstract Task.TriggerSpec.Type getType()

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

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

Returns
Type	Description
Task.TriggerSpec.Type	The type.

getTypeValue()

public abstract int getTypeValue()

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

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

Returns
Type	Description
int	The enum numeric value on the wire for type.

hasSchedule()

public abstract boolean hasSchedule()

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 schedule = 100 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the schedule field is set.

hasStartTime()

public abstract boolean hasStartTime()

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.

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

Returns
Type	Description
boolean	Whether the startTime field is set.