Class ScheduleOptions.Schedule (0.39.0)

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

The schedule for the report

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

Static Fields

END_DATE_FIELD_NUMBER

public static final int END_DATE_FIELD_NUMBER
Field Value
Type Description
int

FREQUENCY_FIELD_NUMBER

public static final int FREQUENCY_FIELD_NUMBER
Field Value
Type Description
int

MONTHLY_SCHEDULE_FIELD_NUMBER

public static final int MONTHLY_SCHEDULE_FIELD_NUMBER
Field Value
Type Description
int

START_DATE_FIELD_NUMBER

public static final int START_DATE_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

WEEKLY_SCHEDULE_FIELD_NUMBER

public static final int WEEKLY_SCHEDULE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ScheduleOptions.Schedule getDefaultInstance()
Returns
Type Description
ScheduleOptions.Schedule

getDescriptor()

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

newBuilder()

public static ScheduleOptions.Schedule.Builder newBuilder()
Returns
Type Description
ScheduleOptions.Schedule.Builder

newBuilder(ScheduleOptions.Schedule prototype)

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

parseDelimitedFrom(InputStream input)

public static ScheduleOptions.Schedule parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ScheduleOptions.Schedule
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static ScheduleOptions.Schedule parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ScheduleOptions.Schedule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static ScheduleOptions.Schedule parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ScheduleOptions.Schedule
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static ScheduleOptions.Schedule parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ScheduleOptions.Schedule
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static ScheduleOptions.Schedule parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ScheduleOptions.Schedule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<ScheduleOptions.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

getDefaultInstanceForType()

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

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.

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.

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

getParserForType()

public Parser<ScheduleOptions.Schedule> getParserForType()
Returns
Type Description
Parser<Schedule>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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