Class StartWorkflowExecutionRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.temporal.api.workflowservice.v1.StartWorkflowExecutionRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, StartWorkflowExecutionRequestOrBuilder, 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:

  • Field Details

    • NAMESPACE_FIELD_NUMBER

      public static final int NAMESPACE_FIELD_NUMBER
      See Also:

    • WORKFLOW_ID_FIELD_NUMBER

      public static final int WORKFLOW_ID_FIELD_NUMBER
      See Also:

    • WORKFLOW_TYPE_FIELD_NUMBER

      public static final int WORKFLOW_TYPE_FIELD_NUMBER
      See Also:

    • TASK_QUEUE_FIELD_NUMBER

      public static final int TASK_QUEUE_FIELD_NUMBER
      See Also:

    • INPUT_FIELD_NUMBER

      public static final int INPUT_FIELD_NUMBER
      See Also:

    • WORKFLOW_EXECUTION_TIMEOUT_FIELD_NUMBER

      public static final int WORKFLOW_EXECUTION_TIMEOUT_FIELD_NUMBER
      See Also:

    • WORKFLOW_RUN_TIMEOUT_FIELD_NUMBER

      public static final int WORKFLOW_RUN_TIMEOUT_FIELD_NUMBER
      See Also:

    • WORKFLOW_TASK_TIMEOUT_FIELD_NUMBER

      public static final int WORKFLOW_TASK_TIMEOUT_FIELD_NUMBER
      See Also:

    • IDENTITY_FIELD_NUMBER

      public static final int IDENTITY_FIELD_NUMBER
      See Also:

    • REQUEST_ID_FIELD_NUMBER

      public static final int REQUEST_ID_FIELD_NUMBER
      See Also:

    • WORKFLOW_ID_REUSE_POLICY_FIELD_NUMBER

      public static final int WORKFLOW_ID_REUSE_POLICY_FIELD_NUMBER
      See Also:

    • WORKFLOW_ID_CONFLICT_POLICY_FIELD_NUMBER

      public static final int WORKFLOW_ID_CONFLICT_POLICY_FIELD_NUMBER
      See Also:

    • RETRY_POLICY_FIELD_NUMBER

      public static final int RETRY_POLICY_FIELD_NUMBER
      See Also:

    • CRON_SCHEDULE_FIELD_NUMBER

      public static final int CRON_SCHEDULE_FIELD_NUMBER
      See Also:

    • MEMO_FIELD_NUMBER

      public static final int MEMO_FIELD_NUMBER
      See Also:

    • SEARCH_ATTRIBUTES_FIELD_NUMBER

      public static final int SEARCH_ATTRIBUTES_FIELD_NUMBER
      See Also:

    • HEADER_FIELD_NUMBER

      public static final int HEADER_FIELD_NUMBER
      See Also:

    • REQUEST_EAGER_EXECUTION_FIELD_NUMBER

      public static final int REQUEST_EAGER_EXECUTION_FIELD_NUMBER
      See Also:

    • CONTINUED_FAILURE_FIELD_NUMBER

      public static final int CONTINUED_FAILURE_FIELD_NUMBER
      See Also:

    • LAST_COMPLETION_RESULT_FIELD_NUMBER

      public static final int LAST_COMPLETION_RESULT_FIELD_NUMBER
      See Also:

    • WORKFLOW_START_DELAY_FIELD_NUMBER

      public static final int WORKFLOW_START_DELAY_FIELD_NUMBER
      See Also:

    • COMPLETION_CALLBACKS_FIELD_NUMBER

      public static final int COMPLETION_CALLBACKS_FIELD_NUMBER
      See Also:

    • USER_METADATA_FIELD_NUMBER

      public static final int USER_METADATA_FIELD_NUMBER
      See Also:

    • VERSIONING_OVERRIDE_FIELD_NUMBER

      public static final int VERSIONING_OVERRIDE_FIELD_NUMBER
      See Also:

    • ON_CONFLICT_OPTIONS_FIELD_NUMBER

      public static final int ON_CONFLICT_OPTIONS_FIELD_NUMBER
      See Also:

    • PRIORITY_FIELD_NUMBER

      public static final int PRIORITY_FIELD_NUMBER
      See Also:

    • EAGER_WORKER_DEPLOYMENT_OPTIONS_FIELD_NUMBER

      public static final int EAGER_WORKER_DEPLOYMENT_OPTIONS_FIELD_NUMBER
      See Also:

    • TIME_SKIPPING_CONFIG_FIELD_NUMBER

      public static final int TIME_SKIPPING_CONFIG_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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

    • getNamespace

      public String getNamespace()
      string namespace = 1;
      Specified by:
      getNamespace in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      The namespace.

    • getNamespaceBytes

      public com.google.protobuf.ByteString getNamespaceBytes()
      string namespace = 1;
      Specified by:
      getNamespaceBytes in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      The bytes for namespace.

    • getWorkflowId

      public String getWorkflowId()
      string workflow_id = 2;
      Specified by:
      getWorkflowId in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      The workflowId.

    • getWorkflowIdBytes

      public com.google.protobuf.ByteString getWorkflowIdBytes()
      string workflow_id = 2;
      Specified by:
      getWorkflowIdBytes in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      The bytes for workflowId.

    • hasWorkflowType

      public boolean hasWorkflowType()
      .temporal.api.common.v1.WorkflowType workflow_type = 3;
      Specified by:
      hasWorkflowType in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      Whether the workflowType field is set.

    • getWorkflowType

      public WorkflowType getWorkflowType()
      .temporal.api.common.v1.WorkflowType workflow_type = 3;
      Specified by:
      getWorkflowType in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      The workflowType.

    • getWorkflowTypeOrBuilder

      public WorkflowTypeOrBuilder getWorkflowTypeOrBuilder()
      .temporal.api.common.v1.WorkflowType workflow_type = 3;
      Specified by:
      getWorkflowTypeOrBuilder in interface StartWorkflowExecutionRequestOrBuilder

    • hasTaskQueue

      public boolean hasTaskQueue()
      .temporal.api.taskqueue.v1.TaskQueue task_queue = 4;
      Specified by:
      hasTaskQueue in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      Whether the taskQueue field is set.

    • getTaskQueue

      public TaskQueue getTaskQueue()
      .temporal.api.taskqueue.v1.TaskQueue task_queue = 4;
      Specified by:
      getTaskQueue in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      The taskQueue.

    • getTaskQueueOrBuilder

      public TaskQueueOrBuilder getTaskQueueOrBuilder()
      .temporal.api.taskqueue.v1.TaskQueue task_queue = 4;
      Specified by:
      getTaskQueueOrBuilder in interface StartWorkflowExecutionRequestOrBuilder

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

    • getInputOrBuilder

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

    • hasWorkflowExecutionTimeout

      public boolean hasWorkflowExecutionTimeout()
       Total workflow execution timeout including retries and continue as new.
      .google.protobuf.Duration workflow_execution_timeout = 6;
      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;
      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;
      Specified by:
      getWorkflowExecutionTimeoutOrBuilder in interface StartWorkflowExecutionRequestOrBuilder

    • hasWorkflowRunTimeout

      public boolean hasWorkflowRunTimeout()
       Timeout of a single workflow run.
      .google.protobuf.Duration workflow_run_timeout = 7;
      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;
      Specified by:
      getWorkflowRunTimeout in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      The workflowRunTimeout.

    • getWorkflowRunTimeoutOrBuilder

      public com.google.protobuf.DurationOrBuilder getWorkflowRunTimeoutOrBuilder()
       Timeout of a single workflow run.
      .google.protobuf.Duration workflow_run_timeout = 7;
      Specified by:
      getWorkflowRunTimeoutOrBuilder in interface StartWorkflowExecutionRequestOrBuilder

    • hasWorkflowTaskTimeout

      public boolean hasWorkflowTaskTimeout()
       Timeout of a single workflow task.
      .google.protobuf.Duration workflow_task_timeout = 8;
      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;
      Specified by:
      getWorkflowTaskTimeout in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      The workflowTaskTimeout.

    • getWorkflowTaskTimeoutOrBuilder

      public com.google.protobuf.DurationOrBuilder getWorkflowTaskTimeoutOrBuilder()
       Timeout of a single workflow task.
      .google.protobuf.Duration workflow_task_timeout = 8;
      Specified by:
      getWorkflowTaskTimeoutOrBuilder in interface StartWorkflowExecutionRequestOrBuilder

    • getIdentity

      public String getIdentity()
       The identity of the client who initiated this request
      string identity = 9;
      Specified by:
      getIdentity in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      The identity.

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

    • getRequestId

      public String getRequestId()
       A unique identifier for this start request. Typically UUIDv4.
      string request_id = 10;
      Specified by:
      getRequestId in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      The requestId.

    • 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()
       Defines whether to allow re-using the workflow id from a previously *closed* workflow.
 The default policy is WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.

 See `workflow_id_conflict_policy` for handling a workflow id duplication with a *running* workflow.
      .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.

    • getWorkflowIdReusePolicy

      public WorkflowIdReusePolicy getWorkflowIdReusePolicy()
       Defines whether to allow re-using the workflow id from a previously *closed* workflow.
 The default policy is WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.

 See `workflow_id_conflict_policy` for handling a workflow id duplication with a *running* workflow.
      .temporal.api.enums.v1.WorkflowIdReusePolicy workflow_id_reuse_policy = 11;
      Specified by:
      getWorkflowIdReusePolicy in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      The workflowIdReusePolicy.

    • getWorkflowIdConflictPolicyValue

      public int getWorkflowIdConflictPolicyValue()
       Defines how to resolve a workflow id conflict with a *running* workflow.
 The default policy is WORKFLOW_ID_CONFLICT_POLICY_FAIL.

 See `workflow_id_reuse_policy` for handling a workflow id duplication with a *closed* workflow.
      .temporal.api.enums.v1.WorkflowIdConflictPolicy workflow_id_conflict_policy = 22;
      Specified by:
      getWorkflowIdConflictPolicyValue in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      The enum numeric value on the wire for workflowIdConflictPolicy.

    • getWorkflowIdConflictPolicy

      public WorkflowIdConflictPolicy getWorkflowIdConflictPolicy()
       Defines how to resolve a workflow id conflict with a *running* workflow.
 The default policy is WORKFLOW_ID_CONFLICT_POLICY_FAIL.

 See `workflow_id_reuse_policy` for handling a workflow id duplication with a *closed* workflow.
      .temporal.api.enums.v1.WorkflowIdConflictPolicy workflow_id_conflict_policy = 22;
      Specified by:
      getWorkflowIdConflictPolicy in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      The workflowIdConflictPolicy.

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

    • getRetryPolicy

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

    • getRetryPolicyOrBuilder

      public RetryPolicyOrBuilder getRetryPolicyOrBuilder()
       The retry policy for the workflow. Will never exceed `workflow_execution_timeout`.
      .temporal.api.common.v1.RetryPolicy retry_policy = 12;
      Specified by:
      getRetryPolicyOrBuilder in interface StartWorkflowExecutionRequestOrBuilder

    • getCronSchedule

      public 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.

    • hasMemo

      public boolean hasMemo()
      .temporal.api.common.v1.Memo memo = 14;
      Specified by:
      hasMemo in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      Whether the memo field is set.

    • getMemo

      public Memo getMemo()
      .temporal.api.common.v1.Memo memo = 14;
      Specified by:
      getMemo in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      The memo.

    • getMemoOrBuilder

      public MemoOrBuilder getMemoOrBuilder()
      .temporal.api.common.v1.Memo memo = 14;
      Specified by:
      getMemoOrBuilder in interface StartWorkflowExecutionRequestOrBuilder

    • hasSearchAttributes

      public boolean hasSearchAttributes()
      .temporal.api.common.v1.SearchAttributes search_attributes = 15;
      Specified by:
      hasSearchAttributes in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      Whether the searchAttributes field is set.

    • getSearchAttributes

      public SearchAttributes getSearchAttributes()
      .temporal.api.common.v1.SearchAttributes search_attributes = 15;
      Specified by:
      getSearchAttributes in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      The searchAttributes.

    • getSearchAttributesOrBuilder

      public SearchAttributesOrBuilder getSearchAttributesOrBuilder()
      .temporal.api.common.v1.SearchAttributes search_attributes = 15;
      Specified by:
      getSearchAttributesOrBuilder in interface StartWorkflowExecutionRequestOrBuilder

    • hasHeader

      public boolean hasHeader()
      .temporal.api.common.v1.Header header = 16;
      Specified by:
      hasHeader in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      Whether the header field is set.

    • getHeader

      public Header getHeader()
      .temporal.api.common.v1.Header header = 16;
      Specified by:
      getHeader in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      The header.

    • getHeaderOrBuilder

      public HeaderOrBuilder getHeaderOrBuilder()
      .temporal.api.common.v1.Header header = 16;
      Specified by:
      getHeaderOrBuilder in interface StartWorkflowExecutionRequestOrBuilder

    • 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

    • hasLastCompletionResult

      public boolean hasLastCompletionResult()
      .temporal.api.common.v1.Payloads last_completion_result = 19;
      Specified by:
      hasLastCompletionResult in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      Whether the lastCompletionResult field is set.

    • getLastCompletionResult

      public Payloads getLastCompletionResult()
      .temporal.api.common.v1.Payloads last_completion_result = 19;
      Specified by:
      getLastCompletionResult in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      The lastCompletionResult.

    • getLastCompletionResultOrBuilder

      public PayloadsOrBuilder getLastCompletionResultOrBuilder()
      .temporal.api.common.v1.Payloads last_completion_result = 19;
      Specified by:
      getLastCompletionResultOrBuilder in interface StartWorkflowExecutionRequestOrBuilder

    • hasWorkflowStartDelay

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

    • getWorkflowStartDelay

      public com.google.protobuf.Duration getWorkflowStartDelay()
       Time to wait before making the first workflow task available for dispatch. Cannot be used with `cron_schedule`.
 If the workflow gets a signal before the delay, a workflow task will be made available for dispatch and the rest
 of the delay will be ignored.
      .google.protobuf.Duration workflow_start_delay = 20;
      Specified by:
      getWorkflowStartDelay in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      The workflowStartDelay.

    • getWorkflowStartDelayOrBuilder

      public com.google.protobuf.DurationOrBuilder getWorkflowStartDelayOrBuilder()
       Time to wait before making the first workflow task available for dispatch. Cannot be used with `cron_schedule`.
 If the workflow gets a signal before the delay, a workflow task will be made available for dispatch and the rest
 of the delay will be ignored.
      .google.protobuf.Duration workflow_start_delay = 20;
      Specified by:
      getWorkflowStartDelayOrBuilder in interface StartWorkflowExecutionRequestOrBuilder

    • getCompletionCallbacksList

      public List<Callback> getCompletionCallbacksList()
       Callbacks to be called by the server when this workflow reaches a terminal state.
 If the workflow continues-as-new, these callbacks will be carried over to the new execution.
 Callback addresses must be whitelisted in the server's dynamic configuration.
      repeated .temporal.api.common.v1.Callback completion_callbacks = 21;
      Specified by:
      getCompletionCallbacksList in interface StartWorkflowExecutionRequestOrBuilder

    • getCompletionCallbacksOrBuilderList

      public List<? extends CallbackOrBuilder> getCompletionCallbacksOrBuilderList()
       Callbacks to be called by the server when this workflow reaches a terminal state.
 If the workflow continues-as-new, these callbacks will be carried over to the new execution.
 Callback addresses must be whitelisted in the server's dynamic configuration.
      repeated .temporal.api.common.v1.Callback completion_callbacks = 21;
      Specified by:
      getCompletionCallbacksOrBuilderList in interface StartWorkflowExecutionRequestOrBuilder

    • getCompletionCallbacksCount

      public int getCompletionCallbacksCount()
       Callbacks to be called by the server when this workflow reaches a terminal state.
 If the workflow continues-as-new, these callbacks will be carried over to the new execution.
 Callback addresses must be whitelisted in the server's dynamic configuration.
      repeated .temporal.api.common.v1.Callback completion_callbacks = 21;
      Specified by:
      getCompletionCallbacksCount in interface StartWorkflowExecutionRequestOrBuilder

    • getCompletionCallbacks

      public Callback getCompletionCallbacks(int index)
       Callbacks to be called by the server when this workflow reaches a terminal state.
 If the workflow continues-as-new, these callbacks will be carried over to the new execution.
 Callback addresses must be whitelisted in the server's dynamic configuration.
      repeated .temporal.api.common.v1.Callback completion_callbacks = 21;
      Specified by:
      getCompletionCallbacks in interface StartWorkflowExecutionRequestOrBuilder

    • getCompletionCallbacksOrBuilder

      public CallbackOrBuilder getCompletionCallbacksOrBuilder(int index)
       Callbacks to be called by the server when this workflow reaches a terminal state.
 If the workflow continues-as-new, these callbacks will be carried over to the new execution.
 Callback addresses must be whitelisted in the server's dynamic configuration.
      repeated .temporal.api.common.v1.Callback completion_callbacks = 21;
      Specified by:
      getCompletionCallbacksOrBuilder in interface StartWorkflowExecutionRequestOrBuilder

    • hasUserMetadata

      public boolean hasUserMetadata()
       Metadata on the workflow if it is started. This is carried over to the WorkflowExecutionInfo
 for use by user interfaces to display the fixed as-of-start summary and details of the
 workflow.
      .temporal.api.sdk.v1.UserMetadata user_metadata = 23;
      Specified by:
      hasUserMetadata in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      Whether the userMetadata field is set.

    • getUserMetadata

      public UserMetadata getUserMetadata()
       Metadata on the workflow if it is started. This is carried over to the WorkflowExecutionInfo
 for use by user interfaces to display the fixed as-of-start summary and details of the
 workflow.
      .temporal.api.sdk.v1.UserMetadata user_metadata = 23;
      Specified by:
      getUserMetadata in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      The userMetadata.

    • getUserMetadataOrBuilder

      public UserMetadataOrBuilder getUserMetadataOrBuilder()
       Metadata on the workflow if it is started. This is carried over to the WorkflowExecutionInfo
 for use by user interfaces to display the fixed as-of-start summary and details of the
 workflow.
      .temporal.api.sdk.v1.UserMetadata user_metadata = 23;
      Specified by:
      getUserMetadataOrBuilder in interface StartWorkflowExecutionRequestOrBuilder

    • getLinksList

      public List<Link> getLinksList()
       Links to be associated with the workflow.
      repeated .temporal.api.common.v1.Link links = 24;
      Specified by:
      getLinksList in interface StartWorkflowExecutionRequestOrBuilder

    • getLinksOrBuilderList

      public List<? extends LinkOrBuilder> getLinksOrBuilderList()
       Links to be associated with the workflow.
      repeated .temporal.api.common.v1.Link links = 24;
      Specified by:
      getLinksOrBuilderList in interface StartWorkflowExecutionRequestOrBuilder

    • getLinksCount

      public int getLinksCount()
       Links to be associated with the workflow.
      repeated .temporal.api.common.v1.Link links = 24;
      Specified by:
      getLinksCount in interface StartWorkflowExecutionRequestOrBuilder

    • getLinks

      public Link getLinks(int index)
       Links to be associated with the workflow.
      repeated .temporal.api.common.v1.Link links = 24;
      Specified by:
      getLinks in interface StartWorkflowExecutionRequestOrBuilder

    • getLinksOrBuilder

      public LinkOrBuilder getLinksOrBuilder(int index)
       Links to be associated with the workflow.
      repeated .temporal.api.common.v1.Link links = 24;
      Specified by:
      getLinksOrBuilder in interface StartWorkflowExecutionRequestOrBuilder

    • hasVersioningOverride

      public boolean hasVersioningOverride()
       If set, takes precedence over the Versioning Behavior sent by the SDK on Workflow Task completion.
 To unset the override after the workflow is running, use UpdateWorkflowExecutionOptions.
      .temporal.api.workflow.v1.VersioningOverride versioning_override = 25;
      Specified by:
      hasVersioningOverride in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      Whether the versioningOverride field is set.

    • getVersioningOverride

      public VersioningOverride getVersioningOverride()
       If set, takes precedence over the Versioning Behavior sent by the SDK on Workflow Task completion.
 To unset the override after the workflow is running, use UpdateWorkflowExecutionOptions.
      .temporal.api.workflow.v1.VersioningOverride versioning_override = 25;
      Specified by:
      getVersioningOverride in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      The versioningOverride.

    • getVersioningOverrideOrBuilder

      public VersioningOverrideOrBuilder getVersioningOverrideOrBuilder()
       If set, takes precedence over the Versioning Behavior sent by the SDK on Workflow Task completion.
 To unset the override after the workflow is running, use UpdateWorkflowExecutionOptions.
      .temporal.api.workflow.v1.VersioningOverride versioning_override = 25;
      Specified by:
      getVersioningOverrideOrBuilder in interface StartWorkflowExecutionRequestOrBuilder

    • hasOnConflictOptions

      public boolean hasOnConflictOptions()
       Defines actions to be done to the existing running workflow when the conflict policy
 WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING is used. If not set (ie., nil value) or set to a
 empty object (ie., all options with default value), it won't do anything to the existing
 running workflow. If set, it will add a history event to the running workflow.
      .temporal.api.workflow.v1.OnConflictOptions on_conflict_options = 26;
      Specified by:
      hasOnConflictOptions in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      Whether the onConflictOptions field is set.

    • getOnConflictOptions

      public OnConflictOptions getOnConflictOptions()
       Defines actions to be done to the existing running workflow when the conflict policy
 WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING is used. If not set (ie., nil value) or set to a
 empty object (ie., all options with default value), it won't do anything to the existing
 running workflow. If set, it will add a history event to the running workflow.
      .temporal.api.workflow.v1.OnConflictOptions on_conflict_options = 26;
      Specified by:
      getOnConflictOptions in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      The onConflictOptions.

    • getOnConflictOptionsOrBuilder

      public OnConflictOptionsOrBuilder getOnConflictOptionsOrBuilder()
       Defines actions to be done to the existing running workflow when the conflict policy
 WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING is used. If not set (ie., nil value) or set to a
 empty object (ie., all options with default value), it won't do anything to the existing
 running workflow. If set, it will add a history event to the running workflow.
      .temporal.api.workflow.v1.OnConflictOptions on_conflict_options = 26;
      Specified by:
      getOnConflictOptionsOrBuilder in interface StartWorkflowExecutionRequestOrBuilder

    • hasPriority

      public boolean hasPriority()
       Priority metadata
      .temporal.api.common.v1.Priority priority = 27;
      Specified by:
      hasPriority in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      Whether the priority field is set.

    • getPriority

      public Priority getPriority()
       Priority metadata
      .temporal.api.common.v1.Priority priority = 27;
      Specified by:
      getPriority in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      The priority.

    • getPriorityOrBuilder

      public PriorityOrBuilder getPriorityOrBuilder()
       Priority metadata
      .temporal.api.common.v1.Priority priority = 27;
      Specified by:
      getPriorityOrBuilder in interface StartWorkflowExecutionRequestOrBuilder

    • hasEagerWorkerDeploymentOptions

      public boolean hasEagerWorkerDeploymentOptions()
       Deployment Options of the worker who will process the eager task. Passed when `request_eager_execution=true`.
      .temporal.api.deployment.v1.WorkerDeploymentOptions eager_worker_deployment_options = 28;
      Specified by:
      hasEagerWorkerDeploymentOptions in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      Whether the eagerWorkerDeploymentOptions field is set.

    • getEagerWorkerDeploymentOptions

      public WorkerDeploymentOptions getEagerWorkerDeploymentOptions()
       Deployment Options of the worker who will process the eager task. Passed when `request_eager_execution=true`.
      .temporal.api.deployment.v1.WorkerDeploymentOptions eager_worker_deployment_options = 28;
      Specified by:
      getEagerWorkerDeploymentOptions in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      The eagerWorkerDeploymentOptions.

    • getEagerWorkerDeploymentOptionsOrBuilder

      public WorkerDeploymentOptionsOrBuilder getEagerWorkerDeploymentOptionsOrBuilder()
       Deployment Options of the worker who will process the eager task. Passed when `request_eager_execution=true`.
      .temporal.api.deployment.v1.WorkerDeploymentOptions eager_worker_deployment_options = 28;
      Specified by:
      getEagerWorkerDeploymentOptionsOrBuilder in interface StartWorkflowExecutionRequestOrBuilder

    • hasTimeSkippingConfig

      public boolean hasTimeSkippingConfig()
       Time-skipping configuration. If not set, time skipping is disabled.
      .temporal.api.common.v1.TimeSkippingConfig time_skipping_config = 29;
      Specified by:
      hasTimeSkippingConfig in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      Whether the timeSkippingConfig field is set.

    • getTimeSkippingConfig

      public TimeSkippingConfig getTimeSkippingConfig()
       Time-skipping configuration. If not set, time skipping is disabled.
      .temporal.api.common.v1.TimeSkippingConfig time_skipping_config = 29;
      Specified by:
      getTimeSkippingConfig in interface StartWorkflowExecutionRequestOrBuilder
      Returns:
      The timeSkippingConfig.

    • getTimeSkippingConfigOrBuilder

      public TimeSkippingConfigOrBuilder getTimeSkippingConfigOrBuilder()
       Time-skipping configuration. If not set, time skipping is disabled.
      .temporal.api.common.v1.TimeSkippingConfig time_skipping_config = 29;
      Specified by:
      getTimeSkippingConfigOrBuilder 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      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(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(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static StartWorkflowExecutionRequest parseFrom(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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static StartWorkflowExecutionRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static StartWorkflowExecutionRequest.Builder newBuilder()

    • newBuilder

      public static StartWorkflowExecutionRequest.Builder newBuilder(StartWorkflowExecutionRequest prototype)

    • 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

    • getDefaultInstance

      public static StartWorkflowExecutionRequest getDefaultInstance()

    • parser

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

    • 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