Package io.temporal.api.worker.v1

Interface WorkerHeartbeatOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    WorkerHeartbeat, WorkerHeartbeat.Builder
    @Generated(value="protoc",
           comments="annotations:WorkerHeartbeatOrBuilder.java.pb.meta")
public interface WorkerHeartbeatOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getWorkerInstanceKey

        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;
        Returns:
        The workerInstanceKey.

      • getWorkerInstanceKeyBytes

        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;
        Returns:
        The bytes for workerInstanceKey.

      • getWorkerIdentity

        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;
        Returns:
        The workerIdentity.

      • getWorkerIdentityBytes

        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;
        Returns:
        The bytes for workerIdentity.

      • hasHostInfo

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

      • getHostInfo

        WorkerHostInfo getHostInfo()
         Worker host information.
        .temporal.api.worker.v1.WorkerHostInfo host_info = 3;
        Returns:
        The hostInfo.

      • getHostInfoOrBuilder

        WorkerHostInfoOrBuilder getHostInfoOrBuilder()
         Worker host information.
        .temporal.api.worker.v1.WorkerHostInfo host_info = 3;

      • getTaskQueue

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

      • getTaskQueueBytes

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

      • hasDeploymentVersion

        boolean hasDeploymentVersion()
        .temporal.api.deployment.v1.WorkerDeploymentVersion deployment_version = 5;
        Returns:
        Whether the deploymentVersion field is set.

      • getDeploymentVersion

        WorkerDeploymentVersion getDeploymentVersion()
        .temporal.api.deployment.v1.WorkerDeploymentVersion deployment_version = 5;
        Returns:
        The deploymentVersion.

      • getDeploymentVersionOrBuilder

        WorkerDeploymentVersionOrBuilder getDeploymentVersionOrBuilder()
        .temporal.api.deployment.v1.WorkerDeploymentVersion deployment_version = 5;

      • getSdkName

        java.lang.String getSdkName()
        string sdk_name = 6;
        Returns:
        The sdkName.

      • getSdkNameBytes

        com.google.protobuf.ByteString getSdkNameBytes()
        string sdk_name = 6;
        Returns:
        The bytes for sdkName.

      • getSdkVersion

        java.lang.String getSdkVersion()
        string sdk_version = 7;
        Returns:
        The sdkVersion.

      • getSdkVersionBytes

        com.google.protobuf.ByteString getSdkVersionBytes()
        string sdk_version = 7;
        Returns:
        The bytes for sdkVersion.

      • getStatusValue

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

      • getStatus

        WorkerStatus getStatus()
         Worker status. Defined by SDK.
        .temporal.api.enums.v1.WorkerStatus status = 8;
        Returns:
        The status.

      • hasStartTime

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

      • getStartTime

        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;
        Returns:
        The startTime.

      • getStartTimeOrBuilder

        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;

      • hasHeartbeatTime

        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;
        Returns:
        Whether the heartbeatTime field is set.

      • getHeartbeatTime

        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;
        Returns:
        The heartbeatTime.

      • getHeartbeatTimeOrBuilder

        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;

      • hasElapsedSinceLastHeartbeat

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

      • getElapsedSinceLastHeartbeat

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

      • getElapsedSinceLastHeartbeatOrBuilder

        com.google.protobuf.DurationOrBuilder getElapsedSinceLastHeartbeatOrBuilder()
         Elapsed time since the last heartbeat from the worker.
        .google.protobuf.Duration elapsed_since_last_heartbeat = 11;

      • hasWorkflowTaskSlotsInfo

        boolean hasWorkflowTaskSlotsInfo()
        .temporal.api.worker.v1.WorkerSlotsInfo workflow_task_slots_info = 12;
        Returns:
        Whether the workflowTaskSlotsInfo field is set.

      • getWorkflowTaskSlotsInfo

        WorkerSlotsInfo getWorkflowTaskSlotsInfo()
        .temporal.api.worker.v1.WorkerSlotsInfo workflow_task_slots_info = 12;
        Returns:
        The workflowTaskSlotsInfo.

      • getWorkflowTaskSlotsInfoOrBuilder

        WorkerSlotsInfoOrBuilder getWorkflowTaskSlotsInfoOrBuilder()
        .temporal.api.worker.v1.WorkerSlotsInfo workflow_task_slots_info = 12;

      • hasActivityTaskSlotsInfo

        boolean hasActivityTaskSlotsInfo()
        .temporal.api.worker.v1.WorkerSlotsInfo activity_task_slots_info = 13;
        Returns:
        Whether the activityTaskSlotsInfo field is set.

      • getActivityTaskSlotsInfo

        WorkerSlotsInfo getActivityTaskSlotsInfo()
        .temporal.api.worker.v1.WorkerSlotsInfo activity_task_slots_info = 13;
        Returns:
        The activityTaskSlotsInfo.

      • getActivityTaskSlotsInfoOrBuilder

        WorkerSlotsInfoOrBuilder getActivityTaskSlotsInfoOrBuilder()
        .temporal.api.worker.v1.WorkerSlotsInfo activity_task_slots_info = 13;

      • hasNexusTaskSlotsInfo

        boolean hasNexusTaskSlotsInfo()
        .temporal.api.worker.v1.WorkerSlotsInfo nexus_task_slots_info = 14;
        Returns:
        Whether the nexusTaskSlotsInfo field is set.

      • getNexusTaskSlotsInfo

        WorkerSlotsInfo getNexusTaskSlotsInfo()
        .temporal.api.worker.v1.WorkerSlotsInfo nexus_task_slots_info = 14;
        Returns:
        The nexusTaskSlotsInfo.

      • getNexusTaskSlotsInfoOrBuilder

        WorkerSlotsInfoOrBuilder getNexusTaskSlotsInfoOrBuilder()
        .temporal.api.worker.v1.WorkerSlotsInfo nexus_task_slots_info = 14;

      • hasLocalActivitySlotsInfo

        boolean hasLocalActivitySlotsInfo()
        .temporal.api.worker.v1.WorkerSlotsInfo local_activity_slots_info = 15;
        Returns:
        Whether the localActivitySlotsInfo field is set.

      • getLocalActivitySlotsInfo

        WorkerSlotsInfo getLocalActivitySlotsInfo()
        .temporal.api.worker.v1.WorkerSlotsInfo local_activity_slots_info = 15;
        Returns:
        The localActivitySlotsInfo.

      • getLocalActivitySlotsInfoOrBuilder

        WorkerSlotsInfoOrBuilder getLocalActivitySlotsInfoOrBuilder()
        .temporal.api.worker.v1.WorkerSlotsInfo local_activity_slots_info = 15;

      • hasWorkflowPollerInfo

        boolean hasWorkflowPollerInfo()
        .temporal.api.worker.v1.WorkerPollerInfo workflow_poller_info = 16;
        Returns:
        Whether the workflowPollerInfo field is set.

      • getWorkflowPollerInfo

        WorkerPollerInfo getWorkflowPollerInfo()
        .temporal.api.worker.v1.WorkerPollerInfo workflow_poller_info = 16;
        Returns:
        The workflowPollerInfo.

      • getWorkflowPollerInfoOrBuilder

        WorkerPollerInfoOrBuilder getWorkflowPollerInfoOrBuilder()
        .temporal.api.worker.v1.WorkerPollerInfo workflow_poller_info = 16;

      • hasWorkflowStickyPollerInfo

        boolean hasWorkflowStickyPollerInfo()
        .temporal.api.worker.v1.WorkerPollerInfo workflow_sticky_poller_info = 17;
        Returns:
        Whether the workflowStickyPollerInfo field is set.

      • getWorkflowStickyPollerInfo

        WorkerPollerInfo getWorkflowStickyPollerInfo()
        .temporal.api.worker.v1.WorkerPollerInfo workflow_sticky_poller_info = 17;
        Returns:
        The workflowStickyPollerInfo.

      • getWorkflowStickyPollerInfoOrBuilder

        WorkerPollerInfoOrBuilder getWorkflowStickyPollerInfoOrBuilder()
        .temporal.api.worker.v1.WorkerPollerInfo workflow_sticky_poller_info = 17;

      • hasActivityPollerInfo

        boolean hasActivityPollerInfo()
        .temporal.api.worker.v1.WorkerPollerInfo activity_poller_info = 18;
        Returns:
        Whether the activityPollerInfo field is set.

      • getActivityPollerInfo

        WorkerPollerInfo getActivityPollerInfo()
        .temporal.api.worker.v1.WorkerPollerInfo activity_poller_info = 18;
        Returns:
        The activityPollerInfo.

      • getActivityPollerInfoOrBuilder

        WorkerPollerInfoOrBuilder getActivityPollerInfoOrBuilder()
        .temporal.api.worker.v1.WorkerPollerInfo activity_poller_info = 18;

      • hasNexusPollerInfo

        boolean hasNexusPollerInfo()
        .temporal.api.worker.v1.WorkerPollerInfo nexus_poller_info = 19;
        Returns:
        Whether the nexusPollerInfo field is set.

      • getNexusPollerInfo

        WorkerPollerInfo getNexusPollerInfo()
        .temporal.api.worker.v1.WorkerPollerInfo nexus_poller_info = 19;
        Returns:
        The nexusPollerInfo.

      • getNexusPollerInfoOrBuilder

        WorkerPollerInfoOrBuilder getNexusPollerInfoOrBuilder()
        .temporal.api.worker.v1.WorkerPollerInfo nexus_poller_info = 19;

      • getTotalStickyCacheHit

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

      • getTotalStickyCacheMiss

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

      • getCurrentStickyCacheSize

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

      • getPluginsList

        java.util.List<PluginInfo> getPluginsList()
         Plugins currently in use by this SDK.
        repeated .temporal.api.worker.v1.PluginInfo plugins = 23;

      • getPlugins

        PluginInfo getPlugins​(int index)
         Plugins currently in use by this SDK.
        repeated .temporal.api.worker.v1.PluginInfo plugins = 23;

      • getPluginsCount

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

      • getPluginsOrBuilderList

        java.util.List<? extends PluginInfoOrBuilder> getPluginsOrBuilderList()
         Plugins currently in use by this SDK.
        repeated .temporal.api.worker.v1.PluginInfo plugins = 23;

      • getPluginsOrBuilder

        PluginInfoOrBuilder getPluginsOrBuilder​(int index)
         Plugins currently in use by this SDK.
        repeated .temporal.api.worker.v1.PluginInfo plugins = 23;