Package io.temporal.api.command.v1

Class Command

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CommandOrBuilder, java.io.Serializable
    @Generated(value="protoc",
           comments="annotations:Command.java.pb.meta")
public final class Command
extends com.google.protobuf.GeneratedMessageV3
implements CommandOrBuilder
    Protobuf type temporal.api.command.v1.Command
    See Also:
    Serialized Form

    • Field Detail

      • COMMAND_TYPE_FIELD_NUMBER

        public static final int COMMAND_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • USER_METADATA_FIELD_NUMBER

        public static final int USER_METADATA_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SCHEDULE_ACTIVITY_TASK_COMMAND_ATTRIBUTES_FIELD_NUMBER

        public static final int SCHEDULE_ACTIVITY_TASK_COMMAND_ATTRIBUTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • START_TIMER_COMMAND_ATTRIBUTES_FIELD_NUMBER

        public static final int START_TIMER_COMMAND_ATTRIBUTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • COMPLETE_WORKFLOW_EXECUTION_COMMAND_ATTRIBUTES_FIELD_NUMBER

        public static final int COMPLETE_WORKFLOW_EXECUTION_COMMAND_ATTRIBUTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FAIL_WORKFLOW_EXECUTION_COMMAND_ATTRIBUTES_FIELD_NUMBER

        public static final int FAIL_WORKFLOW_EXECUTION_COMMAND_ATTRIBUTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REQUEST_CANCEL_ACTIVITY_TASK_COMMAND_ATTRIBUTES_FIELD_NUMBER

        public static final int REQUEST_CANCEL_ACTIVITY_TASK_COMMAND_ATTRIBUTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CANCEL_TIMER_COMMAND_ATTRIBUTES_FIELD_NUMBER

        public static final int CANCEL_TIMER_COMMAND_ATTRIBUTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CANCEL_WORKFLOW_EXECUTION_COMMAND_ATTRIBUTES_FIELD_NUMBER

        public static final int CANCEL_WORKFLOW_EXECUTION_COMMAND_ATTRIBUTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_COMMAND_ATTRIBUTES_FIELD_NUMBER

        public static final int REQUEST_CANCEL_EXTERNAL_WORKFLOW_EXECUTION_COMMAND_ATTRIBUTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RECORD_MARKER_COMMAND_ATTRIBUTES_FIELD_NUMBER

        public static final int RECORD_MARKER_COMMAND_ATTRIBUTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CONTINUE_AS_NEW_WORKFLOW_EXECUTION_COMMAND_ATTRIBUTES_FIELD_NUMBER

        public static final int CONTINUE_AS_NEW_WORKFLOW_EXECUTION_COMMAND_ATTRIBUTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • START_CHILD_WORKFLOW_EXECUTION_COMMAND_ATTRIBUTES_FIELD_NUMBER

        public static final int START_CHILD_WORKFLOW_EXECUTION_COMMAND_ATTRIBUTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_COMMAND_ATTRIBUTES_FIELD_NUMBER

        public static final int SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_COMMAND_ATTRIBUTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • UPSERT_WORKFLOW_SEARCH_ATTRIBUTES_COMMAND_ATTRIBUTES_FIELD_NUMBER

        public static final int UPSERT_WORKFLOW_SEARCH_ATTRIBUTES_COMMAND_ATTRIBUTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PROTOCOL_MESSAGE_COMMAND_ATTRIBUTES_FIELD_NUMBER

        public static final int PROTOCOL_MESSAGE_COMMAND_ATTRIBUTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MODIFY_WORKFLOW_PROPERTIES_COMMAND_ATTRIBUTES_FIELD_NUMBER

        public static final int MODIFY_WORKFLOW_PROPERTIES_COMMAND_ATTRIBUTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SCHEDULE_NEXUS_OPERATION_COMMAND_ATTRIBUTES_FIELD_NUMBER

        public static final int SCHEDULE_NEXUS_OPERATION_COMMAND_ATTRIBUTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REQUEST_CANCEL_NEXUS_OPERATION_COMMAND_ATTRIBUTES_FIELD_NUMBER

        public static final int REQUEST_CANCEL_NEXUS_OPERATION_COMMAND_ATTRIBUTES_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getCommandTypeValue

        public int getCommandTypeValue()
        .temporal.api.enums.v1.CommandType command_type = 1;
        Specified by:
        getCommandTypeValue in interface CommandOrBuilder
        Returns:
        The enum numeric value on the wire for commandType.

      • hasUserMetadata

        public boolean hasUserMetadata()
         Metadata on the command. This is sometimes carried over to the history event if one is
 created as a result of the command. Most commands won't have this information, and how this
 information is used is dependent upon the interface that reads it.
 Current well-known uses:
  * start_child_workflow_execution_command_attributes - populates
    temporal.api.workflow.v1.WorkflowExecutionInfo.user_metadata where the summary and details
    are used by user interfaces to show fixed as-of-start workflow summary and details.
  * start_timer_command_attributes - populates temporal.api.history.v1.HistoryEvent for timer
    started where the summary is used to identify the timer.
        .temporal.api.sdk.v1.UserMetadata user_metadata = 301;
        Specified by:
        hasUserMetadata in interface CommandOrBuilder
        Returns:
        Whether the userMetadata field is set.

      • getUserMetadata

        public UserMetadata getUserMetadata()
         Metadata on the command. This is sometimes carried over to the history event if one is
 created as a result of the command. Most commands won't have this information, and how this
 information is used is dependent upon the interface that reads it.
 Current well-known uses:
  * start_child_workflow_execution_command_attributes - populates
    temporal.api.workflow.v1.WorkflowExecutionInfo.user_metadata where the summary and details
    are used by user interfaces to show fixed as-of-start workflow summary and details.
  * start_timer_command_attributes - populates temporal.api.history.v1.HistoryEvent for timer
    started where the summary is used to identify the timer.
        .temporal.api.sdk.v1.UserMetadata user_metadata = 301;
        Specified by:
        getUserMetadata in interface CommandOrBuilder
        Returns:
        The userMetadata.

      • getUserMetadataOrBuilder

        public UserMetadataOrBuilder getUserMetadataOrBuilder()
         Metadata on the command. This is sometimes carried over to the history event if one is
 created as a result of the command. Most commands won't have this information, and how this
 information is used is dependent upon the interface that reads it.
 Current well-known uses:
  * start_child_workflow_execution_command_attributes - populates
    temporal.api.workflow.v1.WorkflowExecutionInfo.user_metadata where the summary and details
    are used by user interfaces to show fixed as-of-start workflow summary and details.
  * start_timer_command_attributes - populates temporal.api.history.v1.HistoryEvent for timer
    started where the summary is used to identify the timer.
        .temporal.api.sdk.v1.UserMetadata user_metadata = 301;
        Specified by:
        getUserMetadataOrBuilder in interface CommandOrBuilder

      • hasScheduleActivityTaskCommandAttributes

        public boolean hasScheduleActivityTaskCommandAttributes()
        .temporal.api.command.v1.ScheduleActivityTaskCommandAttributes schedule_activity_task_command_attributes = 2;
        Specified by:
        hasScheduleActivityTaskCommandAttributes in interface CommandOrBuilder
        Returns:
        Whether the scheduleActivityTaskCommandAttributes field is set.

      • hasStartTimerCommandAttributes

        public boolean hasStartTimerCommandAttributes()
        .temporal.api.command.v1.StartTimerCommandAttributes start_timer_command_attributes = 3;
        Specified by:
        hasStartTimerCommandAttributes in interface CommandOrBuilder
        Returns:
        Whether the startTimerCommandAttributes field is set.

      • hasCompleteWorkflowExecutionCommandAttributes

        public boolean hasCompleteWorkflowExecutionCommandAttributes()
        .temporal.api.command.v1.CompleteWorkflowExecutionCommandAttributes complete_workflow_execution_command_attributes = 4;
        Specified by:
        hasCompleteWorkflowExecutionCommandAttributes in interface CommandOrBuilder
        Returns:
        Whether the completeWorkflowExecutionCommandAttributes field is set.

      • hasFailWorkflowExecutionCommandAttributes

        public boolean hasFailWorkflowExecutionCommandAttributes()
        .temporal.api.command.v1.FailWorkflowExecutionCommandAttributes fail_workflow_execution_command_attributes = 5;
        Specified by:
        hasFailWorkflowExecutionCommandAttributes in interface CommandOrBuilder
        Returns:
        Whether the failWorkflowExecutionCommandAttributes field is set.

      • hasRequestCancelActivityTaskCommandAttributes

        public boolean hasRequestCancelActivityTaskCommandAttributes()
        .temporal.api.command.v1.RequestCancelActivityTaskCommandAttributes request_cancel_activity_task_command_attributes = 6;
        Specified by:
        hasRequestCancelActivityTaskCommandAttributes in interface CommandOrBuilder
        Returns:
        Whether the requestCancelActivityTaskCommandAttributes field is set.

      • hasCancelTimerCommandAttributes

        public boolean hasCancelTimerCommandAttributes()
        .temporal.api.command.v1.CancelTimerCommandAttributes cancel_timer_command_attributes = 7;
        Specified by:
        hasCancelTimerCommandAttributes in interface CommandOrBuilder
        Returns:
        Whether the cancelTimerCommandAttributes field is set.

      • hasCancelWorkflowExecutionCommandAttributes

        public boolean hasCancelWorkflowExecutionCommandAttributes()
        .temporal.api.command.v1.CancelWorkflowExecutionCommandAttributes cancel_workflow_execution_command_attributes = 8;
        Specified by:
        hasCancelWorkflowExecutionCommandAttributes in interface CommandOrBuilder
        Returns:
        Whether the cancelWorkflowExecutionCommandAttributes field is set.

      • hasRequestCancelExternalWorkflowExecutionCommandAttributes

        public boolean hasRequestCancelExternalWorkflowExecutionCommandAttributes()
        .temporal.api.command.v1.RequestCancelExternalWorkflowExecutionCommandAttributes request_cancel_external_workflow_execution_command_attributes = 9;
        Specified by:
        hasRequestCancelExternalWorkflowExecutionCommandAttributes in interface CommandOrBuilder
        Returns:
        Whether the requestCancelExternalWorkflowExecutionCommandAttributes field is set.

      • hasRecordMarkerCommandAttributes

        public boolean hasRecordMarkerCommandAttributes()
        .temporal.api.command.v1.RecordMarkerCommandAttributes record_marker_command_attributes = 10;
        Specified by:
        hasRecordMarkerCommandAttributes in interface CommandOrBuilder
        Returns:
        Whether the recordMarkerCommandAttributes field is set.

      • hasContinueAsNewWorkflowExecutionCommandAttributes

        public boolean hasContinueAsNewWorkflowExecutionCommandAttributes()
        .temporal.api.command.v1.ContinueAsNewWorkflowExecutionCommandAttributes continue_as_new_workflow_execution_command_attributes = 11;
        Specified by:
        hasContinueAsNewWorkflowExecutionCommandAttributes in interface CommandOrBuilder
        Returns:
        Whether the continueAsNewWorkflowExecutionCommandAttributes field is set.

      • hasStartChildWorkflowExecutionCommandAttributes

        public boolean hasStartChildWorkflowExecutionCommandAttributes()
        .temporal.api.command.v1.StartChildWorkflowExecutionCommandAttributes start_child_workflow_execution_command_attributes = 12;
        Specified by:
        hasStartChildWorkflowExecutionCommandAttributes in interface CommandOrBuilder
        Returns:
        Whether the startChildWorkflowExecutionCommandAttributes field is set.

      • hasSignalExternalWorkflowExecutionCommandAttributes

        public boolean hasSignalExternalWorkflowExecutionCommandAttributes()
        .temporal.api.command.v1.SignalExternalWorkflowExecutionCommandAttributes signal_external_workflow_execution_command_attributes = 13;
        Specified by:
        hasSignalExternalWorkflowExecutionCommandAttributes in interface CommandOrBuilder
        Returns:
        Whether the signalExternalWorkflowExecutionCommandAttributes field is set.

      • hasUpsertWorkflowSearchAttributesCommandAttributes

        public boolean hasUpsertWorkflowSearchAttributesCommandAttributes()
        .temporal.api.command.v1.UpsertWorkflowSearchAttributesCommandAttributes upsert_workflow_search_attributes_command_attributes = 14;
        Specified by:
        hasUpsertWorkflowSearchAttributesCommandAttributes in interface CommandOrBuilder
        Returns:
        Whether the upsertWorkflowSearchAttributesCommandAttributes field is set.

      • hasProtocolMessageCommandAttributes

        public boolean hasProtocolMessageCommandAttributes()
        .temporal.api.command.v1.ProtocolMessageCommandAttributes protocol_message_command_attributes = 15;
        Specified by:
        hasProtocolMessageCommandAttributes in interface CommandOrBuilder
        Returns:
        Whether the protocolMessageCommandAttributes field is set.

      • hasModifyWorkflowPropertiesCommandAttributes

        public boolean hasModifyWorkflowPropertiesCommandAttributes()
         16 is available for use - it was used as part of a prototype that never made it into a release
        .temporal.api.command.v1.ModifyWorkflowPropertiesCommandAttributes modify_workflow_properties_command_attributes = 17;
        Specified by:
        hasModifyWorkflowPropertiesCommandAttributes in interface CommandOrBuilder
        Returns:
        Whether the modifyWorkflowPropertiesCommandAttributes field is set.

      • getModifyWorkflowPropertiesCommandAttributes

        public ModifyWorkflowPropertiesCommandAttributes getModifyWorkflowPropertiesCommandAttributes()
         16 is available for use - it was used as part of a prototype that never made it into a release
        .temporal.api.command.v1.ModifyWorkflowPropertiesCommandAttributes modify_workflow_properties_command_attributes = 17;
        Specified by:
        getModifyWorkflowPropertiesCommandAttributes in interface CommandOrBuilder
        Returns:
        The modifyWorkflowPropertiesCommandAttributes.

      • hasScheduleNexusOperationCommandAttributes

        public boolean hasScheduleNexusOperationCommandAttributes()
        .temporal.api.command.v1.ScheduleNexusOperationCommandAttributes schedule_nexus_operation_command_attributes = 18;
        Specified by:
        hasScheduleNexusOperationCommandAttributes in interface CommandOrBuilder
        Returns:
        Whether the scheduleNexusOperationCommandAttributes field is set.

      • hasRequestCancelNexusOperationCommandAttributes

        public boolean hasRequestCancelNexusOperationCommandAttributes()
        .temporal.api.command.v1.RequestCancelNexusOperationCommandAttributes request_cancel_nexus_operation_command_attributes = 19;
        Specified by:
        hasRequestCancelNexusOperationCommandAttributes in interface CommandOrBuilder
        Returns:
        Whether the requestCancelNexusOperationCommandAttributes field is set.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Command parseFrom​(java.nio.ByteBuffer data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Command parseFrom​(java.nio.ByteBuffer data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Command parseFrom​(com.google.protobuf.ByteString data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Command parseFrom​(com.google.protobuf.ByteString data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Command parseFrom​(byte[] data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Command parseFrom​(byte[] data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Command parseFrom​(java.io.InputStream input)
                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Command parseFrom​(java.io.InputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static Command parseDelimitedFrom​(java.io.InputStream input)
                                  throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static Command parseDelimitedFrom​(java.io.InputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Command parseFrom​(com.google.protobuf.CodedInputStream input)
                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Command parseFrom​(com.google.protobuf.CodedInputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

        public Command.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Command.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Command.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Command getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Command> parser()

      • getParserForType

        public com.google.protobuf.Parser<Command> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Command getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder