Class Task.TriggerSpec (1.31.0)

public static final class Task.TriggerSpec extends GeneratedMessageV3 implements Task.TriggerSpecOrBuilder

Task scheduling and trigger settings.

Protobuf type google.cloud.dataplex.v1.Task.TriggerSpec

Static Fields

DISABLED_FIELD_NUMBER

public static final int DISABLED_FIELD_NUMBER
Field Value
TypeDescription
int

MAX_RETRIES_FIELD_NUMBER

public static final int MAX_RETRIES_FIELD_NUMBER
Field Value
TypeDescription
int

SCHEDULE_FIELD_NUMBER

public static final int SCHEDULE_FIELD_NUMBER
Field Value
TypeDescription
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Task.TriggerSpec getDefaultInstance()
Returns
TypeDescription
Task.TriggerSpec

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Task.TriggerSpec.Builder newBuilder()
Returns
TypeDescription
Task.TriggerSpec.Builder

newBuilder(Task.TriggerSpec prototype)

public static Task.TriggerSpec.Builder newBuilder(Task.TriggerSpec prototype)
Parameter
NameDescription
prototypeTask.TriggerSpec
Returns
TypeDescription
Task.TriggerSpec.Builder

parseDelimitedFrom(InputStream input)

public static Task.TriggerSpec parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Task.TriggerSpec
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Task.TriggerSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Task.TriggerSpec
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Task.TriggerSpec parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Task.TriggerSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Task.TriggerSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Task.TriggerSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Task.TriggerSpec parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Task.TriggerSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Task.TriggerSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Task.TriggerSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Task.TriggerSpec parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Task.TriggerSpec
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Task.TriggerSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Task.TriggerSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Task.TriggerSpec parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Task.TriggerSpec
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Task.TriggerSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Task.TriggerSpec
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Task.TriggerSpec parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Task.TriggerSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Task.TriggerSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Task.TriggerSpec
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Task.TriggerSpec> parser()
Returns
TypeDescription
Parser<TriggerSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Task.TriggerSpec getDefaultInstanceForType()
Returns
TypeDescription
Task.TriggerSpec

getDisabled()

public 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
TypeDescription
boolean

The disabled.

getMaxRetries()

public 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
TypeDescription
int

The maxRetries.

getParserForType()

public Parser<Task.TriggerSpec> getParserForType()
Returns
TypeDescription
Parser<TriggerSpec>
Overrides

getSchedule()

public 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
TypeDescription
String

The schedule.

getScheduleBytes()

public 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
TypeDescription
ByteString

The bytes for schedule.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStartTime()

public 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
TypeDescription
Timestamp

The startTime.

getStartTimeOrBuilder()

public 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
TypeDescription
TimestampOrBuilder

getTriggerCase()

public Task.TriggerSpec.TriggerCase getTriggerCase()
Returns
TypeDescription
Task.TriggerSpec.TriggerCase

getType()

public 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
TypeDescription
Task.TriggerSpec.Type

The type.

getTypeValue()

public 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
TypeDescription
int

The enum numeric value on the wire for type.

hasSchedule()

public 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
TypeDescription
boolean

Whether the schedule field is set.

hasStartTime()

public 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
TypeDescription
boolean

Whether the startTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Task.TriggerSpec.Builder newBuilderForType()
Returns
TypeDescription
Task.TriggerSpec.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Task.TriggerSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Task.TriggerSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Task.TriggerSpec.Builder toBuilder()
Returns
TypeDescription
Task.TriggerSpec.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException