Class Schedule.Builder (0.13.0)

public static final class Schedule.Builder extends GeneratedMessageV3.Builder<Schedule.Builder> implements ScheduleOrBuilder

The schedule for the report

Protobuf type google.ads.admanager.v1.Schedule

Implements

ScheduleOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Schedule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Schedule.Builder
Overrides

build()

public Schedule build()
Returns
Type Description
Schedule

buildPartial()

public Schedule buildPartial()
Returns
Type Description
Schedule

clear()

public Schedule.Builder clear()
Returns
Type Description
Schedule.Builder
Overrides

clearEndDate()

public Schedule.Builder clearEndDate()

Date for the final run of the report.

.google.type.Date end_date = 2;

Returns
Type Description
Schedule.Builder

clearField(Descriptors.FieldDescriptor field)

public Schedule.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Schedule.Builder
Overrides

clearFrequency()

public Schedule.Builder clearFrequency()

Frequency to run report.

.google.ads.admanager.v1.Schedule.Frequency frequency = 3;

Returns
Type Description
Schedule.Builder

This builder for chaining.

clearFrequencySchedule()

public Schedule.Builder clearFrequencySchedule()
Returns
Type Description
Schedule.Builder

clearMonthlySchedule()

public Schedule.Builder clearMonthlySchedule()

Days of month to schedule report run.

.google.ads.admanager.v1.Schedule.MonthlySchedule monthly_schedule = 7;

Returns
Type Description
Schedule.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Schedule.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Schedule.Builder
Overrides

clearStartDate()

public Schedule.Builder clearStartDate()

Date for the first run of the report.

.google.type.Date start_date = 1;

Returns
Type Description
Schedule.Builder

clearStartTime()

public Schedule.Builder clearStartTime()

Indicates start time for schedule to run Will use the time_zone from ReportDefinition. Defaults to the publisher's time zone if not specified.

For HOURLY, TWO_TIMES_DAILY, THREE_TIMES_DAILY, or FOUR_TIMES_DAILY, this will be the time of day that the first report will run on the first day. For example, if the start time is 2:00 PM, and the frequency is THREE_TIMES_DAILY, the first day will have reports scheduled at 2:00 PM, 10:00 PM. Each subsequent day will have reports scheduled at 6:00 AM, 2:00 PM, 10:00 PM.

.google.type.TimeOfDay start_time = 4;

Returns
Type Description
Schedule.Builder

clearWeeklySchedule()

public Schedule.Builder clearWeeklySchedule()

Days of week to schedule report run.

.google.ads.admanager.v1.Schedule.WeeklySchedule weekly_schedule = 6;

Returns
Type Description
Schedule.Builder

clone()

public Schedule.Builder clone()
Returns
Type Description
Schedule.Builder
Overrides

getDefaultInstanceForType()

public Schedule getDefaultInstanceForType()
Returns
Type Description
Schedule

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEndDate()

public Date getEndDate()

Date for the final run of the report.

.google.type.Date end_date = 2;

Returns
Type Description
com.google.type.Date

The endDate.

getEndDateBuilder()

public Date.Builder getEndDateBuilder()

Date for the final run of the report.

.google.type.Date end_date = 2;

Returns
Type Description
com.google.type.Date.Builder

getEndDateOrBuilder()

public DateOrBuilder getEndDateOrBuilder()

Date for the final run of the report.

.google.type.Date end_date = 2;

Returns
Type Description
com.google.type.DateOrBuilder

getFrequency()

public Schedule.Frequency getFrequency()

Frequency to run report.

.google.ads.admanager.v1.Schedule.Frequency frequency = 3;

Returns
Type Description
Schedule.Frequency

The frequency.

getFrequencyScheduleCase()

public Schedule.FrequencyScheduleCase getFrequencyScheduleCase()
Returns
Type Description
Schedule.FrequencyScheduleCase

getFrequencyValue()

public int getFrequencyValue()

Frequency to run report.

.google.ads.admanager.v1.Schedule.Frequency frequency = 3;

Returns
Type Description
int

The enum numeric value on the wire for frequency.

getMonthlySchedule()

public Schedule.MonthlySchedule getMonthlySchedule()

Days of month to schedule report run.

.google.ads.admanager.v1.Schedule.MonthlySchedule monthly_schedule = 7;

Returns
Type Description
Schedule.MonthlySchedule

The monthlySchedule.

getMonthlyScheduleBuilder()

public Schedule.MonthlySchedule.Builder getMonthlyScheduleBuilder()

Days of month to schedule report run.

.google.ads.admanager.v1.Schedule.MonthlySchedule monthly_schedule = 7;

Returns
Type Description
Schedule.MonthlySchedule.Builder

getMonthlyScheduleOrBuilder()

public Schedule.MonthlyScheduleOrBuilder getMonthlyScheduleOrBuilder()

Days of month to schedule report run.

.google.ads.admanager.v1.Schedule.MonthlySchedule monthly_schedule = 7;

Returns
Type Description
Schedule.MonthlyScheduleOrBuilder

getStartDate()

public Date getStartDate()

Date for the first run of the report.

.google.type.Date start_date = 1;

Returns
Type Description
com.google.type.Date

The startDate.

getStartDateBuilder()

public Date.Builder getStartDateBuilder()

Date for the first run of the report.

.google.type.Date start_date = 1;

Returns
Type Description
com.google.type.Date.Builder

getStartDateOrBuilder()

public DateOrBuilder getStartDateOrBuilder()

Date for the first run of the report.

.google.type.Date start_date = 1;

Returns
Type Description
com.google.type.DateOrBuilder

getStartTime()

public TimeOfDay getStartTime()

Indicates start time for schedule to run Will use the time_zone from ReportDefinition. Defaults to the publisher's time zone if not specified.

For HOURLY, TWO_TIMES_DAILY, THREE_TIMES_DAILY, or FOUR_TIMES_DAILY, this will be the time of day that the first report will run on the first day. For example, if the start time is 2:00 PM, and the frequency is THREE_TIMES_DAILY, the first day will have reports scheduled at 2:00 PM, 10:00 PM. Each subsequent day will have reports scheduled at 6:00 AM, 2:00 PM, 10:00 PM.

.google.type.TimeOfDay start_time = 4;

Returns
Type Description
com.google.type.TimeOfDay

The startTime.

getStartTimeBuilder()

public TimeOfDay.Builder getStartTimeBuilder()

Indicates start time for schedule to run Will use the time_zone from ReportDefinition. Defaults to the publisher's time zone if not specified.

For HOURLY, TWO_TIMES_DAILY, THREE_TIMES_DAILY, or FOUR_TIMES_DAILY, this will be the time of day that the first report will run on the first day. For example, if the start time is 2:00 PM, and the frequency is THREE_TIMES_DAILY, the first day will have reports scheduled at 2:00 PM, 10:00 PM. Each subsequent day will have reports scheduled at 6:00 AM, 2:00 PM, 10:00 PM.

.google.type.TimeOfDay start_time = 4;

Returns
Type Description
com.google.type.TimeOfDay.Builder

getStartTimeOrBuilder()

public TimeOfDayOrBuilder getStartTimeOrBuilder()

Indicates start time for schedule to run Will use the time_zone from ReportDefinition. Defaults to the publisher's time zone if not specified.

For HOURLY, TWO_TIMES_DAILY, THREE_TIMES_DAILY, or FOUR_TIMES_DAILY, this will be the time of day that the first report will run on the first day. For example, if the start time is 2:00 PM, and the frequency is THREE_TIMES_DAILY, the first day will have reports scheduled at 2:00 PM, 10:00 PM. Each subsequent day will have reports scheduled at 6:00 AM, 2:00 PM, 10:00 PM.

.google.type.TimeOfDay start_time = 4;

Returns
Type Description
com.google.type.TimeOfDayOrBuilder

getWeeklySchedule()

public Schedule.WeeklySchedule getWeeklySchedule()

Days of week to schedule report run.

.google.ads.admanager.v1.Schedule.WeeklySchedule weekly_schedule = 6;

Returns
Type Description
Schedule.WeeklySchedule

The weeklySchedule.

getWeeklyScheduleBuilder()

public Schedule.WeeklySchedule.Builder getWeeklyScheduleBuilder()

Days of week to schedule report run.

.google.ads.admanager.v1.Schedule.WeeklySchedule weekly_schedule = 6;

Returns
Type Description
Schedule.WeeklySchedule.Builder

getWeeklyScheduleOrBuilder()

public Schedule.WeeklyScheduleOrBuilder getWeeklyScheduleOrBuilder()

Days of week to schedule report run.

.google.ads.admanager.v1.Schedule.WeeklySchedule weekly_schedule = 6;

Returns
Type Description
Schedule.WeeklyScheduleOrBuilder

hasEndDate()

public boolean hasEndDate()

Date for the final run of the report.

.google.type.Date end_date = 2;

Returns
Type Description
boolean

Whether the endDate field is set.

hasMonthlySchedule()

public boolean hasMonthlySchedule()

Days of month to schedule report run.

.google.ads.admanager.v1.Schedule.MonthlySchedule monthly_schedule = 7;

Returns
Type Description
boolean

Whether the monthlySchedule field is set.

hasStartDate()

public boolean hasStartDate()

Date for the first run of the report.

.google.type.Date start_date = 1;

Returns
Type Description
boolean

Whether the startDate field is set.

hasStartTime()

public boolean hasStartTime()

Indicates start time for schedule to run Will use the time_zone from ReportDefinition. Defaults to the publisher's time zone if not specified.

For HOURLY, TWO_TIMES_DAILY, THREE_TIMES_DAILY, or FOUR_TIMES_DAILY, this will be the time of day that the first report will run on the first day. For example, if the start time is 2:00 PM, and the frequency is THREE_TIMES_DAILY, the first day will have reports scheduled at 2:00 PM, 10:00 PM. Each subsequent day will have reports scheduled at 6:00 AM, 2:00 PM, 10:00 PM.

.google.type.TimeOfDay start_time = 4;

Returns
Type Description
boolean

Whether the startTime field is set.

hasWeeklySchedule()

public boolean hasWeeklySchedule()

Days of week to schedule report run.

.google.ads.admanager.v1.Schedule.WeeklySchedule weekly_schedule = 6;

Returns
Type Description
boolean

Whether the weeklySchedule field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEndDate(Date value)

public Schedule.Builder mergeEndDate(Date value)

Date for the final run of the report.

.google.type.Date end_date = 2;

Parameter
Name Description
value com.google.type.Date
Returns
Type Description
Schedule.Builder

mergeFrom(Schedule other)

public Schedule.Builder mergeFrom(Schedule other)
Parameter
Name Description
other Schedule
Returns
Type Description
Schedule.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Schedule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Schedule.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Schedule.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Schedule.Builder
Overrides

mergeMonthlySchedule(Schedule.MonthlySchedule value)

public Schedule.Builder mergeMonthlySchedule(Schedule.MonthlySchedule value)

Days of month to schedule report run.

.google.ads.admanager.v1.Schedule.MonthlySchedule monthly_schedule = 7;

Parameter
Name Description
value Schedule.MonthlySchedule
Returns
Type Description
Schedule.Builder

mergeStartDate(Date value)

public Schedule.Builder mergeStartDate(Date value)

Date for the first run of the report.

.google.type.Date start_date = 1;

Parameter
Name Description
value com.google.type.Date
Returns
Type Description
Schedule.Builder

mergeStartTime(TimeOfDay value)

public Schedule.Builder mergeStartTime(TimeOfDay value)

Indicates start time for schedule to run Will use the time_zone from ReportDefinition. Defaults to the publisher's time zone if not specified.

For HOURLY, TWO_TIMES_DAILY, THREE_TIMES_DAILY, or FOUR_TIMES_DAILY, this will be the time of day that the first report will run on the first day. For example, if the start time is 2:00 PM, and the frequency is THREE_TIMES_DAILY, the first day will have reports scheduled at 2:00 PM, 10:00 PM. Each subsequent day will have reports scheduled at 6:00 AM, 2:00 PM, 10:00 PM.

.google.type.TimeOfDay start_time = 4;

Parameter
Name Description
value com.google.type.TimeOfDay
Returns
Type Description
Schedule.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Schedule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Schedule.Builder
Overrides

mergeWeeklySchedule(Schedule.WeeklySchedule value)

public Schedule.Builder mergeWeeklySchedule(Schedule.WeeklySchedule value)

Days of week to schedule report run.

.google.ads.admanager.v1.Schedule.WeeklySchedule weekly_schedule = 6;

Parameter
Name Description
value Schedule.WeeklySchedule
Returns
Type Description
Schedule.Builder

setEndDate(Date value)

public Schedule.Builder setEndDate(Date value)

Date for the final run of the report.

.google.type.Date end_date = 2;

Parameter
Name Description
value com.google.type.Date
Returns
Type Description
Schedule.Builder

setEndDate(Date.Builder builderForValue)

public Schedule.Builder setEndDate(Date.Builder builderForValue)

Date for the final run of the report.

.google.type.Date end_date = 2;

Parameter
Name Description
builderForValue com.google.type.Date.Builder
Returns
Type Description
Schedule.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Schedule.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Schedule.Builder
Overrides

setFrequency(Schedule.Frequency value)

public Schedule.Builder setFrequency(Schedule.Frequency value)

Frequency to run report.

.google.ads.admanager.v1.Schedule.Frequency frequency = 3;

Parameter
Name Description
value Schedule.Frequency

The frequency to set.

Returns
Type Description
Schedule.Builder

This builder for chaining.

setFrequencyValue(int value)

public Schedule.Builder setFrequencyValue(int value)

Frequency to run report.

.google.ads.admanager.v1.Schedule.Frequency frequency = 3;

Parameter
Name Description
value int

The enum numeric value on the wire for frequency to set.

Returns
Type Description
Schedule.Builder

This builder for chaining.

setMonthlySchedule(Schedule.MonthlySchedule value)

public Schedule.Builder setMonthlySchedule(Schedule.MonthlySchedule value)

Days of month to schedule report run.

.google.ads.admanager.v1.Schedule.MonthlySchedule monthly_schedule = 7;

Parameter
Name Description
value Schedule.MonthlySchedule
Returns
Type Description
Schedule.Builder

setMonthlySchedule(Schedule.MonthlySchedule.Builder builderForValue)

public Schedule.Builder setMonthlySchedule(Schedule.MonthlySchedule.Builder builderForValue)

Days of month to schedule report run.

.google.ads.admanager.v1.Schedule.MonthlySchedule monthly_schedule = 7;

Parameter
Name Description
builderForValue Schedule.MonthlySchedule.Builder
Returns
Type Description
Schedule.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Schedule.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Schedule.Builder
Overrides

setStartDate(Date value)

public Schedule.Builder setStartDate(Date value)

Date for the first run of the report.

.google.type.Date start_date = 1;

Parameter
Name Description
value com.google.type.Date
Returns
Type Description
Schedule.Builder

setStartDate(Date.Builder builderForValue)

public Schedule.Builder setStartDate(Date.Builder builderForValue)

Date for the first run of the report.

.google.type.Date start_date = 1;

Parameter
Name Description
builderForValue com.google.type.Date.Builder
Returns
Type Description
Schedule.Builder

setStartTime(TimeOfDay value)

public Schedule.Builder setStartTime(TimeOfDay value)

Indicates start time for schedule to run Will use the time_zone from ReportDefinition. Defaults to the publisher's time zone if not specified.

For HOURLY, TWO_TIMES_DAILY, THREE_TIMES_DAILY, or FOUR_TIMES_DAILY, this will be the time of day that the first report will run on the first day. For example, if the start time is 2:00 PM, and the frequency is THREE_TIMES_DAILY, the first day will have reports scheduled at 2:00 PM, 10:00 PM. Each subsequent day will have reports scheduled at 6:00 AM, 2:00 PM, 10:00 PM.

.google.type.TimeOfDay start_time = 4;

Parameter
Name Description
value com.google.type.TimeOfDay
Returns
Type Description
Schedule.Builder

setStartTime(TimeOfDay.Builder builderForValue)

public Schedule.Builder setStartTime(TimeOfDay.Builder builderForValue)

Indicates start time for schedule to run Will use the time_zone from ReportDefinition. Defaults to the publisher's time zone if not specified.

For HOURLY, TWO_TIMES_DAILY, THREE_TIMES_DAILY, or FOUR_TIMES_DAILY, this will be the time of day that the first report will run on the first day. For example, if the start time is 2:00 PM, and the frequency is THREE_TIMES_DAILY, the first day will have reports scheduled at 2:00 PM, 10:00 PM. Each subsequent day will have reports scheduled at 6:00 AM, 2:00 PM, 10:00 PM.

.google.type.TimeOfDay start_time = 4;

Parameter
Name Description
builderForValue com.google.type.TimeOfDay.Builder
Returns
Type Description
Schedule.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Schedule.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Schedule.Builder
Overrides

setWeeklySchedule(Schedule.WeeklySchedule value)

public Schedule.Builder setWeeklySchedule(Schedule.WeeklySchedule value)

Days of week to schedule report run.

.google.ads.admanager.v1.Schedule.WeeklySchedule weekly_schedule = 6;

Parameter
Name Description
value Schedule.WeeklySchedule
Returns
Type Description
Schedule.Builder

setWeeklySchedule(Schedule.WeeklySchedule.Builder builderForValue)

public Schedule.Builder setWeeklySchedule(Schedule.WeeklySchedule.Builder builderForValue)

Days of week to schedule report run.

.google.ads.admanager.v1.Schedule.WeeklySchedule weekly_schedule = 6;

Parameter
Name Description
builderForValue Schedule.WeeklySchedule.Builder
Returns
Type Description
Schedule.Builder