Package io.temporal.api.command.v1

Interface SignalExternalWorkflowExecutionCommandAttributesOrBuilder

    • 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.SignalExternalWorkflowExecutionCommandAttributes.control is deprecated.
      com.google.protobuf.ByteString getControlBytes()
      Deprecated.
      temporal.api.command.v1.SignalExternalWorkflowExecutionCommandAttributes.control is deprecated.
      WorkflowExecution getExecution()
      .temporal.api.common.v1.WorkflowExecution execution = 2;
      WorkflowExecutionOrBuilder getExecutionOrBuilder()
      .temporal.api.common.v1.WorkflowExecution execution = 2;
      Header getHeader()
      Headers that are passed by the workflow that is sending a signal to the external workflow that is receiving this signal.
      HeaderOrBuilder getHeaderOrBuilder()
      Headers that are passed by the workflow that is sending a signal to the external workflow that is receiving this signal.
      Payloads getInput()
      Serialized value(s) to provide with the signal.
      PayloadsOrBuilder getInputOrBuilder()
      Serialized value(s) to provide with the signal.
      java.lang.String getNamespace()
      string namespace = 1;
      com.google.protobuf.ByteString getNamespaceBytes()
      string namespace = 1;
      java.lang.String getSignalName()
      The workflow author-defined name of the signal to send to the workflow.
      com.google.protobuf.ByteString getSignalNameBytes()
      The workflow author-defined name of the signal to send to the workflow.
      boolean hasExecution()
      .temporal.api.common.v1.WorkflowExecution execution = 2;
      boolean hasHeader()
      Headers that are passed by the workflow that is sending a signal to the external workflow that is receiving this signal.
      boolean hasInput()
      Serialized value(s) to provide with the signal.

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

      • getSignalName

        java.lang.String getSignalName()
         The workflow author-defined name of the signal to send to the workflow.
        string signal_name = 3;
        Returns:
        The signalName.

      • getSignalNameBytes

        com.google.protobuf.ByteString getSignalNameBytes()
         The workflow author-defined name of the signal to send to the workflow.
        string signal_name = 3;
        Returns:
        The bytes for signalName.

      • hasInput

        boolean hasInput()
         Serialized value(s) to provide with the signal.
        .temporal.api.common.v1.Payloads input = 4;
        Returns:
        Whether the input field is set.

      • getInput

        Payloads getInput()
         Serialized value(s) to provide with the signal.
        .temporal.api.common.v1.Payloads input = 4;
        Returns:
        The input.

      • getInputOrBuilder

        PayloadsOrBuilder getInputOrBuilder()
         Serialized value(s) to provide with the signal.
        .temporal.api.common.v1.Payloads input = 4;

      • getControl

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

      • getControlBytes

        @Deprecated
com.google.protobuf.ByteString getControlBytes()
        Deprecated.
        temporal.api.command.v1.SignalExternalWorkflowExecutionCommandAttributes.control is deprecated. See temporal/api/command/v1/message.proto;l=125
         Deprecated
        string control = 5 [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 = 6;
        Returns:
        The childWorkflowOnly.

      • hasHeader

        boolean hasHeader()
         Headers that are passed by the workflow that is sending a signal to the external 
 workflow that is receiving this signal.
        .temporal.api.common.v1.Header header = 7;
        Returns:
        Whether the header field is set.

      • getHeader

        Header getHeader()
         Headers that are passed by the workflow that is sending a signal to the external 
 workflow that is receiving this signal.
        .temporal.api.common.v1.Header header = 7;
        Returns:
        The header.

      • getHeaderOrBuilder

        HeaderOrBuilder getHeaderOrBuilder()
         Headers that are passed by the workflow that is sending a signal to the external 
 workflow that is receiving this signal.
        .temporal.api.common.v1.Header header = 7;