Package io.temporal.api.deployment.v1

Class RoutingConfig

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RoutingConfigOrBuilder, java.io.Serializable
    @Generated(value="protoc",
           comments="annotations:RoutingConfig.java.pb.meta")
public final class RoutingConfig
extends com.google.protobuf.GeneratedMessageV3
implements RoutingConfigOrBuilder
    Protobuf type temporal.api.deployment.v1.RoutingConfig
    See Also:
    Serialized Form

    • Field Detail

      • CURRENT_DEPLOYMENT_VERSION_FIELD_NUMBER

        public static final int CURRENT_DEPLOYMENT_VERSION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CURRENT_VERSION_FIELD_NUMBER

        public static final int CURRENT_VERSION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RAMPING_DEPLOYMENT_VERSION_FIELD_NUMBER

        public static final int RAMPING_DEPLOYMENT_VERSION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RAMPING_VERSION_FIELD_NUMBER

        public static final int RAMPING_VERSION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RAMPING_VERSION_PERCENTAGE_FIELD_NUMBER

        public static final int RAMPING_VERSION_PERCENTAGE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CURRENT_VERSION_CHANGED_TIME_FIELD_NUMBER

        public static final int CURRENT_VERSION_CHANGED_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RAMPING_VERSION_CHANGED_TIME_FIELD_NUMBER

        public static final int RAMPING_VERSION_CHANGED_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RAMPING_VERSION_PERCENTAGE_CHANGED_TIME_FIELD_NUMBER

        public static final int RAMPING_VERSION_PERCENTAGE_CHANGED_TIME_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

      • hasCurrentDeploymentVersion

        public boolean hasCurrentDeploymentVersion()
         Specifies which Deployment Version should receive new workflow executions and tasks of
 existing unversioned or AutoUpgrade workflows.
 Nil value means no Version in this Deployment (except Ramping Version, if present) receives traffic other than tasks of previously Pinned workflows. In absence of a Current Version, remaining traffic after any ramp (if set)  goes to unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.). 
 Note: Current Version is overridden by the Ramping Version for a portion of traffic when ramp percentage
 is non-zero (see `ramping_deployment_version` and `ramping_version_percentage`).
        .temporal.api.deployment.v1.WorkerDeploymentVersion current_deployment_version = 7;
        Specified by:
        hasCurrentDeploymentVersion in interface RoutingConfigOrBuilder
        Returns:
        Whether the currentDeploymentVersion field is set.

      • getCurrentDeploymentVersion

        public WorkerDeploymentVersion getCurrentDeploymentVersion()
         Specifies which Deployment Version should receive new workflow executions and tasks of
 existing unversioned or AutoUpgrade workflows.
 Nil value means no Version in this Deployment (except Ramping Version, if present) receives traffic other than tasks of previously Pinned workflows. In absence of a Current Version, remaining traffic after any ramp (if set)  goes to unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.). 
 Note: Current Version is overridden by the Ramping Version for a portion of traffic when ramp percentage
 is non-zero (see `ramping_deployment_version` and `ramping_version_percentage`).
        .temporal.api.deployment.v1.WorkerDeploymentVersion current_deployment_version = 7;
        Specified by:
        getCurrentDeploymentVersion in interface RoutingConfigOrBuilder
        Returns:
        The currentDeploymentVersion.

      • getCurrentDeploymentVersionOrBuilder

        public WorkerDeploymentVersionOrBuilder getCurrentDeploymentVersionOrBuilder()
         Specifies which Deployment Version should receive new workflow executions and tasks of
 existing unversioned or AutoUpgrade workflows.
 Nil value means no Version in this Deployment (except Ramping Version, if present) receives traffic other than tasks of previously Pinned workflows. In absence of a Current Version, remaining traffic after any ramp (if set)  goes to unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.). 
 Note: Current Version is overridden by the Ramping Version for a portion of traffic when ramp percentage
 is non-zero (see `ramping_deployment_version` and `ramping_version_percentage`).
        .temporal.api.deployment.v1.WorkerDeploymentVersion current_deployment_version = 7;
        Specified by:
        getCurrentDeploymentVersionOrBuilder in interface RoutingConfigOrBuilder

      • getCurrentVersion

        @Deprecated
public java.lang.String getCurrentVersion()
        Deprecated.
        temporal.api.deployment.v1.RoutingConfig.current_version is deprecated. See temporal/api/deployment/v1/message.proto;l=264
         Deprecated. Use `current_deployment_version`.
        string current_version = 1 [deprecated = true];
        Specified by:
        getCurrentVersion in interface RoutingConfigOrBuilder
        Returns:
        The currentVersion.

      • getCurrentVersionBytes

        @Deprecated
public com.google.protobuf.ByteString getCurrentVersionBytes()
        Deprecated.
        temporal.api.deployment.v1.RoutingConfig.current_version is deprecated. See temporal/api/deployment/v1/message.proto;l=264
         Deprecated. Use `current_deployment_version`.
        string current_version = 1 [deprecated = true];
        Specified by:
        getCurrentVersionBytes in interface RoutingConfigOrBuilder
        Returns:
        The bytes for currentVersion.

      • hasRampingDeploymentVersion

        public boolean hasRampingDeploymentVersion()
         When ramp percentage is non-zero, that portion of traffic is shifted from the Current Version to the Ramping Version.
 Must always be different from `current_deployment_version` unless both are nil.
 Nil value represents all the unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)
 Note that it is possible to ramp from one Version to another Version, or from unversioned
 workers to a particular Version, or from a particular Version to unversioned workers.
        .temporal.api.deployment.v1.WorkerDeploymentVersion ramping_deployment_version = 9;
        Specified by:
        hasRampingDeploymentVersion in interface RoutingConfigOrBuilder
        Returns:
        Whether the rampingDeploymentVersion field is set.

      • getRampingDeploymentVersion

        public WorkerDeploymentVersion getRampingDeploymentVersion()
         When ramp percentage is non-zero, that portion of traffic is shifted from the Current Version to the Ramping Version.
 Must always be different from `current_deployment_version` unless both are nil.
 Nil value represents all the unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)
 Note that it is possible to ramp from one Version to another Version, or from unversioned
 workers to a particular Version, or from a particular Version to unversioned workers.
        .temporal.api.deployment.v1.WorkerDeploymentVersion ramping_deployment_version = 9;
        Specified by:
        getRampingDeploymentVersion in interface RoutingConfigOrBuilder
        Returns:
        The rampingDeploymentVersion.

      • getRampingDeploymentVersionOrBuilder

        public WorkerDeploymentVersionOrBuilder getRampingDeploymentVersionOrBuilder()
         When ramp percentage is non-zero, that portion of traffic is shifted from the Current Version to the Ramping Version.
 Must always be different from `current_deployment_version` unless both are nil.
 Nil value represents all the unversioned workers (those with `UNVERSIONED` (or unspecified) `WorkerVersioningMode`.)
 Note that it is possible to ramp from one Version to another Version, or from unversioned
 workers to a particular Version, or from a particular Version to unversioned workers.
        .temporal.api.deployment.v1.WorkerDeploymentVersion ramping_deployment_version = 9;
        Specified by:
        getRampingDeploymentVersionOrBuilder in interface RoutingConfigOrBuilder

      • getRampingVersion

        @Deprecated
public java.lang.String getRampingVersion()
        Deprecated.
        temporal.api.deployment.v1.RoutingConfig.ramping_version is deprecated. See temporal/api/deployment/v1/message.proto;l=273
         Deprecated. Use `ramping_deployment_version`.
        string ramping_version = 2 [deprecated = true];
        Specified by:
        getRampingVersion in interface RoutingConfigOrBuilder
        Returns:
        The rampingVersion.

      • getRampingVersionBytes

        @Deprecated
public com.google.protobuf.ByteString getRampingVersionBytes()
        Deprecated.
        temporal.api.deployment.v1.RoutingConfig.ramping_version is deprecated. See temporal/api/deployment/v1/message.proto;l=273
         Deprecated. Use `ramping_deployment_version`.
        string ramping_version = 2 [deprecated = true];
        Specified by:
        getRampingVersionBytes in interface RoutingConfigOrBuilder
        Returns:
        The bytes for rampingVersion.

      • getRampingVersionPercentage

        public float getRampingVersionPercentage()
         Percentage of tasks that are routed to the Ramping Version instead of the Current Version.
 Valid range: [0, 100]. A 100% value means the Ramping Version is receiving full traffic but
 not yet "promoted" to be the Current Version, likely due to pending validations.
 A 0% value means the Ramping Version is receiving no traffic.
        float ramping_version_percentage = 3;
        Specified by:
        getRampingVersionPercentage in interface RoutingConfigOrBuilder
        Returns:
        The rampingVersionPercentage.

      • hasCurrentVersionChangedTime

        public boolean hasCurrentVersionChangedTime()
         Last time current version was changed.
        .google.protobuf.Timestamp current_version_changed_time = 4;
        Specified by:
        hasCurrentVersionChangedTime in interface RoutingConfigOrBuilder
        Returns:
        Whether the currentVersionChangedTime field is set.

      • getCurrentVersionChangedTime

        public com.google.protobuf.Timestamp getCurrentVersionChangedTime()
         Last time current version was changed.
        .google.protobuf.Timestamp current_version_changed_time = 4;
        Specified by:
        getCurrentVersionChangedTime in interface RoutingConfigOrBuilder
        Returns:
        The currentVersionChangedTime.

      • getCurrentVersionChangedTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCurrentVersionChangedTimeOrBuilder()
         Last time current version was changed.
        .google.protobuf.Timestamp current_version_changed_time = 4;
        Specified by:
        getCurrentVersionChangedTimeOrBuilder in interface RoutingConfigOrBuilder

      • hasRampingVersionChangedTime

        public boolean hasRampingVersionChangedTime()
         Last time ramping version was changed. Not updated if only the ramp percentage changes.
        .google.protobuf.Timestamp ramping_version_changed_time = 5;
        Specified by:
        hasRampingVersionChangedTime in interface RoutingConfigOrBuilder
        Returns:
        Whether the rampingVersionChangedTime field is set.

      • getRampingVersionChangedTime

        public com.google.protobuf.Timestamp getRampingVersionChangedTime()
         Last time ramping version was changed. Not updated if only the ramp percentage changes.
        .google.protobuf.Timestamp ramping_version_changed_time = 5;
        Specified by:
        getRampingVersionChangedTime in interface RoutingConfigOrBuilder
        Returns:
        The rampingVersionChangedTime.

      • getRampingVersionChangedTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getRampingVersionChangedTimeOrBuilder()
         Last time ramping version was changed. Not updated if only the ramp percentage changes.
        .google.protobuf.Timestamp ramping_version_changed_time = 5;
        Specified by:
        getRampingVersionChangedTimeOrBuilder in interface RoutingConfigOrBuilder

      • hasRampingVersionPercentageChangedTime

        public boolean hasRampingVersionPercentageChangedTime()
         Last time ramping version percentage was changed.
 If ramping version is changed, this is also updated, even if the percentage stays the same.
        .google.protobuf.Timestamp ramping_version_percentage_changed_time = 6;
        Specified by:
        hasRampingVersionPercentageChangedTime in interface RoutingConfigOrBuilder
        Returns:
        Whether the rampingVersionPercentageChangedTime field is set.

      • getRampingVersionPercentageChangedTime

        public com.google.protobuf.Timestamp getRampingVersionPercentageChangedTime()
         Last time ramping version percentage was changed.
 If ramping version is changed, this is also updated, even if the percentage stays the same.
        .google.protobuf.Timestamp ramping_version_percentage_changed_time = 6;
        Specified by:
        getRampingVersionPercentageChangedTime in interface RoutingConfigOrBuilder
        Returns:
        The rampingVersionPercentageChangedTime.

      • getRampingVersionPercentageChangedTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getRampingVersionPercentageChangedTimeOrBuilder()
         Last time ramping version percentage was changed.
 If ramping version is changed, this is also updated, even if the percentage stays the same.
        .google.protobuf.Timestamp ramping_version_percentage_changed_time = 6;
        Specified by:
        getRampingVersionPercentageChangedTimeOrBuilder in interface RoutingConfigOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static RoutingConfig getDefaultInstance()

      • parser

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

      • getParserForType

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