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 |
|---|
| Type | Description |
int | |
MAX_RETRIES_FIELD_NUMBER
public static final int MAX_RETRIES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SCHEDULE_FIELD_NUMBER
public static final int SCHEDULE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
START_TIME_FIELD_NUMBER
public static final int START_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Task.TriggerSpec getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Task.TriggerSpec.Builder newBuilder()
newBuilder(Task.TriggerSpec prototype)
public static Task.TriggerSpec.Builder newBuilder(Task.TriggerSpec prototype)
public static Task.TriggerSpec parseDelimitedFrom(InputStream input)
public static Task.TriggerSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Task.TriggerSpec parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Task.TriggerSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Task.TriggerSpec parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Task.TriggerSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Task.TriggerSpec parseFrom(CodedInputStream input)
public static Task.TriggerSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Task.TriggerSpec parseFrom(InputStream input)
public static Task.TriggerSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Task.TriggerSpec parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Task.TriggerSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Task.TriggerSpec> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDefaultInstanceForType()
public Task.TriggerSpec getDefaultInstanceForType()
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 |
|---|
| 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 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
int | The maxRetries.
|
getParserForType()
public Parser<Task.TriggerSpec> getParserForType()
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 |
|---|
| 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 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for schedule.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
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];
getTriggerCase()
public Task.TriggerSpec.TriggerCase getTriggerCase()
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];
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 |
|---|
| Type | Description |
int | The enum numeric value on the wire for type.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
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 |
|---|
| 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 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
boolean | Whether the startTime field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Task.TriggerSpec.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Task.TriggerSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Task.TriggerSpec.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
