Package io.temporal.api.workflowservice.v1

Interface StartWorkflowExecutionRequestOrBuilder

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

    • Method Detail

      • getNamespace

        java.lang.String getNamespace()
        string namespace = 1;
        Returns:
        The namespace.

      • getNamespaceBytes

        com.google.protobuf.ByteString getNamespaceBytes()
        string namespace = 1;
        Returns:
        The bytes for namespace.

      • getWorkflowId

        java.lang.String getWorkflowId()
        string workflow_id = 2;
        Returns:
        The workflowId.

      • getWorkflowIdBytes

        com.google.protobuf.ByteString getWorkflowIdBytes()
        string workflow_id = 2;
        Returns:
        The bytes for workflowId.

      • hasWorkflowType

        boolean hasWorkflowType()
        .temporal.api.common.v1.WorkflowType workflow_type = 3;
        Returns:
        Whether the workflowType field is set.

      • getWorkflowType

        WorkflowType getWorkflowType()
        .temporal.api.common.v1.WorkflowType workflow_type = 3;
        Returns:
        The workflowType.

      • getWorkflowTypeOrBuilder

        WorkflowTypeOrBuilder getWorkflowTypeOrBuilder()
        .temporal.api.common.v1.WorkflowType workflow_type = 3;

      • hasTaskQueue

        boolean hasTaskQueue()
        .temporal.api.taskqueue.v1.TaskQueue task_queue = 4;
        Returns:
        Whether the taskQueue field is set.

      • getTaskQueue

        TaskQueue getTaskQueue()
        .temporal.api.taskqueue.v1.TaskQueue task_queue = 4;
        Returns:
        The taskQueue.

      • getTaskQueueOrBuilder

        TaskQueueOrBuilder getTaskQueueOrBuilder()
        .temporal.api.taskqueue.v1.TaskQueue task_queue = 4;

      • hasInput

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

      • getInput

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

      • getInputOrBuilder

        PayloadsOrBuilder getInputOrBuilder()
         Serialized arguments to the workflow. These are passed as arguments to the workflow function.
        .temporal.api.common.v1.Payloads input = 5;

      • hasWorkflowExecutionTimeout

        boolean hasWorkflowExecutionTimeout()
         Total workflow execution timeout including retries and continue as new.
        .google.protobuf.Duration workflow_execution_timeout = 6;
        Returns:
        Whether the workflowExecutionTimeout field is set.

      • getWorkflowExecutionTimeout

        com.google.protobuf.Duration getWorkflowExecutionTimeout()
         Total workflow execution timeout including retries and continue as new.
        .google.protobuf.Duration workflow_execution_timeout = 6;
        Returns:
        The workflowExecutionTimeout.

      • getWorkflowExecutionTimeoutOrBuilder

        com.google.protobuf.DurationOrBuilder getWorkflowExecutionTimeoutOrBuilder()
         Total workflow execution timeout including retries and continue as new.
        .google.protobuf.Duration workflow_execution_timeout = 6;

      • hasWorkflowRunTimeout

        boolean hasWorkflowRunTimeout()
         Timeout of a single workflow run.
        .google.protobuf.Duration workflow_run_timeout = 7;
        Returns:
        Whether the workflowRunTimeout field is set.

      • getWorkflowRunTimeout

        com.google.protobuf.Duration getWorkflowRunTimeout()
         Timeout of a single workflow run.
        .google.protobuf.Duration workflow_run_timeout = 7;
        Returns:
        The workflowRunTimeout.

      • getWorkflowRunTimeoutOrBuilder

        com.google.protobuf.DurationOrBuilder getWorkflowRunTimeoutOrBuilder()
         Timeout of a single workflow run.
        .google.protobuf.Duration workflow_run_timeout = 7;

      • hasWorkflowTaskTimeout

        boolean hasWorkflowTaskTimeout()
         Timeout of a single workflow task.
        .google.protobuf.Duration workflow_task_timeout = 8;
        Returns:
        Whether the workflowTaskTimeout field is set.

      • getWorkflowTaskTimeout

        com.google.protobuf.Duration getWorkflowTaskTimeout()
         Timeout of a single workflow task.
        .google.protobuf.Duration workflow_task_timeout = 8;
        Returns:
        The workflowTaskTimeout.

      • getWorkflowTaskTimeoutOrBuilder

        com.google.protobuf.DurationOrBuilder getWorkflowTaskTimeoutOrBuilder()
         Timeout of a single workflow task.
        .google.protobuf.Duration workflow_task_timeout = 8;

      • getIdentity

        java.lang.String getIdentity()
         The identity of the client who initiated this request
        string identity = 9;
        Returns:
        The identity.

      • getIdentityBytes

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

      • getRequestId

        java.lang.String getRequestId()
         A unique identifier for this start request. Typically UUIDv4.
        string request_id = 10;
        Returns:
        The requestId.

      • getRequestIdBytes

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

      • getWorkflowIdReusePolicyValue

        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;
        Returns:
        The enum numeric value on the wire for workflowIdReusePolicy.

      • getWorkflowIdReusePolicy

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

      • getWorkflowIdConflictPolicyValue

        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;
        Returns:
        The enum numeric value on the wire for workflowIdConflictPolicy.

      • getWorkflowIdConflictPolicy

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

      • hasRetryPolicy

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

      • getRetryPolicy

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

      • getRetryPolicyOrBuilder

        RetryPolicyOrBuilder getRetryPolicyOrBuilder()
         The retry policy for the workflow. Will never exceed `workflow_execution_timeout`.
        .temporal.api.common.v1.RetryPolicy retry_policy = 12;

      • getCronSchedule

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

      • getCronScheduleBytes

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

      • hasMemo

        boolean hasMemo()
        .temporal.api.common.v1.Memo memo = 14;
        Returns:
        Whether the memo field is set.

      • getMemo

        Memo getMemo()
        .temporal.api.common.v1.Memo memo = 14;
        Returns:
        The memo.

      • getMemoOrBuilder

        MemoOrBuilder getMemoOrBuilder()
        .temporal.api.common.v1.Memo memo = 14;

      • hasSearchAttributes

        boolean hasSearchAttributes()
        .temporal.api.common.v1.SearchAttributes search_attributes = 15;
        Returns:
        Whether the searchAttributes field is set.

      • getSearchAttributes

        SearchAttributes getSearchAttributes()
        .temporal.api.common.v1.SearchAttributes search_attributes = 15;
        Returns:
        The searchAttributes.

      • getSearchAttributesOrBuilder

        SearchAttributesOrBuilder getSearchAttributesOrBuilder()
        .temporal.api.common.v1.SearchAttributes search_attributes = 15;

      • hasHeader

        boolean hasHeader()
        .temporal.api.common.v1.Header header = 16;
        Returns:
        Whether the header field is set.

      • getHeader

        Header getHeader()
        .temporal.api.common.v1.Header header = 16;
        Returns:
        The header.

      • getHeaderOrBuilder

        HeaderOrBuilder getHeaderOrBuilder()
        .temporal.api.common.v1.Header header = 16;

      • getRequestEagerExecution

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

      • hasContinuedFailure

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

      • getContinuedFailure

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

      • getContinuedFailureOrBuilder

        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;

      • hasLastCompletionResult

        boolean hasLastCompletionResult()
        .temporal.api.common.v1.Payloads last_completion_result = 19;
        Returns:
        Whether the lastCompletionResult field is set.

      • getLastCompletionResult

        Payloads getLastCompletionResult()
        .temporal.api.common.v1.Payloads last_completion_result = 19;
        Returns:
        The lastCompletionResult.

      • getLastCompletionResultOrBuilder

        PayloadsOrBuilder getLastCompletionResultOrBuilder()
        .temporal.api.common.v1.Payloads last_completion_result = 19;

      • hasWorkflowStartDelay

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

      • getWorkflowStartDelay

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

      • getWorkflowStartDelayOrBuilder

        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;

      • getCompletionCallbacksList

        java.util.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;

      • getCompletionCallbacks

        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;

      • getCompletionCallbacksCount

        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;

      • getCompletionCallbacksOrBuilderList

        java.util.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;

      • getCompletionCallbacksOrBuilder

        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;

      • hasUserMetadata

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

      • getUserMetadata

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

      • getUserMetadataOrBuilder

        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;

      • getLinksList

        java.util.List<Link> getLinksList()
         Links to be associated with the workflow.
        repeated .temporal.api.common.v1.Link links = 24;

      • getLinks

        Link getLinks​(int index)
         Links to be associated with the workflow.
        repeated .temporal.api.common.v1.Link links = 24;

      • getLinksCount

        int getLinksCount()
         Links to be associated with the workflow.
        repeated .temporal.api.common.v1.Link links = 24;

      • getLinksOrBuilderList

        java.util.List<? extends LinkOrBuilder> getLinksOrBuilderList()
         Links to be associated with the workflow.
        repeated .temporal.api.common.v1.Link links = 24;

      • getLinksOrBuilder

        LinkOrBuilder getLinksOrBuilder​(int index)
         Links to be associated with the workflow.
        repeated .temporal.api.common.v1.Link links = 24;

      • hasVersioningOverride

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

      • getVersioningOverride

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

      • getVersioningOverrideOrBuilder

        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;

      • hasOnConflictOptions

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

      • getOnConflictOptions

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

      • getOnConflictOptionsOrBuilder

        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;

      • hasPriority

        boolean hasPriority()
         Priority metadata
        .temporal.api.common.v1.Priority priority = 27;
        Returns:
        Whether the priority field is set.

      • getPriority

        Priority getPriority()
         Priority metadata
        .temporal.api.common.v1.Priority priority = 27;
        Returns:
        The priority.

      • getPriorityOrBuilder

        PriorityOrBuilder getPriorityOrBuilder()
         Priority metadata
        .temporal.api.common.v1.Priority priority = 27;

      • hasEagerWorkerDeploymentOptions

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

      • getEagerWorkerDeploymentOptions

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

      • getEagerWorkerDeploymentOptionsOrBuilder

        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;