Cloud Dataplex v1 API - Class Task.Types.TriggerSpec (2.13.0) 

public sealed class Task.Types.TriggerSpec : IMessage<Task.Types.TriggerSpec>, IEquatable<Task.Types.TriggerSpec>, IDeepCloneable<Task.Types.TriggerSpec>, IBufferMessage, IMessage

Reference documentation and code samples for the Cloud Dataplex v1 API class Task.Types.TriggerSpec.

Task scheduling and trigger settings.

Inheritance

object > Task.Types.TriggerSpec

Namespace

Google.Cloud.Dataplex.V1

Assembly

Google.Cloud.Dataplex.V1.dll

Constructors

TriggerSpec()

public TriggerSpec()

TriggerSpec(TriggerSpec)

public TriggerSpec(Task.Types.TriggerSpec other)
Parameter
NameDescription
otherTaskTypesTriggerSpec

Properties

Disabled

public bool Disabled { get; set; }

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

Property Value
TypeDescription
bool

HasSchedule

public bool HasSchedule { get; }

Gets whether the "schedule" field is set

Property Value
TypeDescription
bool

MaxRetries

public int MaxRetries { get; set; }

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

Property Value
TypeDescription
int

Schedule

public string Schedule { get; set; }

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.

Property Value
TypeDescription
string

StartTime

public Timestamp StartTime { get; set; }

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.

Property Value
TypeDescription
Timestamp

TriggerCase

public Task.Types.TriggerSpec.TriggerOneofCase TriggerCase { get; }
Property Value
TypeDescription
TaskTypesTriggerSpecTriggerOneofCase

Type

public Task.Types.TriggerSpec.Types.Type Type { get; set; }

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

Property Value
TypeDescription
TaskTypesTriggerSpecTypesType