- 1.78.0 (latest)
- 1.76.0
- 1.75.0
- 1.74.0
- 1.73.0
- 1.72.0
- 1.70.0
- 1.68.0
- 1.67.0
- 1.64.0
- 1.63.0
- 1.62.0
- 1.60.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.9.0
- 1.8.0
- 1.7.0
- 1.6.0
- 1.5.0
- 1.4.0
- 1.0.4
public static final class TransferTypes.Schedule.Builder extends GeneratedMessageV3.Builder<TransferTypes.Schedule.Builder> implements TransferTypes.ScheduleOrBuilderTransfers can be scheduled to recur or to run just once.
Protobuf type google.storagetransfer.v1.Schedule
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > TransferTypes.Schedule.BuilderImplements
TransferTypes.ScheduleOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public TransferTypes.Schedule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule.Builder |
|
build()
public TransferTypes.Schedule build()| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule |
|
buildPartial()
public TransferTypes.Schedule buildPartial()| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule |
|
clear()
public TransferTypes.Schedule.Builder clear()| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule.Builder |
|
clearEndTimeOfDay()
public TransferTypes.Schedule.Builder clearEndTimeOfDay() 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_dayis not set andschedule_end_dateis set, then a default value of23:59:59is used forend_time_of_day. - If
end_time_of_dayis set andschedule_end_dateis not set, then INVALID_ARGUMENT is returned.
.google.type.TimeOfDay end_time_of_day = 4;
| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public TransferTypes.Schedule.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public TransferTypes.Schedule.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule.Builder |
|
clearRepeatInterval()
public TransferTypes.Schedule.Builder clearRepeatInterval()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 |
TransferTypes.Schedule.Builder |
|
clearScheduleEndDate()
public TransferTypes.Schedule.Builder clearScheduleEndDate()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_dateand schedule_start_date are the same and in the future relative to UTC, the transfer is executed only one time. - If
schedule_end_dateis later thanschedule_start_dateandschedule_end_dateis in the future relative to UTC, the job runs each day at start_time_of_day throughschedule_end_date.
.google.type.Date schedule_end_date = 2;
| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule.Builder |
|
clearScheduleStartDate()
public TransferTypes.Schedule.Builder clearScheduleStartDate() 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 |
TransferTypes.Schedule.Builder |
|
clearStartTimeOfDay()
public TransferTypes.Schedule.Builder clearStartTimeOfDay() 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_dayis 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 |
TransferTypes.Schedule.Builder |
|
clone()
public TransferTypes.Schedule.Builder clone()| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule.Builder |
|
getDefaultInstanceForType()
public TransferTypes.Schedule getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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_dayis not set andschedule_end_dateis set, then a default value of23:59:59is used forend_time_of_day. - If
end_time_of_dayis set andschedule_end_dateis not set, then INVALID_ARGUMENT is returned.
.google.type.TimeOfDay end_time_of_day = 4;
| Returns | |
|---|---|
| Type | Description |
com.google.type.TimeOfDay |
The endTimeOfDay. |
getEndTimeOfDayBuilder()
public TimeOfDay.Builder getEndTimeOfDayBuilder() 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_dayis not set andschedule_end_dateis set, then a default value of23:59:59is used forend_time_of_day. - If
end_time_of_dayis set andschedule_end_dateis not set, then INVALID_ARGUMENT is returned.
.google.type.TimeOfDay end_time_of_day = 4;
| Returns | |
|---|---|
| Type | Description |
com.google.type.TimeOfDay.Builder |
|
getEndTimeOfDayOrBuilder()
public TimeOfDayOrBuilder getEndTimeOfDayOrBuilder() 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_dayis not set andschedule_end_dateis set, then a default value of23:59:59is used forend_time_of_day. - If
end_time_of_dayis set andschedule_end_dateis not set, then INVALID_ARGUMENT is returned.
.google.type.TimeOfDay end_time_of_day = 4;
| Returns | |
|---|---|
| Type | Description |
com.google.type.TimeOfDayOrBuilder |
|
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. |
getRepeatIntervalBuilder()
public Duration.Builder getRepeatIntervalBuilder()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 |
Builder |
|
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_dateand schedule_start_date are the same and in the future relative to UTC, the transfer is executed only one time. - If
schedule_end_dateis later thanschedule_start_dateandschedule_end_dateis in the future relative to UTC, the job runs each day at start_time_of_day throughschedule_end_date.
.google.type.Date schedule_end_date = 2;
| Returns | |
|---|---|
| Type | Description |
com.google.type.Date |
The scheduleEndDate. |
getScheduleEndDateBuilder()
public Date.Builder getScheduleEndDateBuilder()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_dateand schedule_start_date are the same and in the future relative to UTC, the transfer is executed only one time. - If
schedule_end_dateis later thanschedule_start_dateandschedule_end_dateis in the future relative to UTC, the job runs each day at start_time_of_day throughschedule_end_date.
.google.type.Date schedule_end_date = 2;
| Returns | |
|---|---|
| Type | Description |
com.google.type.Date.Builder |
|
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_dateand schedule_start_date are the same and in the future relative to UTC, the transfer is executed only one time. - If
schedule_end_dateis later thanschedule_start_dateandschedule_end_dateis in the future relative to UTC, the job runs each day at start_time_of_day throughschedule_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. |
getScheduleStartDateBuilder()
public Date.Builder getScheduleStartDateBuilder() 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.Builder |
|
getScheduleStartDateOrBuilder()
public DateOrBuilder getScheduleStartDateOrBuilder() 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.DateOrBuilder |
|
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_dayis 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. |
getStartTimeOfDayBuilder()
public TimeOfDay.Builder getStartTimeOfDayBuilder() 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_dayis 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.Builder |
|
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_dayis 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() 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_dayis not set andschedule_end_dateis set, then a default value of23:59:59is used forend_time_of_day. - If
end_time_of_dayis set andschedule_end_dateis 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_dateand schedule_start_date are the same and in the future relative to UTC, the transfer is executed only one time. - If
schedule_end_dateis later thanschedule_start_dateandschedule_end_dateis in the future relative to UTC, the job runs each day at start_time_of_day throughschedule_end_date.
.google.type.Date schedule_end_date = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the scheduleEndDate field is set. |
hasScheduleStartDate()
public boolean hasScheduleStartDate() 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 |
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_dayis 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeEndTimeOfDay(TimeOfDay value)
public TransferTypes.Schedule.Builder mergeEndTimeOfDay(TimeOfDay value) 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_dayis not set andschedule_end_dateis set, then a default value of23:59:59is used forend_time_of_day. - If
end_time_of_dayis set andschedule_end_dateis not set, then INVALID_ARGUMENT is returned.
.google.type.TimeOfDay end_time_of_day = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.type.TimeOfDay |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public TransferTypes.Schedule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public TransferTypes.Schedule.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule.Builder |
|
mergeFrom(TransferTypes.Schedule other)
public TransferTypes.Schedule.Builder mergeFrom(TransferTypes.Schedule other)| Parameter | |
|---|---|
| Name | Description |
other |
TransferTypes.Schedule |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule.Builder |
|
mergeRepeatInterval(Duration value)
public TransferTypes.Schedule.Builder mergeRepeatInterval(Duration value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule.Builder |
|
mergeScheduleEndDate(Date value)
public TransferTypes.Schedule.Builder mergeScheduleEndDate(Date value)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_dateand schedule_start_date are the same and in the future relative to UTC, the transfer is executed only one time. - If
schedule_end_dateis later thanschedule_start_dateandschedule_end_dateis in the future relative to UTC, the job runs each day at start_time_of_day throughschedule_end_date.
.google.type.Date schedule_end_date = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.type.Date |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule.Builder |
|
mergeScheduleStartDate(Date value)
public TransferTypes.Schedule.Builder mergeScheduleStartDate(Date value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.type.Date |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule.Builder |
|
mergeStartTimeOfDay(TimeOfDay value)
public TransferTypes.Schedule.Builder mergeStartTimeOfDay(TimeOfDay value) 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_dayis 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;
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.type.TimeOfDay |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final TransferTypes.Schedule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule.Builder |
|
setEndTimeOfDay(TimeOfDay value)
public TransferTypes.Schedule.Builder setEndTimeOfDay(TimeOfDay value) 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_dayis not set andschedule_end_dateis set, then a default value of23:59:59is used forend_time_of_day. - If
end_time_of_dayis set andschedule_end_dateis not set, then INVALID_ARGUMENT is returned.
.google.type.TimeOfDay end_time_of_day = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.type.TimeOfDay |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule.Builder |
|
setEndTimeOfDay(TimeOfDay.Builder builderForValue)
public TransferTypes.Schedule.Builder setEndTimeOfDay(TimeOfDay.Builder builderForValue) 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_dayis not set andschedule_end_dateis set, then a default value of23:59:59is used forend_time_of_day. - If
end_time_of_dayis set andschedule_end_dateis not set, then INVALID_ARGUMENT is returned.
.google.type.TimeOfDay end_time_of_day = 4;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
com.google.type.TimeOfDay.Builder |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public TransferTypes.Schedule.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule.Builder |
|
setRepeatInterval(Duration value)
public TransferTypes.Schedule.Builder setRepeatInterval(Duration value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
Duration |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule.Builder |
|
setRepeatInterval(Duration.Builder builderForValue)
public TransferTypes.Schedule.Builder setRepeatInterval(Duration.Builder builderForValue)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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public TransferTypes.Schedule.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule.Builder |
|
setScheduleEndDate(Date value)
public TransferTypes.Schedule.Builder setScheduleEndDate(Date value)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_dateand schedule_start_date are the same and in the future relative to UTC, the transfer is executed only one time. - If
schedule_end_dateis later thanschedule_start_dateandschedule_end_dateis in the future relative to UTC, the job runs each day at start_time_of_day throughschedule_end_date.
.google.type.Date schedule_end_date = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.type.Date |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule.Builder |
|
setScheduleEndDate(Date.Builder builderForValue)
public TransferTypes.Schedule.Builder setScheduleEndDate(Date.Builder builderForValue)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_dateand schedule_start_date are the same and in the future relative to UTC, the transfer is executed only one time. - If
schedule_end_dateis later thanschedule_start_dateandschedule_end_dateis in the future relative to UTC, the job runs each day at start_time_of_day throughschedule_end_date.
.google.type.Date schedule_end_date = 2;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
com.google.type.Date.Builder |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule.Builder |
|
setScheduleStartDate(Date value)
public TransferTypes.Schedule.Builder setScheduleStartDate(Date value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.type.Date |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule.Builder |
|
setScheduleStartDate(Date.Builder builderForValue)
public TransferTypes.Schedule.Builder setScheduleStartDate(Date.Builder builderForValue) 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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
com.google.type.Date.Builder |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule.Builder |
|
setStartTimeOfDay(TimeOfDay value)
public TransferTypes.Schedule.Builder setStartTimeOfDay(TimeOfDay value) 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_dayis 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;
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.type.TimeOfDay |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule.Builder |
|
setStartTimeOfDay(TimeOfDay.Builder builderForValue)
public TransferTypes.Schedule.Builder setStartTimeOfDay(TimeOfDay.Builder builderForValue) 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_dayis 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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
com.google.type.TimeOfDay.Builder |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final TransferTypes.Schedule.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
TransferTypes.Schedule.Builder |
|