Class BuildIdAssignmentRule

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.temporal.api.taskqueue.v1.BuildIdAssignmentRule
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, BuildIdAssignmentRuleOrBuilder, Serializable
@Generated(value="protoc", comments="annotations:BuildIdAssignmentRule.java.pb.meta") public final class BuildIdAssignmentRule extends com.google.protobuf.GeneratedMessageV3 implements BuildIdAssignmentRuleOrBuilder
 Assignment rules are applied to *new* Workflow and Activity executions at
 schedule time to assign them to a Build ID.

 Assignment rules will not be used in the following cases:
    - Child Workflows or Continue-As-New Executions who inherit their
      parent/previous Workflow's assigned Build ID (by setting the
      `inherit_build_id` flag - default behavior in SDKs when the same Task Queue
      is used.)
    - An Activity that inherits the assigned Build ID of its Workflow (by
      setting the `use_workflow_build_id` flag - default behavior in SDKs
      when the same Task Queue is used.)

 In absence of (applicable) redirect rules (`CompatibleBuildIdRedirectRule`s)
 the task will be dispatched to Workers of the Build ID determined by the
 assignment rules (or inherited). Otherwise, the final Build ID will be
 determined by the redirect rules.

 Once a Workflow completes its first Workflow Task in a particular Build ID it
 stays in that Build ID regardless of changes to assignment rules. Redirect
 rules can be used to move the workflow to another compatible Build ID.

 When using Worker Versioning on a Task Queue, in the steady state,
 there should typically be a single assignment rule to send all new executions
 to the latest Build ID. Existence of at least one such "unconditional"
 rule at all times is enforces by the system, unless the `force` flag is used
 by the user when replacing/deleting these rules (for exceptional cases).

 During a deployment, one or more additional rules can be added to assign a
 subset of the tasks to a new Build ID based on a "ramp percentage".

 When there are multiple assignment rules for a Task Queue, the rules are
 evaluated in order, starting from index 0. The first applicable rule will be
 applied and the rest will be ignored.

 In the event that no assignment rule is applicable on a task (or the Task
 Queue is simply not versioned), the tasks will be dispatched to an
 unversioned Worker.
Protobuf type temporal.api.taskqueue.v1.BuildIdAssignmentRule
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    BuildIdAssignmentRule.Builder
    Assignment rules are applied to *new* Workflow and Activity executions at schedule time to assign them to a Build ID.
    static enum 
    BuildIdAssignmentRule.RampCase
     

    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 final int
    PERCENTAGE_RAMP_FIELD_NUMBER
     
    static final 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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static BuildIdAssignmentRule
    getDefaultInstance()
     
    BuildIdAssignmentRule
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<BuildIdAssignmentRule>
    getParserForType()
     
    RampByPercentage
    getPercentageRamp()
    This ramp is useful for gradual Blue/Green deployments (and similar) where you want to send a certain portion of the traffic to the target Build ID.
    RampByPercentageOrBuilder
    getPercentageRampOrBuilder()
    This ramp is useful for gradual Blue/Green deployments (and similar) where you want to send a certain portion of the traffic to the target Build ID.
    BuildIdAssignmentRule.RampCase
    getRampCase()
     
    int
    getSerializedSize()
     
    String
    getTargetBuildId()
    string target_build_id = 1;
    com.google.protobuf.ByteString
    getTargetBuildIdBytes()
    string target_build_id = 1;
    int
    hashCode()
     
    boolean
    hasPercentageRamp()
    This ramp is useful for gradual Blue/Green deployments (and similar) where you want to send a certain portion of the traffic to the target Build ID.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static BuildIdAssignmentRule.Builder
    newBuilder()
     
    static BuildIdAssignmentRule.Builder
    newBuilder(BuildIdAssignmentRule prototype)
     
    BuildIdAssignmentRule.Builder
    newBuilderForType()
     
    protected BuildIdAssignmentRule.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static BuildIdAssignmentRule
    parseDelimitedFrom(InputStream input)
     
    static BuildIdAssignmentRule
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BuildIdAssignmentRule
    parseFrom(byte[] data)
     
    static BuildIdAssignmentRule
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BuildIdAssignmentRule
    parseFrom(com.google.protobuf.ByteString data)
     
    static BuildIdAssignmentRule
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BuildIdAssignmentRule
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static BuildIdAssignmentRule
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BuildIdAssignmentRule
    parseFrom(InputStream input)
     
    static BuildIdAssignmentRule
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static BuildIdAssignmentRule
    parseFrom(ByteBuffer data)
     
    static BuildIdAssignmentRule
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<BuildIdAssignmentRule>
    parser()
     
    BuildIdAssignmentRule.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

  • Field Details

    • TARGET_BUILD_ID_FIELD_NUMBER

      public static final int TARGET_BUILD_ID_FIELD_NUMBER
      See Also:

    • PERCENTAGE_RAMP_FIELD_NUMBER

      public static final int PERCENTAGE_RAMP_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected 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

    • getRampCase

      public BuildIdAssignmentRule.RampCase getRampCase()
      Specified by:
      getRampCase in interface BuildIdAssignmentRuleOrBuilder

    • getTargetBuildId

      public String getTargetBuildId()
      string target_build_id = 1;
      Specified by:
      getTargetBuildId in interface BuildIdAssignmentRuleOrBuilder
      Returns:
      The targetBuildId.

    • getTargetBuildIdBytes

      public com.google.protobuf.ByteString getTargetBuildIdBytes()
      string target_build_id = 1;
      Specified by:
      getTargetBuildIdBytes in interface BuildIdAssignmentRuleOrBuilder
      Returns:
      The bytes for targetBuildId.

    • hasPercentageRamp

      public boolean hasPercentageRamp()
       This ramp is useful for gradual Blue/Green deployments (and similar)
 where you want to send a certain portion of the traffic to the target
 Build ID.
      .temporal.api.taskqueue.v1.RampByPercentage percentage_ramp = 3;
      Specified by:
      hasPercentageRamp in interface BuildIdAssignmentRuleOrBuilder
      Returns:
      Whether the percentageRamp field is set.

    • getPercentageRamp

      public RampByPercentage getPercentageRamp()
       This ramp is useful for gradual Blue/Green deployments (and similar)
 where you want to send a certain portion of the traffic to the target
 Build ID.
      .temporal.api.taskqueue.v1.RampByPercentage percentage_ramp = 3;
      Specified by:
      getPercentageRamp in interface BuildIdAssignmentRuleOrBuilder
      Returns:
      The percentageRamp.

    • getPercentageRampOrBuilder

      public RampByPercentageOrBuilder getPercentageRampOrBuilder()
       This ramp is useful for gradual Blue/Green deployments (and similar)
 where you want to send a certain portion of the traffic to the target
 Build ID.
      .temporal.api.taskqueue.v1.RampByPercentage percentage_ramp = 3;
      Specified by:
      getPercentageRampOrBuilder in interface BuildIdAssignmentRuleOrBuilder

    • 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      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(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 BuildIdAssignmentRule parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static BuildIdAssignmentRule parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static BuildIdAssignmentRule parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BuildIdAssignmentRule parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static BuildIdAssignmentRule parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static BuildIdAssignmentRule parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BuildIdAssignmentRule parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static BuildIdAssignmentRule parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static BuildIdAssignmentRule.Builder newBuilder()

    • newBuilder

      public static BuildIdAssignmentRule.Builder newBuilder(BuildIdAssignmentRule prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static BuildIdAssignmentRule getDefaultInstance()

    • parser

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

    • getParserForType

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