Class WorkerDeploymentInfo

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.temporal.api.deployment.v1.WorkerDeploymentInfo
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, WorkerDeploymentInfoOrBuilder, Serializable
@Generated(value="protoc", comments="annotations:WorkerDeploymentInfo.java.pb.meta") public final class WorkerDeploymentInfo extends com.google.protobuf.GeneratedMessageV3 implements WorkerDeploymentInfoOrBuilder
 A Worker Deployment (Deployment, for short) represents all workers serving
 a shared set of Task Queues. Typically, a Deployment represents one service or
 application.
 A Deployment contains multiple Deployment Versions, each representing a different
 version of workers. (see documentation of WorkerDeploymentVersionInfo)
 Deployment records are created in Temporal server automatically when their
 first poller arrives to the server.
Protobuf type temporal.api.deployment.v1.WorkerDeploymentInfo
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • VERSION_SUMMARIES_FIELD_NUMBER

      public static final int VERSION_SUMMARIES_FIELD_NUMBER
      See Also:

    • CREATE_TIME_FIELD_NUMBER

      public static final int CREATE_TIME_FIELD_NUMBER
      See Also:

    • ROUTING_CONFIG_FIELD_NUMBER

      public static final int ROUTING_CONFIG_FIELD_NUMBER
      See Also:

    • LAST_MODIFIER_IDENTITY_FIELD_NUMBER

      public static final int LAST_MODIFIER_IDENTITY_FIELD_NUMBER
      See Also:

    • MANAGER_IDENTITY_FIELD_NUMBER

      public static final int MANAGER_IDENTITY_FIELD_NUMBER
      See Also:

    • ROUTING_CONFIG_UPDATE_STATE_FIELD_NUMBER

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

    • getName

      public String getName()
       Identifies a Worker Deployment. Must be unique within the namespace.
      string name = 1;
      Specified by:
      getName in interface WorkerDeploymentInfoOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Identifies a Worker Deployment. Must be unique within the namespace.
      string name = 1;
      Specified by:
      getNameBytes in interface WorkerDeploymentInfoOrBuilder
      Returns:
      The bytes for name.

    • getVersionSummariesList

      public List<WorkerDeploymentInfo.WorkerDeploymentVersionSummary> getVersionSummariesList()
       Deployment Versions that are currently tracked in this Deployment. A DeploymentVersion will be
 cleaned up automatically if all the following conditions meet:
 - It does not receive new executions (is not current or ramping)
 - It has no active pollers (see WorkerDeploymentVersionInfo.pollers_status)
 - It is drained (see WorkerDeploymentVersionInfo.drainage_status)
      repeated .temporal.api.deployment.v1.WorkerDeploymentInfo.WorkerDeploymentVersionSummary version_summaries = 2;
      Specified by:
      getVersionSummariesList in interface WorkerDeploymentInfoOrBuilder

    • getVersionSummariesOrBuilderList

      public List<? extends WorkerDeploymentInfo.WorkerDeploymentVersionSummaryOrBuilder> getVersionSummariesOrBuilderList()
       Deployment Versions that are currently tracked in this Deployment. A DeploymentVersion will be
 cleaned up automatically if all the following conditions meet:
 - It does not receive new executions (is not current or ramping)
 - It has no active pollers (see WorkerDeploymentVersionInfo.pollers_status)
 - It is drained (see WorkerDeploymentVersionInfo.drainage_status)
      repeated .temporal.api.deployment.v1.WorkerDeploymentInfo.WorkerDeploymentVersionSummary version_summaries = 2;
      Specified by:
      getVersionSummariesOrBuilderList in interface WorkerDeploymentInfoOrBuilder

    • getVersionSummariesCount

      public int getVersionSummariesCount()
       Deployment Versions that are currently tracked in this Deployment. A DeploymentVersion will be
 cleaned up automatically if all the following conditions meet:
 - It does not receive new executions (is not current or ramping)
 - It has no active pollers (see WorkerDeploymentVersionInfo.pollers_status)
 - It is drained (see WorkerDeploymentVersionInfo.drainage_status)
      repeated .temporal.api.deployment.v1.WorkerDeploymentInfo.WorkerDeploymentVersionSummary version_summaries = 2;
      Specified by:
      getVersionSummariesCount in interface WorkerDeploymentInfoOrBuilder

    • getVersionSummaries

      public WorkerDeploymentInfo.WorkerDeploymentVersionSummary getVersionSummaries(int index)
       Deployment Versions that are currently tracked in this Deployment. A DeploymentVersion will be
 cleaned up automatically if all the following conditions meet:
 - It does not receive new executions (is not current or ramping)
 - It has no active pollers (see WorkerDeploymentVersionInfo.pollers_status)
 - It is drained (see WorkerDeploymentVersionInfo.drainage_status)
      repeated .temporal.api.deployment.v1.WorkerDeploymentInfo.WorkerDeploymentVersionSummary version_summaries = 2;
      Specified by:
      getVersionSummaries in interface WorkerDeploymentInfoOrBuilder

    • getVersionSummariesOrBuilder

      public WorkerDeploymentInfo.WorkerDeploymentVersionSummaryOrBuilder getVersionSummariesOrBuilder(int index)
       Deployment Versions that are currently tracked in this Deployment. A DeploymentVersion will be
 cleaned up automatically if all the following conditions meet:
 - It does not receive new executions (is not current or ramping)
 - It has no active pollers (see WorkerDeploymentVersionInfo.pollers_status)
 - It is drained (see WorkerDeploymentVersionInfo.drainage_status)
      repeated .temporal.api.deployment.v1.WorkerDeploymentInfo.WorkerDeploymentVersionSummary version_summaries = 2;
      Specified by:
      getVersionSummariesOrBuilder in interface WorkerDeploymentInfoOrBuilder

    • hasCreateTime

      public boolean hasCreateTime()
      .google.protobuf.Timestamp create_time = 3;
      Specified by:
      hasCreateTime in interface WorkerDeploymentInfoOrBuilder
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      public com.google.protobuf.Timestamp getCreateTime()
      .google.protobuf.Timestamp create_time = 3;
      Specified by:
      getCreateTime in interface WorkerDeploymentInfoOrBuilder
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
      .google.protobuf.Timestamp create_time = 3;
      Specified by:
      getCreateTimeOrBuilder in interface WorkerDeploymentInfoOrBuilder

    • hasRoutingConfig

      public boolean hasRoutingConfig()
      .temporal.api.deployment.v1.RoutingConfig routing_config = 4;
      Specified by:
      hasRoutingConfig in interface WorkerDeploymentInfoOrBuilder
      Returns:
      Whether the routingConfig field is set.

    • getRoutingConfig

      public RoutingConfig getRoutingConfig()
      .temporal.api.deployment.v1.RoutingConfig routing_config = 4;
      Specified by:
      getRoutingConfig in interface WorkerDeploymentInfoOrBuilder
      Returns:
      The routingConfig.

    • getRoutingConfigOrBuilder

      public RoutingConfigOrBuilder getRoutingConfigOrBuilder()
      .temporal.api.deployment.v1.RoutingConfig routing_config = 4;
      Specified by:
      getRoutingConfigOrBuilder in interface WorkerDeploymentInfoOrBuilder

    • getLastModifierIdentity

      public String getLastModifierIdentity()
       Identity of the last client who modified the configuration of this Deployment. Set to the
 `identity` value sent by APIs such as `SetWorkerDeploymentCurrentVersion` and
 `SetWorkerDeploymentRampingVersion`.
      string last_modifier_identity = 5;
      Specified by:
      getLastModifierIdentity in interface WorkerDeploymentInfoOrBuilder
      Returns:
      The lastModifierIdentity.

    • getLastModifierIdentityBytes

      public com.google.protobuf.ByteString getLastModifierIdentityBytes()
       Identity of the last client who modified the configuration of this Deployment. Set to the
 `identity` value sent by APIs such as `SetWorkerDeploymentCurrentVersion` and
 `SetWorkerDeploymentRampingVersion`.
      string last_modifier_identity = 5;
      Specified by:
      getLastModifierIdentityBytes in interface WorkerDeploymentInfoOrBuilder
      Returns:
      The bytes for lastModifierIdentity.

    • getManagerIdentity

      public String getManagerIdentity()
       Identity of the client that has the exclusive right to make changes to this Worker Deployment.
 Empty by default.
 If this is set, clients whose identity does not match `manager_identity` will not be able to make changes
 to this Worker Deployment. They can either set their own identity as the manager or unset the field to proceed.
      string manager_identity = 6;
      Specified by:
      getManagerIdentity in interface WorkerDeploymentInfoOrBuilder
      Returns:
      The managerIdentity.

    • getManagerIdentityBytes

      public com.google.protobuf.ByteString getManagerIdentityBytes()
       Identity of the client that has the exclusive right to make changes to this Worker Deployment.
 Empty by default.
 If this is set, clients whose identity does not match `manager_identity` will not be able to make changes
 to this Worker Deployment. They can either set their own identity as the manager or unset the field to proceed.
      string manager_identity = 6;
      Specified by:
      getManagerIdentityBytes in interface WorkerDeploymentInfoOrBuilder
      Returns:
      The bytes for managerIdentity.

    • getRoutingConfigUpdateStateValue

      public int getRoutingConfigUpdateStateValue()
       Indicates whether the routing_config has been fully propagated to all
 relevant task queues and their partitions.
      .temporal.api.enums.v1.RoutingConfigUpdateState routing_config_update_state = 7;
      Specified by:
      getRoutingConfigUpdateStateValue in interface WorkerDeploymentInfoOrBuilder
      Returns:
      The enum numeric value on the wire for routingConfigUpdateState.

    • getRoutingConfigUpdateState

      public RoutingConfigUpdateState getRoutingConfigUpdateState()
       Indicates whether the routing_config has been fully propagated to all
 relevant task queues and their partitions.
      .temporal.api.enums.v1.RoutingConfigUpdateState routing_config_update_state = 7;
      Specified by:
      getRoutingConfigUpdateState in interface WorkerDeploymentInfoOrBuilder
      Returns:
      The routingConfigUpdateState.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static WorkerDeploymentInfo.Builder newBuilder()

    • newBuilder

      public static WorkerDeploymentInfo.Builder newBuilder(WorkerDeploymentInfo prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static WorkerDeploymentInfo getDefaultInstance()

    • parser

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

    • getParserForType

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