public static final class Task.TriggerSpec.Builder extends GeneratedMessageV3.Builder<Task.TriggerSpec.Builder> implements Task.TriggerSpecOrBuilder
Task scheduling and trigger settings.
Protobuf type google.events.cloud.dataplex.v1.Task.TriggerSpec
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Task.TriggerSpec.BuilderImplements
Task.TriggerSpecOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Task.TriggerSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
Task.TriggerSpec.Builder |
build()
public Task.TriggerSpec build()
Returns | |
---|---|
Type | Description |
Task.TriggerSpec |
buildPartial()
public Task.TriggerSpec buildPartial()
Returns | |
---|---|
Type | Description |
Task.TriggerSpec |
clear()
public Task.TriggerSpec.Builder clear()
Returns | |
---|---|
Type | Description |
Task.TriggerSpec.Builder |
clearDisabled()
public Task.TriggerSpec.Builder clearDisabled()
Optional. Prevent the task from executing. This does not cancel already running tasks. It is intended to temporarily disable RECURRING tasks.
bool disabled = 4;
Returns | |
---|---|
Type | Description |
Task.TriggerSpec.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Task.TriggerSpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
Task.TriggerSpec.Builder |
clearMaxRetries()
public Task.TriggerSpec.Builder clearMaxRetries()
Optional. Number of retry attempts before aborting. Set to zero to never attempt to retry a failed task.
int32 max_retries = 7;
Returns | |
---|---|
Type | Description |
Task.TriggerSpec.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Task.TriggerSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
Task.TriggerSpec.Builder |
clearSchedule()
public Task.TriggerSpec.Builder clearSchedule()
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;
Returns | |
---|---|
Type | Description |
Task.TriggerSpec.Builder | This builder for chaining. |
clearStartTime()
public Task.TriggerSpec.Builder clearStartTime()
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;
Returns | |
---|---|
Type | Description |
Task.TriggerSpec.Builder |
clearTrigger()
public Task.TriggerSpec.Builder clearTrigger()
Returns | |
---|---|
Type | Description |
Task.TriggerSpec.Builder |
clearType()
public Task.TriggerSpec.Builder clearType()
Required. Immutable. Trigger type of the user-specified Task.
.google.events.cloud.dataplex.v1.Task.TriggerSpec.Type type = 5;
Returns | |
---|---|
Type | Description |
Task.TriggerSpec.Builder | This builder for chaining. |
clone()
public Task.TriggerSpec.Builder clone()
Returns | |
---|---|
Type | Description |
Task.TriggerSpec.Builder |
getDefaultInstanceForType()
public Task.TriggerSpec getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
Task.TriggerSpec |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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;
Returns | |
---|---|
Type | Description |
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;
Returns | |
---|---|
Type | Description |
int | The maxRetries. |
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;
Returns | |
---|---|
Type | Description |
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;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for schedule. |
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;
Returns | |
---|---|
Type | Description |
Timestamp | The startTime. |
getStartTimeBuilder()
public Timestamp.Builder getStartTimeBuilder()
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;
Returns | |
---|---|
Type | Description |
Builder |
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;
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getTriggerCase()
public Task.TriggerSpec.TriggerCase getTriggerCase()
Returns | |
---|---|
Type | Description |
Task.TriggerSpec.TriggerCase |
getType()
public Task.TriggerSpec.Type getType()
Required. Immutable. Trigger type of the user-specified Task.
.google.events.cloud.dataplex.v1.Task.TriggerSpec.Type type = 5;
Returns | |
---|---|
Type | Description |
Task.TriggerSpec.Type | The type. |
getTypeValue()
public int getTypeValue()
Required. Immutable. Trigger type of the user-specified Task.
.google.events.cloud.dataplex.v1.Task.TriggerSpec.Type type = 5;
Returns | |
---|---|
Type | Description |
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;
Returns | |
---|---|
Type | Description |
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;
Returns | |
---|---|
Type | Description |
boolean | Whether the startTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(Task.TriggerSpec other)
public Task.TriggerSpec.Builder mergeFrom(Task.TriggerSpec other)
Parameter | |
---|---|
Name | Description |
other | Task.TriggerSpec |
Returns | |
---|---|
Type | Description |
Task.TriggerSpec.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Task.TriggerSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Task.TriggerSpec.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public Task.TriggerSpec.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
Task.TriggerSpec.Builder |
mergeStartTime(Timestamp value)
public Task.TriggerSpec.Builder mergeStartTime(Timestamp value)
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;
Parameter | |
---|---|
Name | Description |
value | Timestamp |
Returns | |
---|---|
Type | Description |
Task.TriggerSpec.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Task.TriggerSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Task.TriggerSpec.Builder |
setDisabled(boolean value)
public Task.TriggerSpec.Builder setDisabled(boolean value)
Optional. Prevent the task from executing. This does not cancel already running tasks. It is intended to temporarily disable RECURRING tasks.
bool disabled = 4;
Parameter | |
---|---|
Name | Description |
value | boolean The disabled to set. |
Returns | |
---|---|
Type | Description |
Task.TriggerSpec.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Task.TriggerSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
Task.TriggerSpec.Builder |
setMaxRetries(int value)
public Task.TriggerSpec.Builder setMaxRetries(int value)
Optional. Number of retry attempts before aborting. Set to zero to never attempt to retry a failed task.
int32 max_retries = 7;
Parameter | |
---|---|
Name | Description |
value | int The maxRetries to set. |
Returns | |
---|---|
Type | Description |
Task.TriggerSpec.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Task.TriggerSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
Task.TriggerSpec.Builder |
setSchedule(String value)
public Task.TriggerSpec.Builder setSchedule(String value)
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;
Parameter | |
---|---|
Name | Description |
value | String The schedule to set. |
Returns | |
---|---|
Type | Description |
Task.TriggerSpec.Builder | This builder for chaining. |
setScheduleBytes(ByteString value)
public Task.TriggerSpec.Builder setScheduleBytes(ByteString value)
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;
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for schedule to set. |
Returns | |
---|---|
Type | Description |
Task.TriggerSpec.Builder | This builder for chaining. |
setStartTime(Timestamp value)
public Task.TriggerSpec.Builder setStartTime(Timestamp value)
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;
Parameter | |
---|---|
Name | Description |
value | Timestamp |
Returns | |
---|---|
Type | Description |
Task.TriggerSpec.Builder |
setStartTime(Timestamp.Builder builderForValue)
public Task.TriggerSpec.Builder setStartTime(Timestamp.Builder builderForValue)
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;
Parameter | |
---|---|
Name | Description |
builderForValue | Builder |
Returns | |
---|---|
Type | Description |
Task.TriggerSpec.Builder |
setType(Task.TriggerSpec.Type value)
public Task.TriggerSpec.Builder setType(Task.TriggerSpec.Type value)
Required. Immutable. Trigger type of the user-specified Task.
.google.events.cloud.dataplex.v1.Task.TriggerSpec.Type type = 5;
Parameter | |
---|---|
Name | Description |
value | Task.TriggerSpec.Type The type to set. |
Returns | |
---|---|
Type | Description |
Task.TriggerSpec.Builder | This builder for chaining. |
setTypeValue(int value)
public Task.TriggerSpec.Builder setTypeValue(int value)
Required. Immutable. Trigger type of the user-specified Task.
.google.events.cloud.dataplex.v1.Task.TriggerSpec.Type type = 5;
Parameter | |
---|---|
Name | Description |
value | int The enum numeric value on the wire for type to set. |
Returns | |
---|---|
Type | Description |
Task.TriggerSpec.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Task.TriggerSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Task.TriggerSpec.Builder |