Package io.temporal.api.workflowservice.v1

Interface RespondWorkflowTaskCompletedRequestOrBuilder

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

    • Method Detail

      • getTaskToken

        com.google.protobuf.ByteString getTaskToken()
         The task token as received in `PollWorkflowTaskQueueResponse`
        bytes task_token = 1;
        Returns:
        The taskToken.

      • getCommandsList

        java.util.List<Command> getCommandsList()
         A list of commands generated when driving the workflow code in response to the new task
        repeated .temporal.api.command.v1.Command commands = 2;

      • getCommands

        Command getCommands​(int index)
         A list of commands generated when driving the workflow code in response to the new task
        repeated .temporal.api.command.v1.Command commands = 2;

      • getCommandsCount

        int getCommandsCount()
         A list of commands generated when driving the workflow code in response to the new task
        repeated .temporal.api.command.v1.Command commands = 2;

      • getCommandsOrBuilderList

        java.util.List<? extends CommandOrBuilder> getCommandsOrBuilderList()
         A list of commands generated when driving the workflow code in response to the new task
        repeated .temporal.api.command.v1.Command commands = 2;

      • getCommandsOrBuilder

        CommandOrBuilder getCommandsOrBuilder​(int index)
         A list of commands generated when driving the workflow code in response to the new task
        repeated .temporal.api.command.v1.Command commands = 2;

      • getIdentity

        java.lang.String getIdentity()
         The identity of the worker/client
        string identity = 3;
        Returns:
        The identity.

      • getIdentityBytes

        com.google.protobuf.ByteString getIdentityBytes()
         The identity of the worker/client
        string identity = 3;
        Returns:
        The bytes for identity.

      • hasStickyAttributes

        boolean hasStickyAttributes()
         May be set by workers to indicate that the worker desires future tasks to be provided with
 incremental history on a sticky queue.
        .temporal.api.taskqueue.v1.StickyExecutionAttributes sticky_attributes = 4;
        Returns:
        Whether the stickyAttributes field is set.

      • getStickyAttributes

        StickyExecutionAttributes getStickyAttributes()
         May be set by workers to indicate that the worker desires future tasks to be provided with
 incremental history on a sticky queue.
        .temporal.api.taskqueue.v1.StickyExecutionAttributes sticky_attributes = 4;
        Returns:
        The stickyAttributes.

      • getStickyAttributesOrBuilder

        StickyExecutionAttributesOrBuilder getStickyAttributesOrBuilder()
         May be set by workers to indicate that the worker desires future tasks to be provided with
 incremental history on a sticky queue.
        .temporal.api.taskqueue.v1.StickyExecutionAttributes sticky_attributes = 4;

      • getReturnNewWorkflowTask

        boolean getReturnNewWorkflowTask()
         If set, the worker wishes to immediately receive the next workflow task as a response to
 this completion. This can save on polling round-trips.
        bool return_new_workflow_task = 5;
        Returns:
        The returnNewWorkflowTask.

      • getForceCreateNewWorkflowTask

        boolean getForceCreateNewWorkflowTask()
         Can be used to *force* creation of a new workflow task, even if no commands have resolved or
 one would not otherwise have been generated. This is used when the worker knows it is doing
 something useful, but cannot complete it within the workflow task timeout. Local activities
 which run for longer than the task timeout being the prime example.
        bool force_create_new_workflow_task = 6;
        Returns:
        The forceCreateNewWorkflowTask.

      • getBinaryChecksum

        java.lang.String getBinaryChecksum()
         DEPRECATED since 1.21 - use `worker_version_stamp` instead.
 Worker process' unique binary id
        string binary_checksum = 7;
        Returns:
        The binaryChecksum.

      • getBinaryChecksumBytes

        com.google.protobuf.ByteString getBinaryChecksumBytes()
         DEPRECATED since 1.21 - use `worker_version_stamp` instead.
 Worker process' unique binary id
        string binary_checksum = 7;
        Returns:
        The bytes for binaryChecksum.

      • getQueryResultsCount

        int getQueryResultsCount()
         Responses to the `queries` field in the task being responded to
        map<string, .temporal.api.query.v1.WorkflowQueryResult> query_results = 8;

      • containsQueryResults

        boolean containsQueryResults​(java.lang.String key)
         Responses to the `queries` field in the task being responded to
        map<string, .temporal.api.query.v1.WorkflowQueryResult> query_results = 8;

      • getQueryResultsMap

        java.util.Map<java.lang.String,​WorkflowQueryResult> getQueryResultsMap()
         Responses to the `queries` field in the task being responded to
        map<string, .temporal.api.query.v1.WorkflowQueryResult> query_results = 8;

      • getQueryResultsOrDefault

        WorkflowQueryResult getQueryResultsOrDefault​(java.lang.String key,
                                             WorkflowQueryResult defaultValue)
         Responses to the `queries` field in the task being responded to
        map<string, .temporal.api.query.v1.WorkflowQueryResult> query_results = 8;

      • getQueryResultsOrThrow

        WorkflowQueryResult getQueryResultsOrThrow​(java.lang.String key)
         Responses to the `queries` field in the task being responded to
        map<string, .temporal.api.query.v1.WorkflowQueryResult> query_results = 8;

      • getNamespace

        java.lang.String getNamespace()
        string namespace = 9;
        Returns:
        The namespace.

      • getNamespaceBytes

        com.google.protobuf.ByteString getNamespaceBytes()
        string namespace = 9;
        Returns:
        The bytes for namespace.

      • hasWorkerVersionStamp

        @Deprecated
boolean hasWorkerVersionStamp()
        Deprecated.
        temporal.api.workflowservice.v1.RespondWorkflowTaskCompletedRequest.worker_version_stamp is deprecated. See temporal/api/workflowservice/v1/request_response.proto;l=363
         Version info of the worker who processed this task. This message's `build_id` field should
 always be set by SDKs. Workers opting into versioning will also set the `use_versioning`
 field to true. See message docstrings for more.
 Deprecated. Use `deployment` and `versioning_behavior` instead.
        .temporal.api.common.v1.WorkerVersionStamp worker_version_stamp = 10 [deprecated = true];
        Returns:
        Whether the workerVersionStamp field is set.

      • getWorkerVersionStamp

        @Deprecated
WorkerVersionStamp getWorkerVersionStamp()
        Deprecated.
        temporal.api.workflowservice.v1.RespondWorkflowTaskCompletedRequest.worker_version_stamp is deprecated. See temporal/api/workflowservice/v1/request_response.proto;l=363
         Version info of the worker who processed this task. This message's `build_id` field should
 always be set by SDKs. Workers opting into versioning will also set the `use_versioning`
 field to true. See message docstrings for more.
 Deprecated. Use `deployment` and `versioning_behavior` instead.
        .temporal.api.common.v1.WorkerVersionStamp worker_version_stamp = 10 [deprecated = true];
        Returns:
        The workerVersionStamp.

      • getWorkerVersionStampOrBuilder

        @Deprecated
WorkerVersionStampOrBuilder getWorkerVersionStampOrBuilder()
        Deprecated.
         Version info of the worker who processed this task. This message's `build_id` field should
 always be set by SDKs. Workers opting into versioning will also set the `use_versioning`
 field to true. See message docstrings for more.
 Deprecated. Use `deployment` and `versioning_behavior` instead.
        .temporal.api.common.v1.WorkerVersionStamp worker_version_stamp = 10 [deprecated = true];

      • getMessagesList

        java.util.List<Message> getMessagesList()
         Protocol messages piggybacking on a WFT as a transport
        repeated .temporal.api.protocol.v1.Message messages = 11;

      • getMessages

        Message getMessages​(int index)
         Protocol messages piggybacking on a WFT as a transport
        repeated .temporal.api.protocol.v1.Message messages = 11;

      • getMessagesCount

        int getMessagesCount()
         Protocol messages piggybacking on a WFT as a transport
        repeated .temporal.api.protocol.v1.Message messages = 11;

      • getMessagesOrBuilderList

        java.util.List<? extends MessageOrBuilder> getMessagesOrBuilderList()
         Protocol messages piggybacking on a WFT as a transport
        repeated .temporal.api.protocol.v1.Message messages = 11;

      • getMessagesOrBuilder

        MessageOrBuilder getMessagesOrBuilder​(int index)
         Protocol messages piggybacking on a WFT as a transport
        repeated .temporal.api.protocol.v1.Message messages = 11;

      • hasSdkMetadata

        boolean hasSdkMetadata()
         Data the SDK wishes to record for itself, but server need not interpret, and does not
 directly impact workflow state.
        .temporal.api.sdk.v1.WorkflowTaskCompletedMetadata sdk_metadata = 12;
        Returns:
        Whether the sdkMetadata field is set.

      • getSdkMetadata

        WorkflowTaskCompletedMetadata getSdkMetadata()
         Data the SDK wishes to record for itself, but server need not interpret, and does not
 directly impact workflow state.
        .temporal.api.sdk.v1.WorkflowTaskCompletedMetadata sdk_metadata = 12;
        Returns:
        The sdkMetadata.

      • getSdkMetadataOrBuilder

        WorkflowTaskCompletedMetadataOrBuilder getSdkMetadataOrBuilder()
         Data the SDK wishes to record for itself, but server need not interpret, and does not
 directly impact workflow state.
        .temporal.api.sdk.v1.WorkflowTaskCompletedMetadata sdk_metadata = 12;

      • hasMeteringMetadata

        boolean hasMeteringMetadata()
         Local usage data collected for metering
        .temporal.api.common.v1.MeteringMetadata metering_metadata = 13;
        Returns:
        Whether the meteringMetadata field is set.

      • getMeteringMetadata

        MeteringMetadata getMeteringMetadata()
         Local usage data collected for metering
        .temporal.api.common.v1.MeteringMetadata metering_metadata = 13;
        Returns:
        The meteringMetadata.

      • getMeteringMetadataOrBuilder

        MeteringMetadataOrBuilder getMeteringMetadataOrBuilder()
         Local usage data collected for metering
        .temporal.api.common.v1.MeteringMetadata metering_metadata = 13;

      • hasCapabilities

        boolean hasCapabilities()
         All capabilities the SDK supports.
        .temporal.api.workflowservice.v1.RespondWorkflowTaskCompletedRequest.Capabilities capabilities = 14;
        Returns:
        Whether the capabilities field is set.

      • getCapabilities

        RespondWorkflowTaskCompletedRequest.Capabilities getCapabilities()
         All capabilities the SDK supports.
        .temporal.api.workflowservice.v1.RespondWorkflowTaskCompletedRequest.Capabilities capabilities = 14;
        Returns:
        The capabilities.

      • hasDeployment

        @Deprecated
boolean hasDeployment()
        Deprecated.
        temporal.api.workflowservice.v1.RespondWorkflowTaskCompletedRequest.deployment is deprecated. See temporal/api/workflowservice/v1/request_response.proto;l=376
         Deployment info of the worker that completed this task. Must be present if user has set
 `WorkerDeploymentOptions` regardless of versioning being enabled or not.
 Deprecated. Replaced with `deployment_options`.
        .temporal.api.deployment.v1.Deployment deployment = 15 [deprecated = true];
        Returns:
        Whether the deployment field is set.

      • getDeployment

        @Deprecated
Deployment getDeployment()
        Deprecated.
        temporal.api.workflowservice.v1.RespondWorkflowTaskCompletedRequest.deployment is deprecated. See temporal/api/workflowservice/v1/request_response.proto;l=376
         Deployment info of the worker that completed this task. Must be present if user has set
 `WorkerDeploymentOptions` regardless of versioning being enabled or not.
 Deprecated. Replaced with `deployment_options`.
        .temporal.api.deployment.v1.Deployment deployment = 15 [deprecated = true];
        Returns:
        The deployment.

      • getDeploymentOrBuilder

        @Deprecated
DeploymentOrBuilder getDeploymentOrBuilder()
        Deprecated.
         Deployment info of the worker that completed this task. Must be present if user has set
 `WorkerDeploymentOptions` regardless of versioning being enabled or not.
 Deprecated. Replaced with `deployment_options`.
        .temporal.api.deployment.v1.Deployment deployment = 15 [deprecated = true];

      • getVersioningBehaviorValue

        int getVersioningBehaviorValue()
         Versioning behavior of this workflow execution as set on the worker that completed this task.
 UNSPECIFIED means versioning is not enabled in the worker.
        .temporal.api.enums.v1.VersioningBehavior versioning_behavior = 16;
        Returns:
        The enum numeric value on the wire for versioningBehavior.

      • getVersioningBehavior

        VersioningBehavior getVersioningBehavior()
         Versioning behavior of this workflow execution as set on the worker that completed this task.
 UNSPECIFIED means versioning is not enabled in the worker.
        .temporal.api.enums.v1.VersioningBehavior versioning_behavior = 16;
        Returns:
        The versioningBehavior.

      • hasDeploymentOptions

        boolean hasDeploymentOptions()
         Worker deployment options that user has set in the worker.
        .temporal.api.deployment.v1.WorkerDeploymentOptions deployment_options = 17;
        Returns:
        Whether the deploymentOptions field is set.

      • getDeploymentOptions

        WorkerDeploymentOptions getDeploymentOptions()
         Worker deployment options that user has set in the worker.
        .temporal.api.deployment.v1.WorkerDeploymentOptions deployment_options = 17;
        Returns:
        The deploymentOptions.

      • getDeploymentOptionsOrBuilder

        WorkerDeploymentOptionsOrBuilder getDeploymentOptionsOrBuilder()
         Worker deployment options that user has set in the worker.
        .temporal.api.deployment.v1.WorkerDeploymentOptions deployment_options = 17;