Class ScheduleOptions.Schedule.Builder (0.39.0)

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

The schedule for the report

Protobuf type google.ads.admanager.v1.ScheduleOptions.Schedule

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ScheduleOptions.Schedule build()
Returns
Type Description
ScheduleOptions.Schedule

buildPartial()

public ScheduleOptions.Schedule buildPartial()
Returns
Type Description
ScheduleOptions.Schedule

clear()

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

clearEndDate()

public ScheduleOptions.Schedule.Builder clearEndDate()

Date for the final run of the report.

.google.type.Date end_date = 2;

Returns
Type Description
ScheduleOptions.Schedule.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearFrequency()

public ScheduleOptions.Schedule.Builder clearFrequency()

Frequency to run report.

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

Returns
Type Description
ScheduleOptions.Schedule.Builder

This builder for chaining.

clearFrequencySchedule()

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

clearMonthlySchedule()

public ScheduleOptions.Schedule.Builder clearMonthlySchedule()

Days of month to schedule report run.

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

Returns
Type Description
ScheduleOptions.Schedule.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearStartDate()

public ScheduleOptions.Schedule.Builder clearStartDate()

Date for the first run of the report.

.google.type.Date start_date = 1;

Returns
Type Description
ScheduleOptions.Schedule.Builder

clearStartTime()

public ScheduleOptions.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
ScheduleOptions.Schedule.Builder

clearWeeklySchedule()

public ScheduleOptions.Schedule.Builder clearWeeklySchedule()

Days of week to schedule report run.

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

Returns
Type Description
ScheduleOptions.Schedule.Builder

clone()

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

getDefaultInstanceForType()

public ScheduleOptions.Schedule getDefaultInstanceForType()
Returns
Type Description
ScheduleOptions.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 ScheduleOptions.Schedule.Frequency getFrequency()

Frequency to run report.

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

Returns
Type Description
ScheduleOptions.Schedule.Frequency

The frequency.

getFrequencyScheduleCase()

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

getFrequencyValue()

public int getFrequencyValue()

Frequency to run report.

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

Returns
Type Description
int

The enum numeric value on the wire for frequency.

getMonthlySchedule()

public ScheduleOptions.Schedule.MonthlySchedule getMonthlySchedule()

Days of month to schedule report run.

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

Returns
Type Description
ScheduleOptions.Schedule.MonthlySchedule

The monthlySchedule.

getMonthlyScheduleBuilder()

public ScheduleOptions.Schedule.MonthlySchedule.Builder getMonthlyScheduleBuilder()

Days of month to schedule report run.

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

Returns
Type Description
ScheduleOptions.Schedule.MonthlySchedule.Builder

getMonthlyScheduleOrBuilder()

public ScheduleOptions.Schedule.MonthlyScheduleOrBuilder getMonthlyScheduleOrBuilder()

Days of month to schedule report run.

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

Returns
Type Description
ScheduleOptions.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 ScheduleOptions.Schedule.WeeklySchedule getWeeklySchedule()

Days of week to schedule report run.

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

Returns
Type Description
ScheduleOptions.Schedule.WeeklySchedule

The weeklySchedule.

getWeeklyScheduleBuilder()

public ScheduleOptions.Schedule.WeeklySchedule.Builder getWeeklyScheduleBuilder()

Days of week to schedule report run.

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

Returns
Type Description
ScheduleOptions.Schedule.WeeklySchedule.Builder

getWeeklyScheduleOrBuilder()

public ScheduleOptions.Schedule.WeeklyScheduleOrBuilder getWeeklyScheduleOrBuilder()

Days of week to schedule report run.

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

Returns
Type Description
ScheduleOptions.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.ScheduleOptions.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.ScheduleOptions.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 ScheduleOptions.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
ScheduleOptions.Schedule.Builder

mergeFrom(ScheduleOptions.Schedule other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeMonthlySchedule(ScheduleOptions.Schedule.MonthlySchedule value)

public ScheduleOptions.Schedule.Builder mergeMonthlySchedule(ScheduleOptions.Schedule.MonthlySchedule value)

Days of month to schedule report run.

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

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

mergeStartDate(Date value)

public ScheduleOptions.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
ScheduleOptions.Schedule.Builder

mergeStartTime(TimeOfDay value)

public ScheduleOptions.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
ScheduleOptions.Schedule.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeWeeklySchedule(ScheduleOptions.Schedule.WeeklySchedule value)

public ScheduleOptions.Schedule.Builder mergeWeeklySchedule(ScheduleOptions.Schedule.WeeklySchedule value)

Days of week to schedule report run.

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

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

setEndDate(Date value)

public ScheduleOptions.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
ScheduleOptions.Schedule.Builder

setEndDate(Date.Builder builderForValue)

public ScheduleOptions.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
ScheduleOptions.Schedule.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setFrequency(ScheduleOptions.Schedule.Frequency value)

public ScheduleOptions.Schedule.Builder setFrequency(ScheduleOptions.Schedule.Frequency value)

Frequency to run report.

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

Parameter
Name Description
value ScheduleOptions.Schedule.Frequency

The frequency to set.

Returns
Type Description
ScheduleOptions.Schedule.Builder

This builder for chaining.

setFrequencyValue(int value)

public ScheduleOptions.Schedule.Builder setFrequencyValue(int value)

Frequency to run report.

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

Parameter
Name Description
value int

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

Returns
Type Description
ScheduleOptions.Schedule.Builder

This builder for chaining.

setMonthlySchedule(ScheduleOptions.Schedule.MonthlySchedule value)

public ScheduleOptions.Schedule.Builder setMonthlySchedule(ScheduleOptions.Schedule.MonthlySchedule value)

Days of month to schedule report run.

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

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

setMonthlySchedule(ScheduleOptions.Schedule.MonthlySchedule.Builder builderForValue)

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

Days of month to schedule report run.

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

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

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

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

setStartDate(Date value)

public ScheduleOptions.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
ScheduleOptions.Schedule.Builder

setStartDate(Date.Builder builderForValue)

public ScheduleOptions.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
ScheduleOptions.Schedule.Builder

setStartTime(TimeOfDay value)

public ScheduleOptions.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
ScheduleOptions.Schedule.Builder

setStartTime(TimeOfDay.Builder builderForValue)

public ScheduleOptions.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
ScheduleOptions.Schedule.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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

setWeeklySchedule(ScheduleOptions.Schedule.WeeklySchedule value)

public ScheduleOptions.Schedule.Builder setWeeklySchedule(ScheduleOptions.Schedule.WeeklySchedule value)

Days of week to schedule report run.

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

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

setWeeklySchedule(ScheduleOptions.Schedule.WeeklySchedule.Builder builderForValue)

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

Days of week to schedule report run.

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

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