Package io.temporal.api.command.v1

Interface RequestCancelExternalWorkflowExecutionCommandAttributesOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean getChildWorkflowOnly()
      Set this to true if the workflow being cancelled is a child of the workflow originating this command.
      java.lang.String getControl()
      Deprecated.
      temporal.api.command.v1.RequestCancelExternalWorkflowExecutionCommandAttributes.control is deprecated.
      com.google.protobuf.ByteString getControlBytes()
      Deprecated.
      temporal.api.command.v1.RequestCancelExternalWorkflowExecutionCommandAttributes.control is deprecated.
      java.lang.String getNamespace()
      string namespace = 1;
      com.google.protobuf.ByteString getNamespaceBytes()
      string namespace = 1;
      java.lang.String getReason()
      Reason for requesting the cancellation
      com.google.protobuf.ByteString getReasonBytes()
      Reason for requesting the cancellation
      java.lang.String getRunId()
      string run_id = 3;
      com.google.protobuf.ByteString getRunIdBytes()
      string run_id = 3;
      java.lang.String getWorkflowId()
      string workflow_id = 2;
      com.google.protobuf.ByteString getWorkflowIdBytes()
      string workflow_id = 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.

      • getWorkflowId

        java.lang.String getWorkflowId()
        string workflow_id = 2;
        Returns:
        The workflowId.

      • getWorkflowIdBytes

        com.google.protobuf.ByteString getWorkflowIdBytes()
        string workflow_id = 2;
        Returns:
        The bytes for workflowId.

      • getRunId

        java.lang.String getRunId()
        string run_id = 3;
        Returns:
        The runId.

      • getRunIdBytes

        com.google.protobuf.ByteString getRunIdBytes()
        string run_id = 3;
        Returns:
        The bytes for runId.

      • getControl

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

      • getControlBytes

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

      • getChildWorkflowOnly

        boolean getChildWorkflowOnly()
         Set this to true if the workflow being cancelled is a child of the workflow originating this
 command. The request will be rejected if it is set to true and the target workflow is *not*
 a child of the requesting workflow.
        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.