Interface RespondQueryTaskCompletedRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    WorkflowTaskFailedCause
    getCause()
    Why did the task fail? It's important to note that many of the variants in this enum cannot apply to worker responses.
    int
    getCauseValue()
    Why did the task fail? It's important to note that many of the variants in this enum cannot apply to worker responses.
    QueryResultType
    getCompletedType()
    .temporal.api.enums.v1.QueryResultType completed_type = 2;
    int
    getCompletedTypeValue()
    .temporal.api.enums.v1.QueryResultType completed_type = 2;
    String
    getErrorMessage()
    A plain error message that must be set if completed_type is QUERY_RESULT_TYPE_FAILED.
    com.google.protobuf.ByteString
    getErrorMessageBytes()
    A plain error message that must be set if completed_type is QUERY_RESULT_TYPE_FAILED.
    Failure
    getFailure()
    The full reason for this query failure.
    FailureOrBuilder
    getFailureOrBuilder()
    The full reason for this query failure.
    String
    getNamespace()
    string namespace = 6;
    com.google.protobuf.ByteString
    getNamespaceBytes()
    string namespace = 6;
    String
    getPollerGroupId()
    Client must forward the poller_group_id received in PollWorkflowTaskQueueResponse for proper routing of the response.
    com.google.protobuf.ByteString
    getPollerGroupIdBytes()
    Client must forward the poller_group_id received in PollWorkflowTaskQueueResponse for proper routing of the response.
    Payloads
    getQueryResult()
    The result of the query.
    PayloadsOrBuilder
    getQueryResultOrBuilder()
    The result of the query.
    com.google.protobuf.ByteString
    getTaskToken()
    bytes task_token = 1;
    boolean
    hasFailure()
    The full reason for this query failure.
    boolean
    hasQueryResult()
    The result of the query.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getTaskToken

      com.google.protobuf.ByteString getTaskToken()
      bytes task_token = 1;
      Returns:
      The taskToken.

    • getCompletedTypeValue

      int getCompletedTypeValue()
      .temporal.api.enums.v1.QueryResultType completed_type = 2;
      Returns:
      The enum numeric value on the wire for completedType.

    • getCompletedType

      QueryResultType getCompletedType()
      .temporal.api.enums.v1.QueryResultType completed_type = 2;
      Returns:
      The completedType.

    • hasQueryResult

      boolean hasQueryResult()
       The result of the query.
 Mutually exclusive with `error_message` and `failure`. Set when the query succeeds.
      .temporal.api.common.v1.Payloads query_result = 3;
      Returns:
      Whether the queryResult field is set.

    • getQueryResult

      Payloads getQueryResult()
       The result of the query.
 Mutually exclusive with `error_message` and `failure`. Set when the query succeeds.
      .temporal.api.common.v1.Payloads query_result = 3;
      Returns:
      The queryResult.

    • getQueryResultOrBuilder

      PayloadsOrBuilder getQueryResultOrBuilder()
       The result of the query.
 Mutually exclusive with `error_message` and `failure`. Set when the query succeeds.
      .temporal.api.common.v1.Payloads query_result = 3;

    • getErrorMessage

      String getErrorMessage()
       A plain error message that must be set if completed_type is QUERY_RESULT_TYPE_FAILED.
 SDKs should also fill in the more complete `failure` field to provide the full context and
 support encryption of failure information.
 `error_message` will be duplicated if the `failure` field is present to support callers
 that pre-date the addition of that field, regardless of whether or not a custom failure
 converter is used.
 Mutually exclusive with `query_result`. Set when the query fails.
      string error_message = 4;
      Returns:
      The errorMessage.

    • getErrorMessageBytes

      com.google.protobuf.ByteString getErrorMessageBytes()
       A plain error message that must be set if completed_type is QUERY_RESULT_TYPE_FAILED.
 SDKs should also fill in the more complete `failure` field to provide the full context and
 support encryption of failure information.
 `error_message` will be duplicated if the `failure` field is present to support callers
 that pre-date the addition of that field, regardless of whether or not a custom failure
 converter is used.
 Mutually exclusive with `query_result`. Set when the query fails.
      string error_message = 4;
      Returns:
      The bytes for errorMessage.

    • getNamespace

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

    • getNamespaceBytes

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

    • hasFailure

      boolean hasFailure()
       The full reason for this query failure. This field is newer than `error_message` and can be
 encoded by the SDK's failure converter to support E2E encryption of messages and stack
 traces.
 Mutually exclusive with `query_result`. Set when the query fails.
      .temporal.api.failure.v1.Failure failure = 7;
      Returns:
      Whether the failure field is set.

    • getFailure

      Failure getFailure()
       The full reason for this query failure. This field is newer than `error_message` and can be
 encoded by the SDK's failure converter to support E2E encryption of messages and stack
 traces.
 Mutually exclusive with `query_result`. Set when the query fails.
      .temporal.api.failure.v1.Failure failure = 7;
      Returns:
      The failure.

    • getFailureOrBuilder

      FailureOrBuilder getFailureOrBuilder()
       The full reason for this query failure. This field is newer than `error_message` and can be
 encoded by the SDK's failure converter to support E2E encryption of messages and stack
 traces.
 Mutually exclusive with `query_result`. Set when the query fails.
      .temporal.api.failure.v1.Failure failure = 7;

    • getCauseValue

      int getCauseValue()
       Why did the task fail? It's important to note that many of the variants in this enum cannot
 apply to worker responses. See the type's doc for more.
      .temporal.api.enums.v1.WorkflowTaskFailedCause cause = 8;
      Returns:
      The enum numeric value on the wire for cause.

    • getCause

      WorkflowTaskFailedCause getCause()
       Why did the task fail? It's important to note that many of the variants in this enum cannot
 apply to worker responses. See the type's doc for more.
      .temporal.api.enums.v1.WorkflowTaskFailedCause cause = 8;
      Returns:
      The cause.

    • getPollerGroupId

      String getPollerGroupId()
       Client must forward the poller_group_id received in PollWorkflowTaskQueueResponse for proper
 routing of the response.
      string poller_group_id = 9;
      Returns:
      The pollerGroupId.

    • getPollerGroupIdBytes

      com.google.protobuf.ByteString getPollerGroupIdBytes()
       Client must forward the poller_group_id received in PollWorkflowTaskQueueResponse for proper
 routing of the response.
      string poller_group_id = 9;
      Returns:
      The bytes for pollerGroupId.