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 Details

    • getTaskToken

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

    • getCommandsList

      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

      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

      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

      @Deprecated String getBinaryChecksum()
      Deprecated.
      temporal.api.workflowservice.v1.RespondWorkflowTaskCompletedRequest.binary_checksum is deprecated. See temporal/api/workflowservice/v1/request_response.proto;l=406
       Deprecated. Use `deployment_options` instead.
 Worker process' unique binary id
      string binary_checksum = 7 [deprecated = true];
      Returns:
      The binaryChecksum.

    • getBinaryChecksumBytes

      @Deprecated com.google.protobuf.ByteString getBinaryChecksumBytes()
      Deprecated.
      temporal.api.workflowservice.v1.RespondWorkflowTaskCompletedRequest.binary_checksum is deprecated. See temporal/api/workflowservice/v1/request_response.proto;l=406
       Deprecated. Use `deployment_options` instead.
 Worker process' unique binary id
      string binary_checksum = 7 [deprecated = true];
      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(String key)
       Responses to the `queries` field in the task being responded to
      map<string, .temporal.api.query.v1.WorkflowQueryResult> query_results = 8;

    • getQueryResults

      @Deprecated Map<String,WorkflowQueryResult> getQueryResults()
      Deprecated.
      Use getQueryResultsMap() instead.

    • getQueryResultsMap

      Map<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(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(String key)
       Responses to the `queries` field in the task being responded to
      map<string, .temporal.api.query.v1.WorkflowQueryResult> query_results = 8;

    • getNamespace

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

    • getNamespaceBytes

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

    • getResourceId

      String getResourceId()
       Resource ID for routing. Contains the workflow ID from the original task.
      string resource_id = 18;
      Returns:
      The resourceId.

    • getResourceIdBytes

      com.google.protobuf.ByteString getResourceIdBytes()
       Resource ID for routing. Contains the workflow ID from the original task.
      string resource_id = 18;
      Returns:
      The bytes for resourceId.

    • hasWorkerVersionStamp

      @Deprecated boolean hasWorkerVersionStamp()
      Deprecated.
      temporal.api.workflowservice.v1.RespondWorkflowTaskCompletedRequest.worker_version_stamp is deprecated. See temporal/api/workflowservice/v1/request_response.proto;l=416
       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_options` 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=416
       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_options` 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_options` and `versioning_behavior` instead.
      .temporal.api.common.v1.WorkerVersionStamp worker_version_stamp = 10 [deprecated = true];

    • getMessagesList

      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

      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.

    • getCapabilitiesOrBuilder

      RespondWorkflowTaskCompletedRequest.CapabilitiesOrBuilder getCapabilitiesOrBuilder()
       All capabilities the SDK supports.
      .temporal.api.workflowservice.v1.RespondWorkflowTaskCompletedRequest.Capabilities capabilities = 14;

    • hasDeployment

      @Deprecated boolean hasDeployment()
      Deprecated.
      temporal.api.workflowservice.v1.RespondWorkflowTaskCompletedRequest.deployment is deprecated. See temporal/api/workflowservice/v1/request_response.proto;l=429
       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=429
       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;

    • getWorkerInstanceKey

      String getWorkerInstanceKey()
       A unique key for this worker instance, used for tracking worker lifecycle.
 This is guaranteed to be unique, whereas identity is not guaranteed to be unique.
      string worker_instance_key = 19;
      Returns:
      The workerInstanceKey.

    • getWorkerInstanceKeyBytes

      com.google.protobuf.ByteString getWorkerInstanceKeyBytes()
       A unique key for this worker instance, used for tracking worker lifecycle.
 This is guaranteed to be unique, whereas identity is not guaranteed to be unique.
      string worker_instance_key = 19;
      Returns:
      The bytes for workerInstanceKey.

    • getWorkerControlTaskQueue

      String getWorkerControlTaskQueue()
       A dedicated per-worker Nexus task queue on which the server sends control
 tasks (e.g. activity cancellation) to this specific worker instance.
      string worker_control_task_queue = 20;
      Returns:
      The workerControlTaskQueue.

    • getWorkerControlTaskQueueBytes

      com.google.protobuf.ByteString getWorkerControlTaskQueueBytes()
       A dedicated per-worker Nexus task queue on which the server sends control
 tasks (e.g. activity cancellation) to this specific worker instance.
      string worker_control_task_queue = 20;
      Returns:
      The bytes for workerControlTaskQueue.

    • getPageNumber

      int getPageNumber()
       0-indexed page number when the workflow task completion is split across multiple
 requests ("pages"). 0 for single-page requests. May only be set to non-zero value
 when the namespace capability workflow_task_completion_pagination is true.
      int32 page_number = 21;
      Returns:
      The pageNumber.

    • getIntermediatePage

      boolean getIntermediatePage()
       True for non-final pages of a paginated workflow task completion. The final page's
 `page_number` tells the server how many intermediate pages (0..page_number-1) preceded it.
 May only be used when the namespace capability workflow_task_completion_pagination is true.
      bool intermediate_page = 22;
      Returns:
      The intermediatePage.