Package io.temporal.api.workflowservice.v1

Interface DescribeActivityExecutionRequestOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getActivityId()
      string activity_id = 2;
      com.google.protobuf.ByteString getActivityIdBytes()
      string activity_id = 2;
      boolean getIncludeInput()
      Include the input field in the response.
      boolean getIncludeOutcome()
      Include the outcome (result/failure) in the response if the activity has completed.
      com.google.protobuf.ByteString getLongPollToken()
      Token from a previous DescribeActivityExecutionResponse.
      java.lang.String getNamespace()
      string namespace = 1;
      com.google.protobuf.ByteString getNamespaceBytes()
      string namespace = 1;
      java.lang.String getRunId()
      Activity run ID.
      com.google.protobuf.ByteString getRunIdBytes()
      Activity run ID.

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

      • getActivityId

        java.lang.String getActivityId()
        string activity_id = 2;
        Returns:
        The activityId.

      • getActivityIdBytes

        com.google.protobuf.ByteString getActivityIdBytes()
        string activity_id = 2;
        Returns:
        The bytes for activityId.

      • getRunId

        java.lang.String getRunId()
         Activity run ID. If empty the request targets the latest run.
        string run_id = 3;
        Returns:
        The runId.

      • getRunIdBytes

        com.google.protobuf.ByteString getRunIdBytes()
         Activity run ID. If empty the request targets the latest run.
        string run_id = 3;
        Returns:
        The bytes for runId.

      • getIncludeInput

        boolean getIncludeInput()
         Include the input field in the response.
        bool include_input = 4;
        Returns:
        The includeInput.

      • getIncludeOutcome

        boolean getIncludeOutcome()
         Include the outcome (result/failure) in the response if the activity has completed.
        bool include_outcome = 5;
        Returns:
        The includeOutcome.

      • getLongPollToken

        com.google.protobuf.ByteString getLongPollToken()
         Token from a previous DescribeActivityExecutionResponse. If present, long-poll until activity
 state changes from the state encoded in this token. If absent, return current state immediately.
 If present, run_id must also be present.
 Note that activity state may change multiple times between requests, therefore it is not
 guaranteed that a client making a sequence of long-poll requests will see a complete
 sequence of state changes.
        bytes long_poll_token = 6;
        Returns:
        The longPollToken.