Package io.temporal.api.worker.v1

Class WorkerHeartbeat

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, WorkerHeartbeatOrBuilder, java.io.Serializable
    @Generated(value="protoc",
           comments="annotations:WorkerHeartbeat.java.pb.meta")
public final class WorkerHeartbeat
extends com.google.protobuf.GeneratedMessageV3
implements WorkerHeartbeatOrBuilder
     Worker info message, contains information about the worker and its current state.
 All information is provided by the worker itself.
 (-- api-linter: core::0140::prepositions=disabled
     aip.dev/not-precedent: Removing those words make names less clear. --)
    Protobuf type temporal.api.worker.v1.WorkerHeartbeat
    See Also:
    Serialized Form

    • Field Detail

      • WORKER_INSTANCE_KEY_FIELD_NUMBER

        public static final int WORKER_INSTANCE_KEY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WORKER_IDENTITY_FIELD_NUMBER

        public static final int WORKER_IDENTITY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TASK_QUEUE_FIELD_NUMBER

        public static final int TASK_QUEUE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DEPLOYMENT_VERSION_FIELD_NUMBER

        public static final int DEPLOYMENT_VERSION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SDK_VERSION_FIELD_NUMBER

        public static final int SDK_VERSION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • START_TIME_FIELD_NUMBER

        public static final int START_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HEARTBEAT_TIME_FIELD_NUMBER

        public static final int HEARTBEAT_TIME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ELAPSED_SINCE_LAST_HEARTBEAT_FIELD_NUMBER

        public static final int ELAPSED_SINCE_LAST_HEARTBEAT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WORKFLOW_TASK_SLOTS_INFO_FIELD_NUMBER

        public static final int WORKFLOW_TASK_SLOTS_INFO_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ACTIVITY_TASK_SLOTS_INFO_FIELD_NUMBER

        public static final int ACTIVITY_TASK_SLOTS_INFO_FIELD_NUMBER
        See Also:
        Constant Field Values

      • NEXUS_TASK_SLOTS_INFO_FIELD_NUMBER

        public static final int NEXUS_TASK_SLOTS_INFO_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LOCAL_ACTIVITY_SLOTS_INFO_FIELD_NUMBER

        public static final int LOCAL_ACTIVITY_SLOTS_INFO_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WORKFLOW_POLLER_INFO_FIELD_NUMBER

        public static final int WORKFLOW_POLLER_INFO_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WORKFLOW_STICKY_POLLER_INFO_FIELD_NUMBER

        public static final int WORKFLOW_STICKY_POLLER_INFO_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ACTIVITY_POLLER_INFO_FIELD_NUMBER

        public static final int ACTIVITY_POLLER_INFO_FIELD_NUMBER
        See Also:
        Constant Field Values

      • NEXUS_POLLER_INFO_FIELD_NUMBER

        public static final int NEXUS_POLLER_INFO_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TOTAL_STICKY_CACHE_HIT_FIELD_NUMBER

        public static final int TOTAL_STICKY_CACHE_HIT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TOTAL_STICKY_CACHE_MISS_FIELD_NUMBER

        public static final int TOTAL_STICKY_CACHE_MISS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CURRENT_STICKY_CACHE_SIZE_FIELD_NUMBER

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

      • getWorkerInstanceKey

        public java.lang.String getWorkerInstanceKey()
         Worker identifier, should be unique for the namespace.
 It is distinct from worker identity, which is not necessarily namespace-unique.
        string worker_instance_key = 1;
        Specified by:
        getWorkerInstanceKey in interface WorkerHeartbeatOrBuilder
        Returns:
        The workerInstanceKey.

      • getWorkerInstanceKeyBytes

        public com.google.protobuf.ByteString getWorkerInstanceKeyBytes()
         Worker identifier, should be unique for the namespace.
 It is distinct from worker identity, which is not necessarily namespace-unique.
        string worker_instance_key = 1;
        Specified by:
        getWorkerInstanceKeyBytes in interface WorkerHeartbeatOrBuilder
        Returns:
        The bytes for workerInstanceKey.

      • getWorkerIdentity

        public java.lang.String getWorkerIdentity()
         Worker identity, set by the client, may not be unique.
 Usually host_name+(user group name)+process_id, but can be overwritten by the user.
        string worker_identity = 2;
        Specified by:
        getWorkerIdentity in interface WorkerHeartbeatOrBuilder
        Returns:
        The workerIdentity.

      • getWorkerIdentityBytes

        public com.google.protobuf.ByteString getWorkerIdentityBytes()
         Worker identity, set by the client, may not be unique.
 Usually host_name+(user group name)+process_id, but can be overwritten by the user.
        string worker_identity = 2;
        Specified by:
        getWorkerIdentityBytes in interface WorkerHeartbeatOrBuilder
        Returns:
        The bytes for workerIdentity.

      • hasHostInfo

        public boolean hasHostInfo()
         Worker host information.
        .temporal.api.worker.v1.WorkerHostInfo host_info = 3;
        Specified by:
        hasHostInfo in interface WorkerHeartbeatOrBuilder
        Returns:
        Whether the hostInfo field is set.

      • getTaskQueue

        public java.lang.String getTaskQueue()
         Task queue this worker is polling for tasks.
        string task_queue = 4;
        Specified by:
        getTaskQueue in interface WorkerHeartbeatOrBuilder
        Returns:
        The taskQueue.

      • getTaskQueueBytes

        public com.google.protobuf.ByteString getTaskQueueBytes()
         Task queue this worker is polling for tasks.
        string task_queue = 4;
        Specified by:
        getTaskQueueBytes in interface WorkerHeartbeatOrBuilder
        Returns:
        The bytes for taskQueue.

      • hasDeploymentVersion

        public boolean hasDeploymentVersion()
        .temporal.api.deployment.v1.WorkerDeploymentVersion deployment_version = 5;
        Specified by:
        hasDeploymentVersion in interface WorkerHeartbeatOrBuilder
        Returns:
        Whether the deploymentVersion field is set.

      • getSdkNameBytes

        public com.google.protobuf.ByteString getSdkNameBytes()
        string sdk_name = 6;
        Specified by:
        getSdkNameBytes in interface WorkerHeartbeatOrBuilder
        Returns:
        The bytes for sdkName.

      • getSdkVersionBytes

        public com.google.protobuf.ByteString getSdkVersionBytes()
        string sdk_version = 7;
        Specified by:
        getSdkVersionBytes in interface WorkerHeartbeatOrBuilder
        Returns:
        The bytes for sdkVersion.

      • getStatusValue

        public int getStatusValue()
         Worker status. Defined by SDK.
        .temporal.api.enums.v1.WorkerStatus status = 8;
        Specified by:
        getStatusValue in interface WorkerHeartbeatOrBuilder
        Returns:
        The enum numeric value on the wire for status.

      • hasStartTime

        public boolean hasStartTime()
         Worker start time.
 It can be used to determine worker uptime. (current time - start time)
        .google.protobuf.Timestamp start_time = 9;
        Specified by:
        hasStartTime in interface WorkerHeartbeatOrBuilder
        Returns:
        Whether the startTime field is set.

      • getStartTime

        public com.google.protobuf.Timestamp getStartTime()
         Worker start time.
 It can be used to determine worker uptime. (current time - start time)
        .google.protobuf.Timestamp start_time = 9;
        Specified by:
        getStartTime in interface WorkerHeartbeatOrBuilder
        Returns:
        The startTime.

      • getStartTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()
         Worker start time.
 It can be used to determine worker uptime. (current time - start time)
        .google.protobuf.Timestamp start_time = 9;
        Specified by:
        getStartTimeOrBuilder in interface WorkerHeartbeatOrBuilder

      • hasHeartbeatTime

        public boolean hasHeartbeatTime()
         Timestamp of this heartbeat, coming from the worker. Worker should set it to "now".
 Note that this timestamp comes directly from the worker and is subject to workers' clock skew.
        .google.protobuf.Timestamp heartbeat_time = 10;
        Specified by:
        hasHeartbeatTime in interface WorkerHeartbeatOrBuilder
        Returns:
        Whether the heartbeatTime field is set.

      • getHeartbeatTime

        public com.google.protobuf.Timestamp getHeartbeatTime()
         Timestamp of this heartbeat, coming from the worker. Worker should set it to "now".
 Note that this timestamp comes directly from the worker and is subject to workers' clock skew.
        .google.protobuf.Timestamp heartbeat_time = 10;
        Specified by:
        getHeartbeatTime in interface WorkerHeartbeatOrBuilder
        Returns:
        The heartbeatTime.

      • getHeartbeatTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getHeartbeatTimeOrBuilder()
         Timestamp of this heartbeat, coming from the worker. Worker should set it to "now".
 Note that this timestamp comes directly from the worker and is subject to workers' clock skew.
        .google.protobuf.Timestamp heartbeat_time = 10;
        Specified by:
        getHeartbeatTimeOrBuilder in interface WorkerHeartbeatOrBuilder

      • hasElapsedSinceLastHeartbeat

        public boolean hasElapsedSinceLastHeartbeat()
         Elapsed time since the last heartbeat from the worker.
        .google.protobuf.Duration elapsed_since_last_heartbeat = 11;
        Specified by:
        hasElapsedSinceLastHeartbeat in interface WorkerHeartbeatOrBuilder
        Returns:
        Whether the elapsedSinceLastHeartbeat field is set.

      • getElapsedSinceLastHeartbeat

        public com.google.protobuf.Duration getElapsedSinceLastHeartbeat()
         Elapsed time since the last heartbeat from the worker.
        .google.protobuf.Duration elapsed_since_last_heartbeat = 11;
        Specified by:
        getElapsedSinceLastHeartbeat in interface WorkerHeartbeatOrBuilder
        Returns:
        The elapsedSinceLastHeartbeat.

      • getElapsedSinceLastHeartbeatOrBuilder

        public com.google.protobuf.DurationOrBuilder getElapsedSinceLastHeartbeatOrBuilder()
         Elapsed time since the last heartbeat from the worker.
        .google.protobuf.Duration elapsed_since_last_heartbeat = 11;
        Specified by:
        getElapsedSinceLastHeartbeatOrBuilder in interface WorkerHeartbeatOrBuilder

      • hasWorkflowTaskSlotsInfo

        public boolean hasWorkflowTaskSlotsInfo()
        .temporal.api.worker.v1.WorkerSlotsInfo workflow_task_slots_info = 12;
        Specified by:
        hasWorkflowTaskSlotsInfo in interface WorkerHeartbeatOrBuilder
        Returns:
        Whether the workflowTaskSlotsInfo field is set.

      • hasActivityTaskSlotsInfo

        public boolean hasActivityTaskSlotsInfo()
        .temporal.api.worker.v1.WorkerSlotsInfo activity_task_slots_info = 13;
        Specified by:
        hasActivityTaskSlotsInfo in interface WorkerHeartbeatOrBuilder
        Returns:
        Whether the activityTaskSlotsInfo field is set.

      • hasNexusTaskSlotsInfo

        public boolean hasNexusTaskSlotsInfo()
        .temporal.api.worker.v1.WorkerSlotsInfo nexus_task_slots_info = 14;
        Specified by:
        hasNexusTaskSlotsInfo in interface WorkerHeartbeatOrBuilder
        Returns:
        Whether the nexusTaskSlotsInfo field is set.

      • hasLocalActivitySlotsInfo

        public boolean hasLocalActivitySlotsInfo()
        .temporal.api.worker.v1.WorkerSlotsInfo local_activity_slots_info = 15;
        Specified by:
        hasLocalActivitySlotsInfo in interface WorkerHeartbeatOrBuilder
        Returns:
        Whether the localActivitySlotsInfo field is set.

      • hasWorkflowPollerInfo

        public boolean hasWorkflowPollerInfo()
        .temporal.api.worker.v1.WorkerPollerInfo workflow_poller_info = 16;
        Specified by:
        hasWorkflowPollerInfo in interface WorkerHeartbeatOrBuilder
        Returns:
        Whether the workflowPollerInfo field is set.

      • hasWorkflowStickyPollerInfo

        public boolean hasWorkflowStickyPollerInfo()
        .temporal.api.worker.v1.WorkerPollerInfo workflow_sticky_poller_info = 17;
        Specified by:
        hasWorkflowStickyPollerInfo in interface WorkerHeartbeatOrBuilder
        Returns:
        Whether the workflowStickyPollerInfo field is set.

      • hasActivityPollerInfo

        public boolean hasActivityPollerInfo()
        .temporal.api.worker.v1.WorkerPollerInfo activity_poller_info = 18;
        Specified by:
        hasActivityPollerInfo in interface WorkerHeartbeatOrBuilder
        Returns:
        Whether the activityPollerInfo field is set.

      • hasNexusPollerInfo

        public boolean hasNexusPollerInfo()
        .temporal.api.worker.v1.WorkerPollerInfo nexus_poller_info = 19;
        Specified by:
        hasNexusPollerInfo in interface WorkerHeartbeatOrBuilder
        Returns:
        Whether the nexusPollerInfo field is set.

      • getTotalStickyCacheHit

        public int getTotalStickyCacheHit()
         A Workflow Task found a cached Workflow Execution to run against.
        int32 total_sticky_cache_hit = 20;
        Specified by:
        getTotalStickyCacheHit in interface WorkerHeartbeatOrBuilder
        Returns:
        The totalStickyCacheHit.

      • getTotalStickyCacheMiss

        public int getTotalStickyCacheMiss()
         A Workflow Task did not find a cached Workflow execution to run against.
        int32 total_sticky_cache_miss = 21;
        Specified by:
        getTotalStickyCacheMiss in interface WorkerHeartbeatOrBuilder
        Returns:
        The totalStickyCacheMiss.

      • getCurrentStickyCacheSize

        public int getCurrentStickyCacheSize()
         Current cache size, expressed in number of Workflow Executions.
        int32 current_sticky_cache_size = 22;
        Specified by:
        getCurrentStickyCacheSize in interface WorkerHeartbeatOrBuilder
        Returns:
        The currentStickyCacheSize.

      • getPluginsCount

        public int getPluginsCount()
         Plugins currently in use by this SDK.
        repeated .temporal.api.worker.v1.PluginInfo plugins = 23;
        Specified by:
        getPluginsCount in interface WorkerHeartbeatOrBuilder

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • parser

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

      • getParserForType

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