Package io.temporal.api.command.v1

Interface CommandOrBuilder

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

    • Method Detail

      • getCommandTypeValue

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

      • getCommandType

        CommandType getCommandType()
        .temporal.api.enums.v1.CommandType command_type = 1;
        Returns:
        The commandType.

      • hasUserMetadata

        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;
        Returns:
        Whether the userMetadata field is set.

      • getUserMetadata

        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;
        Returns:
        The userMetadata.

      • getUserMetadataOrBuilder

        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;

      • hasScheduleActivityTaskCommandAttributes

        boolean hasScheduleActivityTaskCommandAttributes()
        .temporal.api.command.v1.ScheduleActivityTaskCommandAttributes schedule_activity_task_command_attributes = 2;
        Returns:
        Whether the scheduleActivityTaskCommandAttributes field is set.

      • getScheduleActivityTaskCommandAttributes

        ScheduleActivityTaskCommandAttributes getScheduleActivityTaskCommandAttributes()
        .temporal.api.command.v1.ScheduleActivityTaskCommandAttributes schedule_activity_task_command_attributes = 2;
        Returns:
        The scheduleActivityTaskCommandAttributes.

      • getScheduleActivityTaskCommandAttributesOrBuilder

        ScheduleActivityTaskCommandAttributesOrBuilder getScheduleActivityTaskCommandAttributesOrBuilder()
        .temporal.api.command.v1.ScheduleActivityTaskCommandAttributes schedule_activity_task_command_attributes = 2;

      • hasStartTimerCommandAttributes

        boolean hasStartTimerCommandAttributes()
        .temporal.api.command.v1.StartTimerCommandAttributes start_timer_command_attributes = 3;
        Returns:
        Whether the startTimerCommandAttributes field is set.

      • getStartTimerCommandAttributes

        StartTimerCommandAttributes getStartTimerCommandAttributes()
        .temporal.api.command.v1.StartTimerCommandAttributes start_timer_command_attributes = 3;
        Returns:
        The startTimerCommandAttributes.

      • getStartTimerCommandAttributesOrBuilder

        StartTimerCommandAttributesOrBuilder getStartTimerCommandAttributesOrBuilder()
        .temporal.api.command.v1.StartTimerCommandAttributes start_timer_command_attributes = 3;

      • hasCompleteWorkflowExecutionCommandAttributes

        boolean hasCompleteWorkflowExecutionCommandAttributes()
        .temporal.api.command.v1.CompleteWorkflowExecutionCommandAttributes complete_workflow_execution_command_attributes = 4;
        Returns:
        Whether the completeWorkflowExecutionCommandAttributes field is set.

      • getCompleteWorkflowExecutionCommandAttributes

        CompleteWorkflowExecutionCommandAttributes getCompleteWorkflowExecutionCommandAttributes()
        .temporal.api.command.v1.CompleteWorkflowExecutionCommandAttributes complete_workflow_execution_command_attributes = 4;
        Returns:
        The completeWorkflowExecutionCommandAttributes.

      • getCompleteWorkflowExecutionCommandAttributesOrBuilder

        CompleteWorkflowExecutionCommandAttributesOrBuilder getCompleteWorkflowExecutionCommandAttributesOrBuilder()
        .temporal.api.command.v1.CompleteWorkflowExecutionCommandAttributes complete_workflow_execution_command_attributes = 4;

      • hasFailWorkflowExecutionCommandAttributes

        boolean hasFailWorkflowExecutionCommandAttributes()
        .temporal.api.command.v1.FailWorkflowExecutionCommandAttributes fail_workflow_execution_command_attributes = 5;
        Returns:
        Whether the failWorkflowExecutionCommandAttributes field is set.

      • getFailWorkflowExecutionCommandAttributes

        FailWorkflowExecutionCommandAttributes getFailWorkflowExecutionCommandAttributes()
        .temporal.api.command.v1.FailWorkflowExecutionCommandAttributes fail_workflow_execution_command_attributes = 5;
        Returns:
        The failWorkflowExecutionCommandAttributes.

      • getFailWorkflowExecutionCommandAttributesOrBuilder

        FailWorkflowExecutionCommandAttributesOrBuilder getFailWorkflowExecutionCommandAttributesOrBuilder()
        .temporal.api.command.v1.FailWorkflowExecutionCommandAttributes fail_workflow_execution_command_attributes = 5;

      • hasRequestCancelActivityTaskCommandAttributes

        boolean hasRequestCancelActivityTaskCommandAttributes()
        .temporal.api.command.v1.RequestCancelActivityTaskCommandAttributes request_cancel_activity_task_command_attributes = 6;
        Returns:
        Whether the requestCancelActivityTaskCommandAttributes field is set.

      • getRequestCancelActivityTaskCommandAttributes

        RequestCancelActivityTaskCommandAttributes getRequestCancelActivityTaskCommandAttributes()
        .temporal.api.command.v1.RequestCancelActivityTaskCommandAttributes request_cancel_activity_task_command_attributes = 6;
        Returns:
        The requestCancelActivityTaskCommandAttributes.

      • getRequestCancelActivityTaskCommandAttributesOrBuilder

        RequestCancelActivityTaskCommandAttributesOrBuilder getRequestCancelActivityTaskCommandAttributesOrBuilder()
        .temporal.api.command.v1.RequestCancelActivityTaskCommandAttributes request_cancel_activity_task_command_attributes = 6;

      • hasCancelTimerCommandAttributes

        boolean hasCancelTimerCommandAttributes()
        .temporal.api.command.v1.CancelTimerCommandAttributes cancel_timer_command_attributes = 7;
        Returns:
        Whether the cancelTimerCommandAttributes field is set.

      • getCancelTimerCommandAttributes

        CancelTimerCommandAttributes getCancelTimerCommandAttributes()
        .temporal.api.command.v1.CancelTimerCommandAttributes cancel_timer_command_attributes = 7;
        Returns:
        The cancelTimerCommandAttributes.

      • getCancelTimerCommandAttributesOrBuilder

        CancelTimerCommandAttributesOrBuilder getCancelTimerCommandAttributesOrBuilder()
        .temporal.api.command.v1.CancelTimerCommandAttributes cancel_timer_command_attributes = 7;

      • hasCancelWorkflowExecutionCommandAttributes

        boolean hasCancelWorkflowExecutionCommandAttributes()
        .temporal.api.command.v1.CancelWorkflowExecutionCommandAttributes cancel_workflow_execution_command_attributes = 8;
        Returns:
        Whether the cancelWorkflowExecutionCommandAttributes field is set.

      • getCancelWorkflowExecutionCommandAttributes

        CancelWorkflowExecutionCommandAttributes getCancelWorkflowExecutionCommandAttributes()
        .temporal.api.command.v1.CancelWorkflowExecutionCommandAttributes cancel_workflow_execution_command_attributes = 8;
        Returns:
        The cancelWorkflowExecutionCommandAttributes.

      • getCancelWorkflowExecutionCommandAttributesOrBuilder

        CancelWorkflowExecutionCommandAttributesOrBuilder getCancelWorkflowExecutionCommandAttributesOrBuilder()
        .temporal.api.command.v1.CancelWorkflowExecutionCommandAttributes cancel_workflow_execution_command_attributes = 8;

      • hasRequestCancelExternalWorkflowExecutionCommandAttributes

        boolean hasRequestCancelExternalWorkflowExecutionCommandAttributes()
        .temporal.api.command.v1.RequestCancelExternalWorkflowExecutionCommandAttributes request_cancel_external_workflow_execution_command_attributes = 9;
        Returns:
        Whether the requestCancelExternalWorkflowExecutionCommandAttributes field is set.

      • getRequestCancelExternalWorkflowExecutionCommandAttributes

        RequestCancelExternalWorkflowExecutionCommandAttributes getRequestCancelExternalWorkflowExecutionCommandAttributes()
        .temporal.api.command.v1.RequestCancelExternalWorkflowExecutionCommandAttributes request_cancel_external_workflow_execution_command_attributes = 9;
        Returns:
        The requestCancelExternalWorkflowExecutionCommandAttributes.

      • getRequestCancelExternalWorkflowExecutionCommandAttributesOrBuilder

        RequestCancelExternalWorkflowExecutionCommandAttributesOrBuilder getRequestCancelExternalWorkflowExecutionCommandAttributesOrBuilder()
        .temporal.api.command.v1.RequestCancelExternalWorkflowExecutionCommandAttributes request_cancel_external_workflow_execution_command_attributes = 9;

      • hasRecordMarkerCommandAttributes

        boolean hasRecordMarkerCommandAttributes()
        .temporal.api.command.v1.RecordMarkerCommandAttributes record_marker_command_attributes = 10;
        Returns:
        Whether the recordMarkerCommandAttributes field is set.

      • getRecordMarkerCommandAttributes

        RecordMarkerCommandAttributes getRecordMarkerCommandAttributes()
        .temporal.api.command.v1.RecordMarkerCommandAttributes record_marker_command_attributes = 10;
        Returns:
        The recordMarkerCommandAttributes.

      • getRecordMarkerCommandAttributesOrBuilder

        RecordMarkerCommandAttributesOrBuilder getRecordMarkerCommandAttributesOrBuilder()
        .temporal.api.command.v1.RecordMarkerCommandAttributes record_marker_command_attributes = 10;

      • hasContinueAsNewWorkflowExecutionCommandAttributes

        boolean hasContinueAsNewWorkflowExecutionCommandAttributes()
        .temporal.api.command.v1.ContinueAsNewWorkflowExecutionCommandAttributes continue_as_new_workflow_execution_command_attributes = 11;
        Returns:
        Whether the continueAsNewWorkflowExecutionCommandAttributes field is set.

      • getContinueAsNewWorkflowExecutionCommandAttributes

        ContinueAsNewWorkflowExecutionCommandAttributes getContinueAsNewWorkflowExecutionCommandAttributes()
        .temporal.api.command.v1.ContinueAsNewWorkflowExecutionCommandAttributes continue_as_new_workflow_execution_command_attributes = 11;
        Returns:
        The continueAsNewWorkflowExecutionCommandAttributes.

      • getContinueAsNewWorkflowExecutionCommandAttributesOrBuilder

        ContinueAsNewWorkflowExecutionCommandAttributesOrBuilder getContinueAsNewWorkflowExecutionCommandAttributesOrBuilder()
        .temporal.api.command.v1.ContinueAsNewWorkflowExecutionCommandAttributes continue_as_new_workflow_execution_command_attributes = 11;

      • hasStartChildWorkflowExecutionCommandAttributes

        boolean hasStartChildWorkflowExecutionCommandAttributes()
        .temporal.api.command.v1.StartChildWorkflowExecutionCommandAttributes start_child_workflow_execution_command_attributes = 12;
        Returns:
        Whether the startChildWorkflowExecutionCommandAttributes field is set.

      • getStartChildWorkflowExecutionCommandAttributes

        StartChildWorkflowExecutionCommandAttributes getStartChildWorkflowExecutionCommandAttributes()
        .temporal.api.command.v1.StartChildWorkflowExecutionCommandAttributes start_child_workflow_execution_command_attributes = 12;
        Returns:
        The startChildWorkflowExecutionCommandAttributes.

      • getStartChildWorkflowExecutionCommandAttributesOrBuilder

        StartChildWorkflowExecutionCommandAttributesOrBuilder getStartChildWorkflowExecutionCommandAttributesOrBuilder()
        .temporal.api.command.v1.StartChildWorkflowExecutionCommandAttributes start_child_workflow_execution_command_attributes = 12;

      • hasSignalExternalWorkflowExecutionCommandAttributes

        boolean hasSignalExternalWorkflowExecutionCommandAttributes()
        .temporal.api.command.v1.SignalExternalWorkflowExecutionCommandAttributes signal_external_workflow_execution_command_attributes = 13;
        Returns:
        Whether the signalExternalWorkflowExecutionCommandAttributes field is set.

      • getSignalExternalWorkflowExecutionCommandAttributes

        SignalExternalWorkflowExecutionCommandAttributes getSignalExternalWorkflowExecutionCommandAttributes()
        .temporal.api.command.v1.SignalExternalWorkflowExecutionCommandAttributes signal_external_workflow_execution_command_attributes = 13;
        Returns:
        The signalExternalWorkflowExecutionCommandAttributes.

      • getSignalExternalWorkflowExecutionCommandAttributesOrBuilder

        SignalExternalWorkflowExecutionCommandAttributesOrBuilder getSignalExternalWorkflowExecutionCommandAttributesOrBuilder()
        .temporal.api.command.v1.SignalExternalWorkflowExecutionCommandAttributes signal_external_workflow_execution_command_attributes = 13;

      • hasUpsertWorkflowSearchAttributesCommandAttributes

        boolean hasUpsertWorkflowSearchAttributesCommandAttributes()
        .temporal.api.command.v1.UpsertWorkflowSearchAttributesCommandAttributes upsert_workflow_search_attributes_command_attributes = 14;
        Returns:
        Whether the upsertWorkflowSearchAttributesCommandAttributes field is set.

      • getUpsertWorkflowSearchAttributesCommandAttributes

        UpsertWorkflowSearchAttributesCommandAttributes getUpsertWorkflowSearchAttributesCommandAttributes()
        .temporal.api.command.v1.UpsertWorkflowSearchAttributesCommandAttributes upsert_workflow_search_attributes_command_attributes = 14;
        Returns:
        The upsertWorkflowSearchAttributesCommandAttributes.

      • getUpsertWorkflowSearchAttributesCommandAttributesOrBuilder

        UpsertWorkflowSearchAttributesCommandAttributesOrBuilder getUpsertWorkflowSearchAttributesCommandAttributesOrBuilder()
        .temporal.api.command.v1.UpsertWorkflowSearchAttributesCommandAttributes upsert_workflow_search_attributes_command_attributes = 14;

      • hasProtocolMessageCommandAttributes

        boolean hasProtocolMessageCommandAttributes()
        .temporal.api.command.v1.ProtocolMessageCommandAttributes protocol_message_command_attributes = 15;
        Returns:
        Whether the protocolMessageCommandAttributes field is set.

      • getProtocolMessageCommandAttributes

        ProtocolMessageCommandAttributes getProtocolMessageCommandAttributes()
        .temporal.api.command.v1.ProtocolMessageCommandAttributes protocol_message_command_attributes = 15;
        Returns:
        The protocolMessageCommandAttributes.

      • getProtocolMessageCommandAttributesOrBuilder

        ProtocolMessageCommandAttributesOrBuilder getProtocolMessageCommandAttributesOrBuilder()
        .temporal.api.command.v1.ProtocolMessageCommandAttributes protocol_message_command_attributes = 15;

      • hasModifyWorkflowPropertiesCommandAttributes

        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;
        Returns:
        Whether the modifyWorkflowPropertiesCommandAttributes field is set.

      • getModifyWorkflowPropertiesCommandAttributes

        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;
        Returns:
        The modifyWorkflowPropertiesCommandAttributes.

      • getModifyWorkflowPropertiesCommandAttributesOrBuilder

        ModifyWorkflowPropertiesCommandAttributesOrBuilder getModifyWorkflowPropertiesCommandAttributesOrBuilder()
         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;

      • hasScheduleNexusOperationCommandAttributes

        boolean hasScheduleNexusOperationCommandAttributes()
        .temporal.api.command.v1.ScheduleNexusOperationCommandAttributes schedule_nexus_operation_command_attributes = 18;
        Returns:
        Whether the scheduleNexusOperationCommandAttributes field is set.

      • getScheduleNexusOperationCommandAttributes

        ScheduleNexusOperationCommandAttributes getScheduleNexusOperationCommandAttributes()
        .temporal.api.command.v1.ScheduleNexusOperationCommandAttributes schedule_nexus_operation_command_attributes = 18;
        Returns:
        The scheduleNexusOperationCommandAttributes.

      • getScheduleNexusOperationCommandAttributesOrBuilder

        ScheduleNexusOperationCommandAttributesOrBuilder getScheduleNexusOperationCommandAttributesOrBuilder()
        .temporal.api.command.v1.ScheduleNexusOperationCommandAttributes schedule_nexus_operation_command_attributes = 18;

      • hasRequestCancelNexusOperationCommandAttributes

        boolean hasRequestCancelNexusOperationCommandAttributes()
        .temporal.api.command.v1.RequestCancelNexusOperationCommandAttributes request_cancel_nexus_operation_command_attributes = 19;
        Returns:
        Whether the requestCancelNexusOperationCommandAttributes field is set.

      • getRequestCancelNexusOperationCommandAttributes

        RequestCancelNexusOperationCommandAttributes getRequestCancelNexusOperationCommandAttributes()
        .temporal.api.command.v1.RequestCancelNexusOperationCommandAttributes request_cancel_nexus_operation_command_attributes = 19;
        Returns:
        The requestCancelNexusOperationCommandAttributes.

      • getRequestCancelNexusOperationCommandAttributesOrBuilder

        RequestCancelNexusOperationCommandAttributesOrBuilder getRequestCancelNexusOperationCommandAttributesOrBuilder()
        .temporal.api.command.v1.RequestCancelNexusOperationCommandAttributes request_cancel_nexus_operation_command_attributes = 19;