Package io.temporal.api.query.v1

Interface WorkflowQueryOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Header getHeader()
      Headers that were passed by the caller of the query and copied by temporal server into the workflow task.
      HeaderOrBuilder getHeaderOrBuilder()
      Headers that were passed by the caller of the query and copied by temporal server into the workflow task.
      Payloads getQueryArgs()
      Serialized arguments that will be provided to the query handler.
      PayloadsOrBuilder getQueryArgsOrBuilder()
      Serialized arguments that will be provided to the query handler.
      java.lang.String getQueryType()
      The workflow-author-defined identifier of the query.
      com.google.protobuf.ByteString getQueryTypeBytes()
      The workflow-author-defined identifier of the query.
      boolean hasHeader()
      Headers that were passed by the caller of the query and copied by temporal server into the workflow task.
      boolean hasQueryArgs()
      Serialized arguments that will be provided to the query handler.

      • 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 Detail

      • getQueryType

        java.lang.String getQueryType()
         The workflow-author-defined identifier of the query. Typically a function name.
        string query_type = 1;
        Returns:
        The queryType.

      • getQueryTypeBytes

        com.google.protobuf.ByteString getQueryTypeBytes()
         The workflow-author-defined identifier of the query. Typically a function name.
        string query_type = 1;
        Returns:
        The bytes for queryType.

      • hasQueryArgs

        boolean hasQueryArgs()
         Serialized arguments that will be provided to the query handler.
        .temporal.api.common.v1.Payloads query_args = 2;
        Returns:
        Whether the queryArgs field is set.

      • getQueryArgs

        Payloads getQueryArgs()
         Serialized arguments that will be provided to the query handler.
        .temporal.api.common.v1.Payloads query_args = 2;
        Returns:
        The queryArgs.

      • getQueryArgsOrBuilder

        PayloadsOrBuilder getQueryArgsOrBuilder()
         Serialized arguments that will be provided to the query handler.
        .temporal.api.common.v1.Payloads query_args = 2;

      • hasHeader

        boolean hasHeader()
         Headers that were passed by the caller of the query and copied by temporal 
 server into the workflow task.
        .temporal.api.common.v1.Header header = 3;
        Returns:
        Whether the header field is set.

      • getHeader

        Header getHeader()
         Headers that were passed by the caller of the query and copied by temporal 
 server into the workflow task.
        .temporal.api.common.v1.Header header = 3;
        Returns:
        The header.

      • getHeaderOrBuilder

        HeaderOrBuilder getHeaderOrBuilder()
         Headers that were passed by the caller of the query and copied by temporal 
 server into the workflow task.
        .temporal.api.common.v1.Header header = 3;