Package io.temporal.api.taskqueue.v1

Class CompatibleBuildIdRedirectRule

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CompatibleBuildIdRedirectRuleOrBuilder, java.io.Serializable
    @Generated(value="protoc",
           comments="annotations:CompatibleBuildIdRedirectRule.java.pb.meta")
public final class CompatibleBuildIdRedirectRule
extends com.google.protobuf.GeneratedMessageV3
implements CompatibleBuildIdRedirectRuleOrBuilder
     These rules apply to tasks assigned to a particular Build ID
 (`source_build_id`) to redirect them to another *compatible* Build ID
 (`target_build_id`).

 It is user's responsibility to ensure that the target Build ID is compatible
 with the source Build ID (e.g. by using the Patching API).

 Most deployments are not expected to need these rules, however following
 situations can greatly benefit from redirects:
  - Need to move long-running Workflow Executions from an old Build ID to a
    newer one.
  - Need to hotfix some broken or stuck Workflow Executions.

 In steady state, redirect rules are beneficial when dealing with old
 Executions ran on now-decommissioned Build IDs:
  - To redirecting the Workflow Queries to the current (compatible) Build ID.
  - To be able to Reset an old Execution so it can run on the current
    (compatible) Build ID.

 Redirect rules can be chained.
    Protobuf type temporal.api.taskqueue.v1.CompatibleBuildIdRedirectRule
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  CompatibleBuildIdRedirectRule.Builder
      These rules apply to tasks assigned to a particular Build ID (`source_build_id`) to redirect them to another *compatible* Build ID (`target_build_id`).

      • 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

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int SOURCE_BUILD_ID_FIELD_NUMBER  
      static int TARGET_BUILD_ID_FIELD_NUMBER  

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

        alwaysUseFieldBuilders, unknownFields

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

        memoizedSize

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

        memoizedHashCode

    • Field Detail

      • SOURCE_BUILD_ID_FIELD_NUMBER

        public static final int SOURCE_BUILD_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TARGET_BUILD_ID_FIELD_NUMBER

        public static final int TARGET_BUILD_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

    • 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

      • getTargetBuildId

        public java.lang.String getTargetBuildId()
         Target Build ID must be compatible with the Source Build ID; that is it
 must be able to process event histories made by the Source Build ID by
 using [Patching](https://docs.temporal.io/workflows#patching) or other
 means.
        string target_build_id = 2;
        Specified by:
        getTargetBuildId in interface CompatibleBuildIdRedirectRuleOrBuilder
        Returns:
        The targetBuildId.

      • getTargetBuildIdBytes

        public com.google.protobuf.ByteString getTargetBuildIdBytes()
         Target Build ID must be compatible with the Source Build ID; that is it
 must be able to process event histories made by the Source Build ID by
 using [Patching](https://docs.temporal.io/workflows#patching) or other
 means.
        string target_build_id = 2;
        Specified by:
        getTargetBuildIdBytes in interface CompatibleBuildIdRedirectRuleOrBuilder
        Returns:
        The bytes for targetBuildId.

      • 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 CompatibleBuildIdRedirectRule parseFrom​(java.nio.ByteBuffer data)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<CompatibleBuildIdRedirectRule> 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 CompatibleBuildIdRedirectRule getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder