Package io.temporal.api.schedule.v1

Class CalendarSpec

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CalendarSpecOrBuilder, java.io.Serializable
    @Generated(value="protoc",
           comments="annotations:CalendarSpec.java.pb.meta")
public final class CalendarSpec
extends com.google.protobuf.GeneratedMessageV3
implements CalendarSpecOrBuilder
     CalendarSpec describes an event specification relative to the calendar,
 similar to a traditional cron specification, but with labeled fields. Each
 field can be one of:
   *: matches always
   x: matches when the field equals x
   x/y : matches when the field equals x+n*y where n is an integer
   x-z: matches when the field is between x and z inclusive
   w,x,y,...: matches when the field is one of the listed values
 Each x, y, z, ... is either a decimal integer, or a month or day of week name
 or abbreviation (in the appropriate fields).
 A timestamp matches if all fields match.
 Note that fields have different default values, for convenience.
 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.
 day_of_week can accept 0 or 7 as Sunday
 CalendarSpec gets compiled into StructuredCalendarSpec, which is what will be
 returned if you describe the schedule.
    Protobuf type temporal.api.schedule.v1.CalendarSpec
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  CalendarSpec.Builder
      CalendarSpec describes an event specification relative to the calendar, similar to a traditional cron specification, but with labeled fields.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.String getComment()
      Free-form comment describing the intention of this spec.
      com.google.protobuf.ByteString getCommentBytes()
      Free-form comment describing the intention of this spec.
      java.lang.String getDayOfMonth()
      Expression to match days of the month.
      com.google.protobuf.ByteString getDayOfMonthBytes()
      Expression to match days of the month.
      java.lang.String getDayOfWeek()
      Expression to match days of the week.
      com.google.protobuf.ByteString getDayOfWeekBytes()
      Expression to match days of the week.
      static CalendarSpec getDefaultInstance()  
      CalendarSpec getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      java.lang.String getHour()
      Expression to match hours.
      com.google.protobuf.ByteString getHourBytes()
      Expression to match hours.
      java.lang.String getMinute()
      Expression to match minutes.
      com.google.protobuf.ByteString getMinuteBytes()
      Expression to match minutes.
      java.lang.String getMonth()
      Expression to match months.
      com.google.protobuf.ByteString getMonthBytes()
      Expression to match months.
      com.google.protobuf.Parser<CalendarSpec> getParserForType()  
      java.lang.String getSecond()
      Expression to match seconds.
      com.google.protobuf.ByteString getSecondBytes()
      Expression to match seconds.
      int getSerializedSize()  
      java.lang.String getYear()
      Expression to match years.
      com.google.protobuf.ByteString getYearBytes()
      Expression to match years.
      int hashCode()  
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static CalendarSpec.Builder newBuilder()  
      static CalendarSpec.Builder newBuilder​(CalendarSpec prototype)  
      CalendarSpec.Builder newBuilderForType()  
      protected CalendarSpec.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static CalendarSpec parseDelimitedFrom​(java.io.InputStream input)  
      static CalendarSpec parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static CalendarSpec parseFrom​(byte[] data)  
      static CalendarSpec parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static CalendarSpec parseFrom​(com.google.protobuf.ByteString data)  
      static CalendarSpec parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static CalendarSpec parseFrom​(com.google.protobuf.CodedInputStream input)  
      static CalendarSpec parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static CalendarSpec parseFrom​(java.io.InputStream input)  
      static CalendarSpec parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static CalendarSpec parseFrom​(java.nio.ByteBuffer data)  
      static CalendarSpec parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<CalendarSpec> parser()  
      CalendarSpec.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getSecond

        public java.lang.String getSecond()
         Expression to match seconds. Default: 0
        string second = 1;
        Specified by:
        getSecond in interface CalendarSpecOrBuilder
        Returns:
        The second.

      • getSecondBytes

        public com.google.protobuf.ByteString getSecondBytes()
         Expression to match seconds. Default: 0
        string second = 1;
        Specified by:
        getSecondBytes in interface CalendarSpecOrBuilder
        Returns:
        The bytes for second.

      • getMinute

        public java.lang.String getMinute()
         Expression to match minutes. Default: 0
        string minute = 2;
        Specified by:
        getMinute in interface CalendarSpecOrBuilder
        Returns:
        The minute.

      • getMinuteBytes

        public com.google.protobuf.ByteString getMinuteBytes()
         Expression to match minutes. Default: 0
        string minute = 2;
        Specified by:
        getMinuteBytes in interface CalendarSpecOrBuilder
        Returns:
        The bytes for minute.

      • getHour

        public java.lang.String getHour()
         Expression to match hours. Default: 0
        string hour = 3;
        Specified by:
        getHour in interface CalendarSpecOrBuilder
        Returns:
        The hour.

      • getHourBytes

        public com.google.protobuf.ByteString getHourBytes()
         Expression to match hours. Default: 0
        string hour = 3;
        Specified by:
        getHourBytes in interface CalendarSpecOrBuilder
        Returns:
        The bytes for hour.

      • getDayOfMonth

        public java.lang.String getDayOfMonth()
         Expression to match days of the month. Default: *
 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: standard name of field --)
        string day_of_month = 4;
        Specified by:
        getDayOfMonth in interface CalendarSpecOrBuilder
        Returns:
        The dayOfMonth.

      • getDayOfMonthBytes

        public com.google.protobuf.ByteString getDayOfMonthBytes()
         Expression to match days of the month. Default: *
 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: standard name of field --)
        string day_of_month = 4;
        Specified by:
        getDayOfMonthBytes in interface CalendarSpecOrBuilder
        Returns:
        The bytes for dayOfMonth.

      • getMonth

        public java.lang.String getMonth()
         Expression to match months. Default: *
        string month = 5;
        Specified by:
        getMonth in interface CalendarSpecOrBuilder
        Returns:
        The month.

      • getMonthBytes

        public com.google.protobuf.ByteString getMonthBytes()
         Expression to match months. Default: *
        string month = 5;
        Specified by:
        getMonthBytes in interface CalendarSpecOrBuilder
        Returns:
        The bytes for month.

      • getYear

        public java.lang.String getYear()
         Expression to match years. Default: *
        string year = 6;
        Specified by:
        getYear in interface CalendarSpecOrBuilder
        Returns:
        The year.

      • getYearBytes

        public com.google.protobuf.ByteString getYearBytes()
         Expression to match years. Default: *
        string year = 6;
        Specified by:
        getYearBytes in interface CalendarSpecOrBuilder
        Returns:
        The bytes for year.

      • getDayOfWeek

        public java.lang.String getDayOfWeek()
         Expression to match days of the week. Default: *
        string day_of_week = 7;
        Specified by:
        getDayOfWeek in interface CalendarSpecOrBuilder
        Returns:
        The dayOfWeek.

      • getDayOfWeekBytes

        public com.google.protobuf.ByteString getDayOfWeekBytes()
         Expression to match days of the week. Default: *
        string day_of_week = 7;
        Specified by:
        getDayOfWeekBytes in interface CalendarSpecOrBuilder
        Returns:
        The bytes for dayOfWeek.

      • getComment

        public java.lang.String getComment()
         Free-form comment describing the intention of this spec.
        string comment = 8;
        Specified by:
        getComment in interface CalendarSpecOrBuilder
        Returns:
        The comment.

      • getCommentBytes

        public com.google.protobuf.ByteString getCommentBytes()
         Free-form comment describing the intention of this spec.
        string comment = 8;
        Specified by:
        getCommentBytes in interface CalendarSpecOrBuilder
        Returns:
        The bytes for comment.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static CalendarSpec parseFrom​(java.nio.ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CalendarSpec parseFrom​(java.nio.ByteBuffer data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CalendarSpec parseFrom​(com.google.protobuf.ByteString data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CalendarSpec parseFrom​(com.google.protobuf.ByteString data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CalendarSpec parseFrom​(byte[] data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CalendarSpec parseFrom​(byte[] data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static CalendarSpec parseFrom​(java.io.InputStream input)
                              throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static CalendarSpec parseFrom​(java.io.InputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static CalendarSpec parseDelimitedFrom​(java.io.InputStream input)
                                       throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static CalendarSpec parseDelimitedFrom​(java.io.InputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static CalendarSpec parseFrom​(com.google.protobuf.CodedInputStream input)
                              throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static CalendarSpec parseFrom​(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

        public CalendarSpec.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public CalendarSpec.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected CalendarSpec.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static CalendarSpec getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<CalendarSpec> parser()

      • getParserForType

        public com.google.protobuf.Parser<CalendarSpec> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public CalendarSpec getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder