Package io.temporal.api.workflowservice.v1

Interface GetWorkflowExecutionHistoryRequestOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      WorkflowExecution getExecution()
      .temporal.api.common.v1.WorkflowExecution execution = 2;
      WorkflowExecutionOrBuilder getExecutionOrBuilder()
      .temporal.api.common.v1.WorkflowExecution execution = 2;
      HistoryEventFilterType getHistoryEventFilterType()
      Filter returned events such that they match the specified filter type.
      int getHistoryEventFilterTypeValue()
      Filter returned events such that they match the specified filter type.
      int getMaximumPageSize()
      int32 maximum_page_size = 3;
      java.lang.String getNamespace()
      string namespace = 1;
      com.google.protobuf.ByteString getNamespaceBytes()
      string namespace = 1;
      com.google.protobuf.ByteString getNextPageToken()
      If a `GetWorkflowExecutionHistoryResponse` or a `PollWorkflowTaskQueueResponse` had one of these, it should be passed here to fetch the next page.
      boolean getSkipArchival()
      bool skip_archival = 7;
      boolean getWaitNewEvent()
      If set to true, the RPC call will not resolve until there is a new event which matches the `history_event_filter_type`, or a timeout is hit.
      boolean hasExecution()
      .temporal.api.common.v1.WorkflowExecution execution = 2;

      • 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

      • getNamespace

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

      • getNamespaceBytes

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

      • hasExecution

        boolean hasExecution()
        .temporal.api.common.v1.WorkflowExecution execution = 2;
        Returns:
        Whether the execution field is set.

      • getExecution

        WorkflowExecution getExecution()
        .temporal.api.common.v1.WorkflowExecution execution = 2;
        Returns:
        The execution.

      • getExecutionOrBuilder

        WorkflowExecutionOrBuilder getExecutionOrBuilder()
        .temporal.api.common.v1.WorkflowExecution execution = 2;

      • getMaximumPageSize

        int getMaximumPageSize()
        int32 maximum_page_size = 3;
        Returns:
        The maximumPageSize.

      • getNextPageToken

        com.google.protobuf.ByteString getNextPageToken()
         If a `GetWorkflowExecutionHistoryResponse` or a `PollWorkflowTaskQueueResponse` had one of
 these, it should be passed here to fetch the next page.
        bytes next_page_token = 4;
        Returns:
        The nextPageToken.

      • getWaitNewEvent

        boolean getWaitNewEvent()
         If set to true, the RPC call will not resolve until there is a new event which matches
 the `history_event_filter_type`, or a timeout is hit.
        bool wait_new_event = 5;
        Returns:
        The waitNewEvent.

      • getHistoryEventFilterTypeValue

        int getHistoryEventFilterTypeValue()
         Filter returned events such that they match the specified filter type.
 Default: HISTORY_EVENT_FILTER_TYPE_ALL_EVENT.
        .temporal.api.enums.v1.HistoryEventFilterType history_event_filter_type = 6;
        Returns:
        The enum numeric value on the wire for historyEventFilterType.

      • getHistoryEventFilterType

        HistoryEventFilterType getHistoryEventFilterType()
         Filter returned events such that they match the specified filter type.
 Default: HISTORY_EVENT_FILTER_TYPE_ALL_EVENT.
        .temporal.api.enums.v1.HistoryEventFilterType history_event_filter_type = 6;
        Returns:
        The historyEventFilterType.

      • getSkipArchival

        boolean getSkipArchival()
        bool skip_archival = 7;
        Returns:
        The skipArchival.