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 Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Failure
getContinuedFailure()
These values will be available as ContinuedFailure and LastCompletionResult in the WorkflowExecutionStarted event and through SDKs.FailureOrBuilder
getContinuedFailureOrBuilder()
These values will be available as ContinuedFailure and LastCompletionResult in the WorkflowExecutionStarted event and through SDKs.java.lang.String
getCronSchedule()
See https://docs.temporal.io/docs/content/what-is-a-temporal-cron-job/com.google.protobuf.ByteString
getCronScheduleBytes()
See https://docs.temporal.io/docs/content/what-is-a-temporal-cron-job/Header
getHeader()
.temporal.api.common.v1.Header header = 16;
HeaderOrBuilder
getHeaderOrBuilder()
.temporal.api.common.v1.Header header = 16;
java.lang.String
getIdentity()
The identity of the client who initiated this requestcom.google.protobuf.ByteString
getIdentityBytes()
The identity of the client who initiated this requestPayloads
getInput()
Serialized arguments to the workflow.PayloadsOrBuilder
getInputOrBuilder()
Serialized arguments to the workflow.Payloads
getLastCompletionResult()
.temporal.api.common.v1.Payloads last_completion_result = 19;
PayloadsOrBuilder
getLastCompletionResultOrBuilder()
.temporal.api.common.v1.Payloads last_completion_result = 19;
Memo
getMemo()
.temporal.api.common.v1.Memo memo = 14;
MemoOrBuilder
getMemoOrBuilder()
.temporal.api.common.v1.Memo memo = 14;
java.lang.String
getNamespace()
string namespace = 1;
com.google.protobuf.ByteString
getNamespaceBytes()
string namespace = 1;
boolean
getRequestEagerExecution()
Request to get the first workflow task inline in the response bypassing matching service and worker polling.java.lang.String
getRequestId()
A unique identifier for this start request.com.google.protobuf.ByteString
getRequestIdBytes()
A unique identifier for this start request.RetryPolicy
getRetryPolicy()
The retry policy for the workflow.RetryPolicyOrBuilder
getRetryPolicyOrBuilder()
The retry policy for the workflow.SearchAttributes
getSearchAttributes()
.temporal.api.common.v1.SearchAttributes search_attributes = 15;
SearchAttributesOrBuilder
getSearchAttributesOrBuilder()
.temporal.api.common.v1.SearchAttributes search_attributes = 15;
TaskQueue
getTaskQueue()
.temporal.api.taskqueue.v1.TaskQueue task_queue = 4;
TaskQueueOrBuilder
getTaskQueueOrBuilder()
.temporal.api.taskqueue.v1.TaskQueue task_queue = 4;
com.google.protobuf.Duration
getWorkflowExecutionTimeout()
Total workflow execution timeout including retries and continue as new.com.google.protobuf.DurationOrBuilder
getWorkflowExecutionTimeoutOrBuilder()
Total workflow execution timeout including retries and continue as new.java.lang.String
getWorkflowId()
string workflow_id = 2;
com.google.protobuf.ByteString
getWorkflowIdBytes()
string workflow_id = 2;
WorkflowIdReusePolicy
getWorkflowIdReusePolicy()
Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.int
getWorkflowIdReusePolicyValue()
Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.com.google.protobuf.Duration
getWorkflowRunTimeout()
Timeout of a single workflow run.com.google.protobuf.DurationOrBuilder
getWorkflowRunTimeoutOrBuilder()
Timeout of a single workflow run.com.google.protobuf.Duration
getWorkflowStartDelay()
Time to wait before dispatching the first workflow task.com.google.protobuf.DurationOrBuilder
getWorkflowStartDelayOrBuilder()
Time to wait before dispatching the first workflow task.com.google.protobuf.Duration
getWorkflowTaskTimeout()
Timeout of a single workflow task.com.google.protobuf.DurationOrBuilder
getWorkflowTaskTimeoutOrBuilder()
Timeout of a single workflow task.WorkflowType
getWorkflowType()
.temporal.api.common.v1.WorkflowType workflow_type = 3;
WorkflowTypeOrBuilder
getWorkflowTypeOrBuilder()
.temporal.api.common.v1.WorkflowType workflow_type = 3;
boolean
hasContinuedFailure()
These values will be available as ContinuedFailure and LastCompletionResult in the WorkflowExecutionStarted event and through SDKs.boolean
hasHeader()
.temporal.api.common.v1.Header header = 16;
boolean
hasInput()
Serialized arguments to the workflow.boolean
hasLastCompletionResult()
.temporal.api.common.v1.Payloads last_completion_result = 19;
boolean
hasMemo()
.temporal.api.common.v1.Memo memo = 14;
boolean
hasRetryPolicy()
The retry policy for the workflow.boolean
hasSearchAttributes()
.temporal.api.common.v1.SearchAttributes search_attributes = 15;
boolean
hasTaskQueue()
.temporal.api.taskqueue.v1.TaskQueue task_queue = 4;
boolean
hasWorkflowExecutionTimeout()
Total workflow execution timeout including retries and continue as new.boolean
hasWorkflowRunTimeout()
Timeout of a single workflow run.boolean
hasWorkflowStartDelay()
Time to wait before dispatching the first workflow task.boolean
hasWorkflowTaskTimeout()
Timeout of a single workflow task.boolean
hasWorkflowType()
.temporal.api.common.v1.WorkflowType workflow_type = 3;
-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
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 [(.gogoproto.stdduration) = true];
- 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 [(.gogoproto.stdduration) = true];
- 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 [(.gogoproto.stdduration) = true];
-
hasWorkflowRunTimeout
boolean hasWorkflowRunTimeout()
Timeout of a single workflow run.
.google.protobuf.Duration workflow_run_timeout = 7 [(.gogoproto.stdduration) = true];
- 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 [(.gogoproto.stdduration) = true];
- Returns:
- The workflowRunTimeout.
-
getWorkflowRunTimeoutOrBuilder
com.google.protobuf.DurationOrBuilder getWorkflowRunTimeoutOrBuilder()
Timeout of a single workflow run.
.google.protobuf.Duration workflow_run_timeout = 7 [(.gogoproto.stdduration) = true];
-
hasWorkflowTaskTimeout
boolean hasWorkflowTaskTimeout()
Timeout of a single workflow task.
.google.protobuf.Duration workflow_task_timeout = 8 [(.gogoproto.stdduration) = true];
- 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 [(.gogoproto.stdduration) = true];
- Returns:
- The workflowTaskTimeout.
-
getWorkflowTaskTimeoutOrBuilder
com.google.protobuf.DurationOrBuilder getWorkflowTaskTimeoutOrBuilder()
Timeout of a single workflow task.
.google.protobuf.Duration workflow_task_timeout = 8 [(.gogoproto.stdduration) = true];
-
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()
Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.
.temporal.api.enums.v1.WorkflowIdReusePolicy workflow_id_reuse_policy = 11;
- Returns:
- The enum numeric value on the wire for workflowIdReusePolicy.
-
getWorkflowIdReusePolicy
WorkflowIdReusePolicy getWorkflowIdReusePolicy()
Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.
.temporal.api.enums.v1.WorkflowIdReusePolicy workflow_id_reuse_policy = 11;
- Returns:
- The workflowIdReusePolicy.
-
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 [(.gogoproto.stdduration) = true];
- 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 [(.gogoproto.stdduration) = true];
- 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 [(.gogoproto.stdduration) = true];
-
-