Package io.temporal.api.history.v1

Interface RequestCancelExternalWorkflowExecutionInitiatedEventAttributesOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean getChildWorkflowOnly()
      Workers are expected to set this to true if the workflow they are requesting to cancel is a child of the workflow which issued the request
      java.lang.String getControl()
      Deprecated.
      temporal.api.history.v1.RequestCancelExternalWorkflowExecutionInitiatedEventAttributes.control is deprecated.
      com.google.protobuf.ByteString getControlBytes()
      Deprecated.
      temporal.api.history.v1.RequestCancelExternalWorkflowExecutionInitiatedEventAttributes.control is deprecated.
      java.lang.String getNamespace()
      The namespace the workflow to be cancelled lives in.
      com.google.protobuf.ByteString getNamespaceBytes()
      The namespace the workflow to be cancelled lives in.
      java.lang.String getNamespaceId()
      string namespace_id = 7;
      com.google.protobuf.ByteString getNamespaceIdBytes()
      string namespace_id = 7;
      java.lang.String getReason()
      Reason for requesting the cancellation
      com.google.protobuf.ByteString getReasonBytes()
      Reason for requesting the cancellation
      WorkflowExecution getWorkflowExecution()
      .temporal.api.common.v1.WorkflowExecution workflow_execution = 3;
      WorkflowExecutionOrBuilder getWorkflowExecutionOrBuilder()
      .temporal.api.common.v1.WorkflowExecution workflow_execution = 3;
      long getWorkflowTaskCompletedEventId()
      The `WORKFLOW_TASK_COMPLETED` event which this command was reported with
      boolean hasWorkflowExecution()
      .temporal.api.common.v1.WorkflowExecution workflow_execution = 3;

      • 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

      • getWorkflowTaskCompletedEventId

        long getWorkflowTaskCompletedEventId()
         The `WORKFLOW_TASK_COMPLETED` event which this command was reported with
        int64 workflow_task_completed_event_id = 1;
        Returns:
        The workflowTaskCompletedEventId.

      • getNamespace

        java.lang.String getNamespace()
         The namespace the workflow to be cancelled lives in.
 SDKs and UI tools should use `namespace` field but server must use `namespace_id` only.
        string namespace = 2;
        Returns:
        The namespace.

      • getNamespaceBytes

        com.google.protobuf.ByteString getNamespaceBytes()
         The namespace the workflow to be cancelled lives in.
 SDKs and UI tools should use `namespace` field but server must use `namespace_id` only.
        string namespace = 2;
        Returns:
        The bytes for namespace.

      • getNamespaceId

        java.lang.String getNamespaceId()
        string namespace_id = 7;
        Returns:
        The namespaceId.

      • getNamespaceIdBytes

        com.google.protobuf.ByteString getNamespaceIdBytes()
        string namespace_id = 7;
        Returns:
        The bytes for namespaceId.

      • hasWorkflowExecution

        boolean hasWorkflowExecution()
        .temporal.api.common.v1.WorkflowExecution workflow_execution = 3;
        Returns:
        Whether the workflowExecution field is set.

      • getWorkflowExecution

        WorkflowExecution getWorkflowExecution()
        .temporal.api.common.v1.WorkflowExecution workflow_execution = 3;
        Returns:
        The workflowExecution.

      • getWorkflowExecutionOrBuilder

        WorkflowExecutionOrBuilder getWorkflowExecutionOrBuilder()
        .temporal.api.common.v1.WorkflowExecution workflow_execution = 3;

      • getControl

        @Deprecated
java.lang.String getControl()
        Deprecated.
        temporal.api.history.v1.RequestCancelExternalWorkflowExecutionInitiatedEventAttributes.control is deprecated. See temporal/api/history/v1/message.proto;l=557
         Deprecated.
        string control = 4 [deprecated = true];
        Returns:
        The control.

      • getControlBytes

        @Deprecated
com.google.protobuf.ByteString getControlBytes()
        Deprecated.
        temporal.api.history.v1.RequestCancelExternalWorkflowExecutionInitiatedEventAttributes.control is deprecated. See temporal/api/history/v1/message.proto;l=557
         Deprecated.
        string control = 4 [deprecated = true];
        Returns:
        The bytes for control.

      • getChildWorkflowOnly

        boolean getChildWorkflowOnly()
         Workers are expected to set this to true if the workflow they are requesting to cancel is
 a child of the workflow which issued the request
        bool child_workflow_only = 5;
        Returns:
        The childWorkflowOnly.

      • getReason

        java.lang.String getReason()
         Reason for requesting the cancellation
        string reason = 6;
        Returns:
        The reason.

      • getReasonBytes

        com.google.protobuf.ByteString getReasonBytes()
         Reason for requesting the cancellation
        string reason = 6;
        Returns:
        The bytes for reason.