Package io.temporal.api.workflowservice.v1

Class StartWorkflowExecutionRequest

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

    • Field Detail

      • WORKFLOW_ID_FIELD_NUMBER

        public static final int WORKFLOW_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WORKFLOW_TYPE_FIELD_NUMBER

        public static final int WORKFLOW_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TASK_QUEUE_FIELD_NUMBER

        public static final int TASK_QUEUE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WORKFLOW_EXECUTION_TIMEOUT_FIELD_NUMBER

        public static final int WORKFLOW_EXECUTION_TIMEOUT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WORKFLOW_RUN_TIMEOUT_FIELD_NUMBER

        public static final int WORKFLOW_RUN_TIMEOUT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WORKFLOW_TASK_TIMEOUT_FIELD_NUMBER

        public static final int WORKFLOW_TASK_TIMEOUT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REQUEST_ID_FIELD_NUMBER

        public static final int REQUEST_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WORKFLOW_ID_REUSE_POLICY_FIELD_NUMBER

        public static final int WORKFLOW_ID_REUSE_POLICY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RETRY_POLICY_FIELD_NUMBER

        public static final int RETRY_POLICY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CRON_SCHEDULE_FIELD_NUMBER

        public static final int CRON_SCHEDULE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SEARCH_ATTRIBUTES_FIELD_NUMBER

        public static final int SEARCH_ATTRIBUTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • REQUEST_EAGER_EXECUTION_FIELD_NUMBER

        public static final int REQUEST_EAGER_EXECUTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CONTINUED_FAILURE_FIELD_NUMBER

        public static final int CONTINUED_FAILURE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • LAST_COMPLETION_RESULT_FIELD_NUMBER

        public static final int LAST_COMPLETION_RESULT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WORKFLOW_START_DELAY_FIELD_NUMBER

        public static final int WORKFLOW_START_DELAY_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

      • hasInput

        public boolean hasInput()
         Serialized arguments to the workflow. These are passed as arguments to the workflow function.
        .temporal.api.common.v1.Payloads input = 5;
        Specified by:
        hasInput in interface StartWorkflowExecutionRequestOrBuilder
        Returns:
        Whether the input field is set.

      • getInput

        public Payloads getInput()
         Serialized arguments to the workflow. These are passed as arguments to the workflow function.
        .temporal.api.common.v1.Payloads input = 5;
        Specified by:
        getInput in interface StartWorkflowExecutionRequestOrBuilder
        Returns:
        The input.

      • hasWorkflowExecutionTimeout

        public boolean hasWorkflowExecutionTimeout()
         Total workflow execution timeout including retries and continue as new.
        .google.protobuf.Duration workflow_execution_timeout = 6 [(.gogoproto.stdduration) = true];
        Specified by:
        hasWorkflowExecutionTimeout in interface StartWorkflowExecutionRequestOrBuilder
        Returns:
        Whether the workflowExecutionTimeout field is set.

      • getWorkflowExecutionTimeout

        public com.google.protobuf.Duration getWorkflowExecutionTimeout()
         Total workflow execution timeout including retries and continue as new.
        .google.protobuf.Duration workflow_execution_timeout = 6 [(.gogoproto.stdduration) = true];
        Specified by:
        getWorkflowExecutionTimeout in interface StartWorkflowExecutionRequestOrBuilder
        Returns:
        The workflowExecutionTimeout.

      • getWorkflowExecutionTimeoutOrBuilder

        public com.google.protobuf.DurationOrBuilder getWorkflowExecutionTimeoutOrBuilder()
         Total workflow execution timeout including retries and continue as new.
        .google.protobuf.Duration workflow_execution_timeout = 6 [(.gogoproto.stdduration) = true];
        Specified by:
        getWorkflowExecutionTimeoutOrBuilder in interface StartWorkflowExecutionRequestOrBuilder

      • hasWorkflowRunTimeout

        public boolean hasWorkflowRunTimeout()
         Timeout of a single workflow run.
        .google.protobuf.Duration workflow_run_timeout = 7 [(.gogoproto.stdduration) = true];
        Specified by:
        hasWorkflowRunTimeout in interface StartWorkflowExecutionRequestOrBuilder
        Returns:
        Whether the workflowRunTimeout field is set.

      • getWorkflowRunTimeout

        public com.google.protobuf.Duration getWorkflowRunTimeout()
         Timeout of a single workflow run.
        .google.protobuf.Duration workflow_run_timeout = 7 [(.gogoproto.stdduration) = true];
        Specified by:
        getWorkflowRunTimeout in interface StartWorkflowExecutionRequestOrBuilder
        Returns:
        The workflowRunTimeout.

      • hasWorkflowTaskTimeout

        public boolean hasWorkflowTaskTimeout()
         Timeout of a single workflow task.
        .google.protobuf.Duration workflow_task_timeout = 8 [(.gogoproto.stdduration) = true];
        Specified by:
        hasWorkflowTaskTimeout in interface StartWorkflowExecutionRequestOrBuilder
        Returns:
        Whether the workflowTaskTimeout field is set.

      • getWorkflowTaskTimeout

        public com.google.protobuf.Duration getWorkflowTaskTimeout()
         Timeout of a single workflow task.
        .google.protobuf.Duration workflow_task_timeout = 8 [(.gogoproto.stdduration) = true];
        Specified by:
        getWorkflowTaskTimeout in interface StartWorkflowExecutionRequestOrBuilder
        Returns:
        The workflowTaskTimeout.

      • getIdentityBytes

        public com.google.protobuf.ByteString getIdentityBytes()
         The identity of the client who initiated this request
        string identity = 9;
        Specified by:
        getIdentityBytes in interface StartWorkflowExecutionRequestOrBuilder
        Returns:
        The bytes for identity.

      • getRequestIdBytes

        public com.google.protobuf.ByteString getRequestIdBytes()
         A unique identifier for this start request. Typically UUIDv4.
        string request_id = 10;
        Specified by:
        getRequestIdBytes in interface StartWorkflowExecutionRequestOrBuilder
        Returns:
        The bytes for requestId.

      • getWorkflowIdReusePolicyValue

        public int getWorkflowIdReusePolicyValue()
         Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.
        .temporal.api.enums.v1.WorkflowIdReusePolicy workflow_id_reuse_policy = 11;
        Specified by:
        getWorkflowIdReusePolicyValue in interface StartWorkflowExecutionRequestOrBuilder
        Returns:
        The enum numeric value on the wire for workflowIdReusePolicy.

      • hasRetryPolicy

        public boolean hasRetryPolicy()
         The retry policy for the workflow. Will never exceed `workflow_execution_timeout`.
        .temporal.api.common.v1.RetryPolicy retry_policy = 12;
        Specified by:
        hasRetryPolicy in interface StartWorkflowExecutionRequestOrBuilder
        Returns:
        Whether the retryPolicy field is set.

      • getCronSchedule

        public java.lang.String getCronSchedule()
         See https://docs.temporal.io/docs/content/what-is-a-temporal-cron-job/
        string cron_schedule = 13;
        Specified by:
        getCronSchedule in interface StartWorkflowExecutionRequestOrBuilder
        Returns:
        The cronSchedule.

      • getCronScheduleBytes

        public com.google.protobuf.ByteString getCronScheduleBytes()
         See https://docs.temporal.io/docs/content/what-is-a-temporal-cron-job/
        string cron_schedule = 13;
        Specified by:
        getCronScheduleBytes in interface StartWorkflowExecutionRequestOrBuilder
        Returns:
        The bytes for cronSchedule.

      • getRequestEagerExecution

        public boolean getRequestEagerExecution()
         Request to get the first workflow task inline in the response bypassing matching service and worker polling.
 If set to `true` the caller is expected to have a worker available and capable of processing the task.
 The returned task will be marked as started and is expected to be completed by the specified
 `workflow_task_timeout`.
        bool request_eager_execution = 17;
        Specified by:
        getRequestEagerExecution in interface StartWorkflowExecutionRequestOrBuilder
        Returns:
        The requestEagerExecution.

      • hasContinuedFailure

        public boolean hasContinuedFailure()
         These values will be available as ContinuedFailure and LastCompletionResult in the
 WorkflowExecutionStarted event and through SDKs. The are currently only used by the
 server itself (for the schedules feature) and are not intended to be exposed in
 StartWorkflowExecution.
        .temporal.api.failure.v1.Failure continued_failure = 18;
        Specified by:
        hasContinuedFailure in interface StartWorkflowExecutionRequestOrBuilder
        Returns:
        Whether the continuedFailure field is set.

      • getContinuedFailure

        public Failure getContinuedFailure()
         These values will be available as ContinuedFailure and LastCompletionResult in the
 WorkflowExecutionStarted event and through SDKs. The are currently only used by the
 server itself (for the schedules feature) and are not intended to be exposed in
 StartWorkflowExecution.
        .temporal.api.failure.v1.Failure continued_failure = 18;
        Specified by:
        getContinuedFailure in interface StartWorkflowExecutionRequestOrBuilder
        Returns:
        The continuedFailure.

      • getContinuedFailureOrBuilder

        public FailureOrBuilder getContinuedFailureOrBuilder()
         These values will be available as ContinuedFailure and LastCompletionResult in the
 WorkflowExecutionStarted event and through SDKs. The are currently only used by the
 server itself (for the schedules feature) and are not intended to be exposed in
 StartWorkflowExecution.
        .temporal.api.failure.v1.Failure continued_failure = 18;
        Specified by:
        getContinuedFailureOrBuilder in interface StartWorkflowExecutionRequestOrBuilder

      • hasWorkflowStartDelay

        public boolean hasWorkflowStartDelay()
         Time to wait before dispatching the first workflow task. Cannot be used with `cron_schedule`.
 If the workflow gets a signal before the delay, a workflow task will be dispatched and the rest
 of the delay will be ignored.
        .google.protobuf.Duration workflow_start_delay = 20 [(.gogoproto.stdduration) = true];
        Specified by:
        hasWorkflowStartDelay in interface StartWorkflowExecutionRequestOrBuilder
        Returns:
        Whether the workflowStartDelay field is set.

      • getWorkflowStartDelay

        public com.google.protobuf.Duration getWorkflowStartDelay()
         Time to wait before dispatching the first workflow task. Cannot be used with `cron_schedule`.
 If the workflow gets a signal before the delay, a workflow task will be dispatched and the rest
 of the delay will be ignored.
        .google.protobuf.Duration workflow_start_delay = 20 [(.gogoproto.stdduration) = true];
        Specified by:
        getWorkflowStartDelay in interface StartWorkflowExecutionRequestOrBuilder
        Returns:
        The workflowStartDelay.

      • getWorkflowStartDelayOrBuilder

        public com.google.protobuf.DurationOrBuilder getWorkflowStartDelayOrBuilder()
         Time to wait before dispatching the first workflow task. Cannot be used with `cron_schedule`.
 If the workflow gets a signal before the delay, a workflow task will be dispatched and the rest
 of the delay will be ignored.
        .google.protobuf.Duration workflow_start_delay = 20 [(.gogoproto.stdduration) = true];
        Specified by:
        getWorkflowStartDelayOrBuilder in interface StartWorkflowExecutionRequestOrBuilder

      • 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 StartWorkflowExecutionRequest parseFrom​(java.nio.ByteBuffer data)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

        public com.google.protobuf.Parser<StartWorkflowExecutionRequest> 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 StartWorkflowExecutionRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder