Class TransferTypes.Schedule (1.42.0)

public static final class TransferTypes.Schedule extends GeneratedMessageV3 implements TransferTypes.ScheduleOrBuilder

Transfers can be scheduled to recur or to run just once.

Protobuf type google.storagetransfer.v1.Schedule

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > TransferTypes.Schedule

Implements

TransferTypes.ScheduleOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

END_TIME_OF_DAY_FIELD_NUMBER

public static final int END_TIME_OF_DAY_FIELD_NUMBER

Field Value
Type	Description
`int`

REPEAT_INTERVAL_FIELD_NUMBER

public static final int REPEAT_INTERVAL_FIELD_NUMBER

Field Value
Type	Description
`int`

SCHEDULE_END_DATE_FIELD_NUMBER

public static final int SCHEDULE_END_DATE_FIELD_NUMBER

Field Value
Type	Description
`int`

SCHEDULE_START_DATE_FIELD_NUMBER

public static final int SCHEDULE_START_DATE_FIELD_NUMBER

Field Value
Type	Description
`int`

START_TIME_OF_DAY_FIELD_NUMBER

public static final int START_TIME_OF_DAY_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static TransferTypes.Schedule getDefaultInstance()

Returns
Type	Description
`TransferTypes.Schedule`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static TransferTypes.Schedule.Builder newBuilder()

Returns
Type	Description
`TransferTypes.Schedule.Builder`

newBuilder(TransferTypes.Schedule prototype)

public static TransferTypes.Schedule.Builder newBuilder(TransferTypes.Schedule prototype)

Parameter
Name	Description
`prototype`	`TransferTypes.Schedule`

Returns
Type	Description
`TransferTypes.Schedule.Builder`

parseDelimitedFrom(InputStream input)

public static TransferTypes.Schedule parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`TransferTypes.Schedule`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.Schedule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`TransferTypes.Schedule`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static TransferTypes.Schedule parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`TransferTypes.Schedule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.Schedule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`TransferTypes.Schedule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static TransferTypes.Schedule parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`TransferTypes.Schedule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.Schedule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`TransferTypes.Schedule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static TransferTypes.Schedule parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`TransferTypes.Schedule`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.Schedule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`TransferTypes.Schedule`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static TransferTypes.Schedule parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`TransferTypes.Schedule`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.Schedule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`TransferTypes.Schedule`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static TransferTypes.Schedule parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`TransferTypes.Schedule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TransferTypes.Schedule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`TransferTypes.Schedule`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<TransferTypes.Schedule> parser()

Returns
Type	Description
`Parser<Schedule>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public TransferTypes.Schedule getDefaultInstanceForType()

Returns
Type	Description
`TransferTypes.Schedule`

getEndTimeOfDay()

public TimeOfDay getEndTimeOfDay()

The time in UTC that no further transfer operations are scheduled. Combined with schedule_end_date, end_time_of_day specifies the end date and time for starting new transfer operations. This field must be greater than or equal to the timestamp corresponding to the combintation of schedule_start_date and start_time_of_day, and is subject to the following:

If end_time_of_day is not set and schedule_end_date is set, then a default value of 23:59:59 is used for end_time_of_day.
If end_time_of_day is set and schedule_end_date is not set, then INVALID_ARGUMENT is returned.

.google.type.TimeOfDay end_time_of_day = 4;

Returns
Type	Description
`com.google.type.TimeOfDay`	The endTimeOfDay.

getEndTimeOfDayOrBuilder()

public TimeOfDayOrBuilder getEndTimeOfDayOrBuilder()

If end_time_of_day is not set and schedule_end_date is set, then a default value of 23:59:59 is used for end_time_of_day.
If end_time_of_day is set and schedule_end_date is not set, then INVALID_ARGUMENT is returned.

.google.type.TimeOfDay end_time_of_day = 4;

Returns
Type	Description
`com.google.type.TimeOfDayOrBuilder`

getParserForType()

public Parser<TransferTypes.Schedule> getParserForType()

Returns
Type	Description
`Parser<Schedule>`

Overrides

GeneratedMessageV3.getParserForType()

getRepeatInterval()

public Duration getRepeatInterval()

Interval between the start of each scheduled TransferOperation. If unspecified, the default value is 24 hours. This value may not be less than 1 hour.

.google.protobuf.Duration repeat_interval = 5;

Returns
Type	Description
`Duration`	The repeatInterval.

getRepeatIntervalOrBuilder()

public DurationOrBuilder getRepeatIntervalOrBuilder()

Interval between the start of each scheduled TransferOperation. If unspecified, the default value is 24 hours. This value may not be less than 1 hour.

.google.protobuf.Duration repeat_interval = 5;

Returns
Type	Description
`DurationOrBuilder`

getScheduleEndDate()

public Date getScheduleEndDate()

The last day a transfer runs. Date boundaries are determined relative to UTC time. A job runs once per 24 hours within the following guidelines:

If schedule_end_date and schedule_start_date are the same and in the future relative to UTC, the transfer is executed only one time.
If schedule_end_date is later than schedule_start_date and schedule_end_date is in the future relative to UTC, the job runs each day at start_time_of_day through schedule_end_date.

.google.type.Date schedule_end_date = 2;

Returns
Type	Description
`com.google.type.Date`	The scheduleEndDate.

getScheduleEndDateOrBuilder()

public DateOrBuilder getScheduleEndDateOrBuilder()

The last day a transfer runs. Date boundaries are determined relative to UTC time. A job runs once per 24 hours within the following guidelines:

If schedule_end_date and schedule_start_date are the same and in the future relative to UTC, the transfer is executed only one time.
If schedule_end_date is later than schedule_start_date and schedule_end_date is in the future relative to UTC, the job runs each day at start_time_of_day through schedule_end_date.

.google.type.Date schedule_end_date = 2;

Returns
Type	Description
`com.google.type.DateOrBuilder`

getScheduleStartDate()

public Date getScheduleStartDate()

Required. The start date of a transfer. Date boundaries are determined relative to UTC time. If schedule_start_date and start_time_of_day are in the past relative to the job's creation time, the transfer starts the day after you schedule the transfer request.

Note: When starting jobs at or near midnight UTC it is possible that a job starts later than expected. For example, if you send an outbound request on June 1 one millisecond prior to midnight UTC and the Storage Transfer Service server receives the request on June 2, then it creates a TransferJob with schedule_start_date set to June 2 and a start_time_of_day set to midnight UTC. The first scheduled TransferOperation takes place on June 3 at midnight UTC.

.google.type.Date schedule_start_date = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`com.google.type.Date`	The scheduleStartDate.

getScheduleStartDateOrBuilder()

public DateOrBuilder getScheduleStartDateOrBuilder()

.google.type.Date schedule_start_date = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`com.google.type.DateOrBuilder`

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getStartTimeOfDay()

public TimeOfDay getStartTimeOfDay()

The time in UTC that a transfer job is scheduled to run. Transfers may start later than this time.

If start_time_of_day is not specified:

One-time transfers run immediately.
Recurring transfers run immediately, and each day at midnight UTC, through schedule_end_date.

If start_time_of_day is specified:
One-time transfers run at the specified time.
Recurring transfers run at the specified time each day, through schedule_end_date.

.google.type.TimeOfDay start_time_of_day = 3;

Returns
Type	Description
`com.google.type.TimeOfDay`	The startTimeOfDay.

getStartTimeOfDayOrBuilder()

public TimeOfDayOrBuilder getStartTimeOfDayOrBuilder()

The time in UTC that a transfer job is scheduled to run. Transfers may start later than this time.

If start_time_of_day is not specified:

One-time transfers run immediately.
Recurring transfers run immediately, and each day at midnight UTC, through schedule_end_date.

If start_time_of_day is specified:
One-time transfers run at the specified time.
Recurring transfers run at the specified time each day, through schedule_end_date.

.google.type.TimeOfDay start_time_of_day = 3;

Returns
Type	Description
`com.google.type.TimeOfDayOrBuilder`

hasEndTimeOfDay()

public boolean hasEndTimeOfDay()

If end_time_of_day is not set and schedule_end_date is set, then a default value of 23:59:59 is used for end_time_of_day.
If end_time_of_day is set and schedule_end_date is not set, then INVALID_ARGUMENT is returned.

.google.type.TimeOfDay end_time_of_day = 4;

Returns
Type	Description
`boolean`	Whether the endTimeOfDay field is set.

hasRepeatInterval()

public boolean hasRepeatInterval()

Interval between the start of each scheduled TransferOperation. If unspecified, the default value is 24 hours. This value may not be less than 1 hour.

.google.protobuf.Duration repeat_interval = 5;

Returns
Type	Description
`boolean`	Whether the repeatInterval field is set.

hasScheduleEndDate()

public boolean hasScheduleEndDate()

The last day a transfer runs. Date boundaries are determined relative to UTC time. A job runs once per 24 hours within the following guidelines:

If schedule_end_date and schedule_start_date are the same and in the future relative to UTC, the transfer is executed only one time.
If schedule_end_date is later than schedule_start_date and schedule_end_date is in the future relative to UTC, the job runs each day at start_time_of_day through schedule_end_date.

.google.type.Date schedule_end_date = 2;

Returns
Type	Description
`boolean`	Whether the scheduleEndDate field is set.

hasScheduleStartDate()

public boolean hasScheduleStartDate()

.google.type.Date schedule_start_date = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`boolean`	Whether the scheduleStartDate field is set.

hasStartTimeOfDay()

public boolean hasStartTimeOfDay()

The time in UTC that a transfer job is scheduled to run. Transfers may start later than this time.

If start_time_of_day is not specified:

One-time transfers run immediately.
Recurring transfers run immediately, and each day at midnight UTC, through schedule_end_date.

If start_time_of_day is specified:
One-time transfers run at the specified time.
Recurring transfers run at the specified time each day, through schedule_end_date.

.google.type.TimeOfDay start_time_of_day = 3;

Returns
Type	Description
`boolean`	Whether the startTimeOfDay field is set.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public TransferTypes.Schedule.Builder newBuilderForType()

Returns
Type	Description
`TransferTypes.Schedule.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TransferTypes.Schedule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`TransferTypes.Schedule.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public TransferTypes.Schedule.Builder toBuilder()

Returns
Type	Description
`TransferTypes.Schedule.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`