Class ScheduleOptionsV2 (2.55.0)

public final class ScheduleOptionsV2 extends GeneratedMessageV3 implements ScheduleOptionsV2OrBuilder

V2 options customizing different types of data transfer schedule. This field supports existing time-based and manual transfer schedule. Also supports Event-Driven transfer schedule. ScheduleOptionsV2 cannot be used together with ScheduleOptions/Schedule.

Protobuf type google.cloud.bigquery.datatransfer.v1.ScheduleOptionsV2

Static Fields

EVENT_DRIVEN_SCHEDULE_FIELD_NUMBER

public static final int EVENT_DRIVEN_SCHEDULE_FIELD_NUMBER
Field Value
Type Description
int

MANUAL_SCHEDULE_FIELD_NUMBER

public static final int MANUAL_SCHEDULE_FIELD_NUMBER
Field Value
Type Description
int

TIME_BASED_SCHEDULE_FIELD_NUMBER

public static final int TIME_BASED_SCHEDULE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ScheduleOptionsV2 getDefaultInstance()
Returns
Type Description
ScheduleOptionsV2

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ScheduleOptionsV2.Builder newBuilder()
Returns
Type Description
ScheduleOptionsV2.Builder

newBuilder(ScheduleOptionsV2 prototype)

public static ScheduleOptionsV2.Builder newBuilder(ScheduleOptionsV2 prototype)
Parameter
Name Description
prototype ScheduleOptionsV2
Returns
Type Description
ScheduleOptionsV2.Builder

parseDelimitedFrom(InputStream input)

public static ScheduleOptionsV2 parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ScheduleOptionsV2
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ScheduleOptionsV2 parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ScheduleOptionsV2
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ScheduleOptionsV2 parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ScheduleOptionsV2
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ScheduleOptionsV2 parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ScheduleOptionsV2
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ScheduleOptionsV2 parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ScheduleOptionsV2
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ScheduleOptionsV2 parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ScheduleOptionsV2
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ScheduleOptionsV2 parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ScheduleOptionsV2
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ScheduleOptionsV2 parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ScheduleOptionsV2
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ScheduleOptionsV2 parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ScheduleOptionsV2
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ScheduleOptionsV2 parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ScheduleOptionsV2
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ScheduleOptionsV2 parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ScheduleOptionsV2
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ScheduleOptionsV2 parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ScheduleOptionsV2
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ScheduleOptionsV2> parser()
Returns
Type Description
Parser<ScheduleOptionsV2>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ScheduleOptionsV2 getDefaultInstanceForType()
Returns
Type Description
ScheduleOptionsV2

getEventDrivenSchedule()

public EventDrivenSchedule getEventDrivenSchedule()

Event driven transfer schedule options. If set, the transfer will be scheduled upon events arrial.

.google.cloud.bigquery.datatransfer.v1.EventDrivenSchedule event_driven_schedule = 3;

Returns
Type Description
EventDrivenSchedule

The eventDrivenSchedule.

getEventDrivenScheduleOrBuilder()

public EventDrivenScheduleOrBuilder getEventDrivenScheduleOrBuilder()

Event driven transfer schedule options. If set, the transfer will be scheduled upon events arrial.

.google.cloud.bigquery.datatransfer.v1.EventDrivenSchedule event_driven_schedule = 3;

Returns
Type Description
EventDrivenScheduleOrBuilder

getManualSchedule()

public ManualSchedule getManualSchedule()

Manual transfer schedule. If set, the transfer run will not be auto-scheduled by the system, unless the client invokes StartManualTransferRuns. This is equivalent to disable_auto_scheduling = true.

.google.cloud.bigquery.datatransfer.v1.ManualSchedule manual_schedule = 2;

Returns
Type Description
ManualSchedule

The manualSchedule.

getManualScheduleOrBuilder()

public ManualScheduleOrBuilder getManualScheduleOrBuilder()

Manual transfer schedule. If set, the transfer run will not be auto-scheduled by the system, unless the client invokes StartManualTransferRuns. This is equivalent to disable_auto_scheduling = true.

.google.cloud.bigquery.datatransfer.v1.ManualSchedule manual_schedule = 2;

Returns
Type Description
ManualScheduleOrBuilder

getParserForType()

public Parser<ScheduleOptionsV2> getParserForType()
Returns
Type Description
Parser<ScheduleOptionsV2>
Overrides

getScheduleCase()

public ScheduleOptionsV2.ScheduleCase getScheduleCase()
Returns
Type Description
ScheduleOptionsV2.ScheduleCase

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTimeBasedSchedule()

public TimeBasedSchedule getTimeBasedSchedule()

Time based transfer schedule options. This is the default schedule option.

.google.cloud.bigquery.datatransfer.v1.TimeBasedSchedule time_based_schedule = 1;

Returns
Type Description
TimeBasedSchedule

The timeBasedSchedule.

getTimeBasedScheduleOrBuilder()

public TimeBasedScheduleOrBuilder getTimeBasedScheduleOrBuilder()

Time based transfer schedule options. This is the default schedule option.

.google.cloud.bigquery.datatransfer.v1.TimeBasedSchedule time_based_schedule = 1;

Returns
Type Description
TimeBasedScheduleOrBuilder

hasEventDrivenSchedule()

public boolean hasEventDrivenSchedule()

Event driven transfer schedule options. If set, the transfer will be scheduled upon events arrial.

.google.cloud.bigquery.datatransfer.v1.EventDrivenSchedule event_driven_schedule = 3;

Returns
Type Description
boolean

Whether the eventDrivenSchedule field is set.

hasManualSchedule()

public boolean hasManualSchedule()

Manual transfer schedule. If set, the transfer run will not be auto-scheduled by the system, unless the client invokes StartManualTransferRuns. This is equivalent to disable_auto_scheduling = true.

.google.cloud.bigquery.datatransfer.v1.ManualSchedule manual_schedule = 2;

Returns
Type Description
boolean

Whether the manualSchedule field is set.

hasTimeBasedSchedule()

public boolean hasTimeBasedSchedule()

Time based transfer schedule options. This is the default schedule option.

.google.cloud.bigquery.datatransfer.v1.TimeBasedSchedule time_based_schedule = 1;

Returns
Type Description
boolean

Whether the timeBasedSchedule field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ScheduleOptionsV2.Builder newBuilderForType()
Returns
Type Description
ScheduleOptionsV2.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ScheduleOptionsV2.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ScheduleOptionsV2.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ScheduleOptionsV2.Builder toBuilder()
Returns
Type Description
ScheduleOptionsV2.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException