Package io.temporal.api.schedule.v1
Interface ScheduleSpecOrBuilder
-
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
ScheduleSpec
,ScheduleSpec.Builder
@Generated(value="protoc", comments="annotations:ScheduleSpecOrBuilder.java.pb.meta") public interface ScheduleSpecOrBuilder extends com.google.protobuf.MessageOrBuilder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description CalendarSpec
getCalendar(int index)
Calendar-based specifications of times.int
getCalendarCount()
Calendar-based specifications of times.java.util.List<CalendarSpec>
getCalendarList()
Calendar-based specifications of times.CalendarSpecOrBuilder
getCalendarOrBuilder(int index)
Calendar-based specifications of times.java.util.List<? extends CalendarSpecOrBuilder>
getCalendarOrBuilderList()
Calendar-based specifications of times.java.lang.String
getCronString(int index)
cron_string holds a traditional cron specification as a string.com.google.protobuf.ByteString
getCronStringBytes(int index)
cron_string holds a traditional cron specification as a string.int
getCronStringCount()
cron_string holds a traditional cron specification as a string.java.util.List<java.lang.String>
getCronStringList()
cron_string holds a traditional cron specification as a string.com.google.protobuf.Timestamp
getEndTime()
If end_time is set, any timestamps after end_time will be skipped.com.google.protobuf.TimestampOrBuilder
getEndTimeOrBuilder()
If end_time is set, any timestamps after end_time will be skipped.CalendarSpec
getExcludeCalendar(int index)
Deprecated.int
getExcludeCalendarCount()
Deprecated.java.util.List<CalendarSpec>
getExcludeCalendarList()
Deprecated.CalendarSpecOrBuilder
getExcludeCalendarOrBuilder(int index)
Deprecated.java.util.List<? extends CalendarSpecOrBuilder>
getExcludeCalendarOrBuilderList()
Deprecated.StructuredCalendarSpec
getExcludeStructuredCalendar(int index)
repeated .temporal.api.schedule.v1.StructuredCalendarSpec exclude_structured_calendar = 9;
int
getExcludeStructuredCalendarCount()
repeated .temporal.api.schedule.v1.StructuredCalendarSpec exclude_structured_calendar = 9;
java.util.List<StructuredCalendarSpec>
getExcludeStructuredCalendarList()
repeated .temporal.api.schedule.v1.StructuredCalendarSpec exclude_structured_calendar = 9;
StructuredCalendarSpecOrBuilder
getExcludeStructuredCalendarOrBuilder(int index)
repeated .temporal.api.schedule.v1.StructuredCalendarSpec exclude_structured_calendar = 9;
java.util.List<? extends StructuredCalendarSpecOrBuilder>
getExcludeStructuredCalendarOrBuilderList()
repeated .temporal.api.schedule.v1.StructuredCalendarSpec exclude_structured_calendar = 9;
IntervalSpec
getInterval(int index)
Interval-based specifications of times.int
getIntervalCount()
Interval-based specifications of times.java.util.List<IntervalSpec>
getIntervalList()
Interval-based specifications of times.IntervalSpecOrBuilder
getIntervalOrBuilder(int index)
Interval-based specifications of times.java.util.List<? extends IntervalSpecOrBuilder>
getIntervalOrBuilderList()
Interval-based specifications of times.com.google.protobuf.Duration
getJitter()
All timestamps will be incremented by a random value from 0 to this amount of jitter.com.google.protobuf.DurationOrBuilder
getJitterOrBuilder()
All timestamps will be incremented by a random value from 0 to this amount of jitter.com.google.protobuf.Timestamp
getStartTime()
If start_time is set, any timestamps before start_time will be skipped.com.google.protobuf.TimestampOrBuilder
getStartTimeOrBuilder()
If start_time is set, any timestamps before start_time will be skipped.StructuredCalendarSpec
getStructuredCalendar(int index)
Calendar-based specifications of times.int
getStructuredCalendarCount()
Calendar-based specifications of times.java.util.List<StructuredCalendarSpec>
getStructuredCalendarList()
Calendar-based specifications of times.StructuredCalendarSpecOrBuilder
getStructuredCalendarOrBuilder(int index)
Calendar-based specifications of times.java.util.List<? extends StructuredCalendarSpecOrBuilder>
getStructuredCalendarOrBuilderList()
Calendar-based specifications of times.com.google.protobuf.ByteString
getTimezoneData()
bytes timezone_data = 11;
java.lang.String
getTimezoneName()
Time zone to interpret all calendar-based specs in.com.google.protobuf.ByteString
getTimezoneNameBytes()
Time zone to interpret all calendar-based specs in.boolean
hasEndTime()
If end_time is set, any timestamps after end_time will be skipped.boolean
hasJitter()
All timestamps will be incremented by a random value from 0 to this amount of jitter.boolean
hasStartTime()
If start_time is set, any timestamps before start_time will be skipped.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
getStructuredCalendarList
java.util.List<StructuredCalendarSpec> getStructuredCalendarList()
Calendar-based specifications of times.
repeated .temporal.api.schedule.v1.StructuredCalendarSpec structured_calendar = 7;
-
getStructuredCalendar
StructuredCalendarSpec getStructuredCalendar(int index)
Calendar-based specifications of times.
repeated .temporal.api.schedule.v1.StructuredCalendarSpec structured_calendar = 7;
-
getStructuredCalendarCount
int getStructuredCalendarCount()
Calendar-based specifications of times.
repeated .temporal.api.schedule.v1.StructuredCalendarSpec structured_calendar = 7;
-
getStructuredCalendarOrBuilderList
java.util.List<? extends StructuredCalendarSpecOrBuilder> getStructuredCalendarOrBuilderList()
Calendar-based specifications of times.
repeated .temporal.api.schedule.v1.StructuredCalendarSpec structured_calendar = 7;
-
getStructuredCalendarOrBuilder
StructuredCalendarSpecOrBuilder getStructuredCalendarOrBuilder(int index)
Calendar-based specifications of times.
repeated .temporal.api.schedule.v1.StructuredCalendarSpec structured_calendar = 7;
-
getCronStringList
java.util.List<java.lang.String> getCronStringList()
cron_string holds a traditional cron specification as a string. It accepts 5, 6, or 7 fields, separated by spaces, and interprets them the same way as CalendarSpec. 5 fields: minute, hour, day_of_month, month, day_of_week 6 fields: minute, hour, day_of_month, month, day_of_week, year 7 fields: second, minute, hour, day_of_month, month, day_of_week, year If year is not given, it defaults to *. If second is not given, it defaults to 0. Shorthands @yearly, @monthly, @weekly, @daily, and @hourly are also accepted instead of the 5-7 time fields. Optionally, the string can be preceded by CRON_TZ=<timezone name> or TZ=<timezone name>, which will get copied to timezone_name. (There must not also be a timezone_name present.) Optionally "#" followed by a comment can appear at the end of the string. Note that the special case that some cron implementations have for treating day_of_month and day_of_week as "or" instead of "and" when both are set is not implemented. @every <interval>[/<phase>] is accepted and gets compiled into an IntervalSpec instead. <interval> and <phase> should be a decimal integer with a unit suffix s, m, h, or d.
repeated string cron_string = 8;
- Returns:
- A list containing the cronString.
-
getCronStringCount
int getCronStringCount()
cron_string holds a traditional cron specification as a string. It accepts 5, 6, or 7 fields, separated by spaces, and interprets them the same way as CalendarSpec. 5 fields: minute, hour, day_of_month, month, day_of_week 6 fields: minute, hour, day_of_month, month, day_of_week, year 7 fields: second, minute, hour, day_of_month, month, day_of_week, year If year is not given, it defaults to *. If second is not given, it defaults to 0. Shorthands @yearly, @monthly, @weekly, @daily, and @hourly are also accepted instead of the 5-7 time fields. Optionally, the string can be preceded by CRON_TZ=<timezone name> or TZ=<timezone name>, which will get copied to timezone_name. (There must not also be a timezone_name present.) Optionally "#" followed by a comment can appear at the end of the string. Note that the special case that some cron implementations have for treating day_of_month and day_of_week as "or" instead of "and" when both are set is not implemented. @every <interval>[/<phase>] is accepted and gets compiled into an IntervalSpec instead. <interval> and <phase> should be a decimal integer with a unit suffix s, m, h, or d.
repeated string cron_string = 8;
- Returns:
- The count of cronString.
-
getCronString
java.lang.String getCronString(int index)
cron_string holds a traditional cron specification as a string. It accepts 5, 6, or 7 fields, separated by spaces, and interprets them the same way as CalendarSpec. 5 fields: minute, hour, day_of_month, month, day_of_week 6 fields: minute, hour, day_of_month, month, day_of_week, year 7 fields: second, minute, hour, day_of_month, month, day_of_week, year If year is not given, it defaults to *. If second is not given, it defaults to 0. Shorthands @yearly, @monthly, @weekly, @daily, and @hourly are also accepted instead of the 5-7 time fields. Optionally, the string can be preceded by CRON_TZ=<timezone name> or TZ=<timezone name>, which will get copied to timezone_name. (There must not also be a timezone_name present.) Optionally "#" followed by a comment can appear at the end of the string. Note that the special case that some cron implementations have for treating day_of_month and day_of_week as "or" instead of "and" when both are set is not implemented. @every <interval>[/<phase>] is accepted and gets compiled into an IntervalSpec instead. <interval> and <phase> should be a decimal integer with a unit suffix s, m, h, or d.
repeated string cron_string = 8;
- Parameters:
index
- The index of the element to return.- Returns:
- The cronString at the given index.
-
getCronStringBytes
com.google.protobuf.ByteString getCronStringBytes(int index)
cron_string holds a traditional cron specification as a string. It accepts 5, 6, or 7 fields, separated by spaces, and interprets them the same way as CalendarSpec. 5 fields: minute, hour, day_of_month, month, day_of_week 6 fields: minute, hour, day_of_month, month, day_of_week, year 7 fields: second, minute, hour, day_of_month, month, day_of_week, year If year is not given, it defaults to *. If second is not given, it defaults to 0. Shorthands @yearly, @monthly, @weekly, @daily, and @hourly are also accepted instead of the 5-7 time fields. Optionally, the string can be preceded by CRON_TZ=<timezone name> or TZ=<timezone name>, which will get copied to timezone_name. (There must not also be a timezone_name present.) Optionally "#" followed by a comment can appear at the end of the string. Note that the special case that some cron implementations have for treating day_of_month and day_of_week as "or" instead of "and" when both are set is not implemented. @every <interval>[/<phase>] is accepted and gets compiled into an IntervalSpec instead. <interval> and <phase> should be a decimal integer with a unit suffix s, m, h, or d.
repeated string cron_string = 8;
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the cronString at the given index.
-
getCalendarList
java.util.List<CalendarSpec> getCalendarList()
Calendar-based specifications of times.
repeated .temporal.api.schedule.v1.CalendarSpec calendar = 1;
-
getCalendar
CalendarSpec getCalendar(int index)
Calendar-based specifications of times.
repeated .temporal.api.schedule.v1.CalendarSpec calendar = 1;
-
getCalendarCount
int getCalendarCount()
Calendar-based specifications of times.
repeated .temporal.api.schedule.v1.CalendarSpec calendar = 1;
-
getCalendarOrBuilderList
java.util.List<? extends CalendarSpecOrBuilder> getCalendarOrBuilderList()
Calendar-based specifications of times.
repeated .temporal.api.schedule.v1.CalendarSpec calendar = 1;
-
getCalendarOrBuilder
CalendarSpecOrBuilder getCalendarOrBuilder(int index)
Calendar-based specifications of times.
repeated .temporal.api.schedule.v1.CalendarSpec calendar = 1;
-
getIntervalList
java.util.List<IntervalSpec> getIntervalList()
Interval-based specifications of times.
repeated .temporal.api.schedule.v1.IntervalSpec interval = 2;
-
getInterval
IntervalSpec getInterval(int index)
Interval-based specifications of times.
repeated .temporal.api.schedule.v1.IntervalSpec interval = 2;
-
getIntervalCount
int getIntervalCount()
Interval-based specifications of times.
repeated .temporal.api.schedule.v1.IntervalSpec interval = 2;
-
getIntervalOrBuilderList
java.util.List<? extends IntervalSpecOrBuilder> getIntervalOrBuilderList()
Interval-based specifications of times.
repeated .temporal.api.schedule.v1.IntervalSpec interval = 2;
-
getIntervalOrBuilder
IntervalSpecOrBuilder getIntervalOrBuilder(int index)
Interval-based specifications of times.
repeated .temporal.api.schedule.v1.IntervalSpec interval = 2;
-
getExcludeCalendarList
@Deprecated java.util.List<CalendarSpec> getExcludeCalendarList()
Deprecated.Any timestamps matching any of exclude_* will be skipped.
repeated .temporal.api.schedule.v1.CalendarSpec exclude_calendar = 3 [deprecated = true];
-
getExcludeCalendar
@Deprecated CalendarSpec getExcludeCalendar(int index)
Deprecated.Any timestamps matching any of exclude_* will be skipped.
repeated .temporal.api.schedule.v1.CalendarSpec exclude_calendar = 3 [deprecated = true];
-
getExcludeCalendarCount
@Deprecated int getExcludeCalendarCount()
Deprecated.Any timestamps matching any of exclude_* will be skipped.
repeated .temporal.api.schedule.v1.CalendarSpec exclude_calendar = 3 [deprecated = true];
-
getExcludeCalendarOrBuilderList
@Deprecated java.util.List<? extends CalendarSpecOrBuilder> getExcludeCalendarOrBuilderList()
Deprecated.Any timestamps matching any of exclude_* will be skipped.
repeated .temporal.api.schedule.v1.CalendarSpec exclude_calendar = 3 [deprecated = true];
-
getExcludeCalendarOrBuilder
@Deprecated CalendarSpecOrBuilder getExcludeCalendarOrBuilder(int index)
Deprecated.Any timestamps matching any of exclude_* will be skipped.
repeated .temporal.api.schedule.v1.CalendarSpec exclude_calendar = 3 [deprecated = true];
-
getExcludeStructuredCalendarList
java.util.List<StructuredCalendarSpec> getExcludeStructuredCalendarList()
repeated .temporal.api.schedule.v1.StructuredCalendarSpec exclude_structured_calendar = 9;
-
getExcludeStructuredCalendar
StructuredCalendarSpec getExcludeStructuredCalendar(int index)
repeated .temporal.api.schedule.v1.StructuredCalendarSpec exclude_structured_calendar = 9;
-
getExcludeStructuredCalendarCount
int getExcludeStructuredCalendarCount()
repeated .temporal.api.schedule.v1.StructuredCalendarSpec exclude_structured_calendar = 9;
-
getExcludeStructuredCalendarOrBuilderList
java.util.List<? extends StructuredCalendarSpecOrBuilder> getExcludeStructuredCalendarOrBuilderList()
repeated .temporal.api.schedule.v1.StructuredCalendarSpec exclude_structured_calendar = 9;
-
getExcludeStructuredCalendarOrBuilder
StructuredCalendarSpecOrBuilder getExcludeStructuredCalendarOrBuilder(int index)
repeated .temporal.api.schedule.v1.StructuredCalendarSpec exclude_structured_calendar = 9;
-
hasStartTime
boolean hasStartTime()
If start_time is set, any timestamps before start_time will be skipped. (Together, start_time and end_time make an inclusive interval.)
.google.protobuf.Timestamp start_time = 4 [(.gogoproto.stdtime) = true];
- Returns:
- Whether the startTime field is set.
-
getStartTime
com.google.protobuf.Timestamp getStartTime()
If start_time is set, any timestamps before start_time will be skipped. (Together, start_time and end_time make an inclusive interval.)
.google.protobuf.Timestamp start_time = 4 [(.gogoproto.stdtime) = true];
- Returns:
- The startTime.
-
getStartTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
If start_time is set, any timestamps before start_time will be skipped. (Together, start_time and end_time make an inclusive interval.)
.google.protobuf.Timestamp start_time = 4 [(.gogoproto.stdtime) = true];
-
hasEndTime
boolean hasEndTime()
If end_time is set, any timestamps after end_time will be skipped.
.google.protobuf.Timestamp end_time = 5 [(.gogoproto.stdtime) = true];
- Returns:
- Whether the endTime field is set.
-
getEndTime
com.google.protobuf.Timestamp getEndTime()
If end_time is set, any timestamps after end_time will be skipped.
.google.protobuf.Timestamp end_time = 5 [(.gogoproto.stdtime) = true];
- Returns:
- The endTime.
-
getEndTimeOrBuilder
com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()
If end_time is set, any timestamps after end_time will be skipped.
.google.protobuf.Timestamp end_time = 5 [(.gogoproto.stdtime) = true];
-
hasJitter
boolean hasJitter()
All timestamps will be incremented by a random value from 0 to this amount of jitter. Default: 0
.google.protobuf.Duration jitter = 6 [(.gogoproto.stdduration) = true];
- Returns:
- Whether the jitter field is set.
-
getJitter
com.google.protobuf.Duration getJitter()
All timestamps will be incremented by a random value from 0 to this amount of jitter. Default: 0
.google.protobuf.Duration jitter = 6 [(.gogoproto.stdduration) = true];
- Returns:
- The jitter.
-
getJitterOrBuilder
com.google.protobuf.DurationOrBuilder getJitterOrBuilder()
All timestamps will be incremented by a random value from 0 to this amount of jitter. Default: 0
.google.protobuf.Duration jitter = 6 [(.gogoproto.stdduration) = true];
-
getTimezoneName
java.lang.String getTimezoneName()
Time zone to interpret all calendar-based specs in. If unset, defaults to UTC. We recommend using UTC for your application if at all possible, to avoid various surprising properties of time zones. Time zones may be provided by name, corresponding to names in the IANA time zone database (see https://www.iana.org/time-zones). The definition will be loaded by the Temporal server from the environment it runs in. If your application requires more control over the time zone definition used, it may pass in a complete definition in the form of a TZif file from the time zone database. If present, this will be used instead of loading anything from the environment. You are then responsible for updating timezone_data when the definition changes. Calendar spec matching is based on literal matching of the clock time with no special handling of DST: if you write a calendar spec that fires at 2:30am and specify a time zone that follows DST, that action will not be triggered on the day that has no 2:30am. Similarly, an action that fires at 1:30am will be triggered twice on the day that has two 1:30s. Also note that no actions are taken on leap-seconds (e.g. 23:59:60 UTC).
string timezone_name = 10;
- Returns:
- The timezoneName.
-
getTimezoneNameBytes
com.google.protobuf.ByteString getTimezoneNameBytes()
Time zone to interpret all calendar-based specs in. If unset, defaults to UTC. We recommend using UTC for your application if at all possible, to avoid various surprising properties of time zones. Time zones may be provided by name, corresponding to names in the IANA time zone database (see https://www.iana.org/time-zones). The definition will be loaded by the Temporal server from the environment it runs in. If your application requires more control over the time zone definition used, it may pass in a complete definition in the form of a TZif file from the time zone database. If present, this will be used instead of loading anything from the environment. You are then responsible for updating timezone_data when the definition changes. Calendar spec matching is based on literal matching of the clock time with no special handling of DST: if you write a calendar spec that fires at 2:30am and specify a time zone that follows DST, that action will not be triggered on the day that has no 2:30am. Similarly, an action that fires at 1:30am will be triggered twice on the day that has two 1:30s. Also note that no actions are taken on leap-seconds (e.g. 23:59:60 UTC).
string timezone_name = 10;
- Returns:
- The bytes for timezoneName.
-
getTimezoneData
com.google.protobuf.ByteString getTimezoneData()
bytes timezone_data = 11;
- Returns:
- The timezoneData.
-
-