Interface SignalWithStartWorkflowExecutionRequestOrBuilder
-
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
SignalWithStartWorkflowExecutionRequest
,SignalWithStartWorkflowExecutionRequest.Builder
@Generated(value="protoc", comments="annotations:SignalWithStartWorkflowExecutionRequestOrBuilder.java.pb.meta") public interface SignalWithStartWorkflowExecutionRequestOrBuilder extends com.google.protobuf.MessageOrBuilder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getControl()
Deprecatedcom.google.protobuf.ByteString
getControlBytes()
Deprecatedjava.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 = 19;
HeaderOrBuilder
getHeaderOrBuilder()
.temporal.api.common.v1.Header header = 19;
java.lang.String
getIdentity()
The identity of the worker/clientcom.google.protobuf.ByteString
getIdentityBytes()
The identity of the worker/clientPayloads
getInput()
Serialized arguments to the workflow.PayloadsOrBuilder
getInputOrBuilder()
Serialized arguments to the workflow.Memo
getMemo()
.temporal.api.common.v1.Memo memo = 17;
MemoOrBuilder
getMemoOrBuilder()
.temporal.api.common.v1.Memo memo = 17;
java.lang.String
getNamespace()
string namespace = 1;
com.google.protobuf.ByteString
getNamespaceBytes()
string namespace = 1;
java.lang.String
getRequestId()
Used to de-dupe signal w/ start requestscom.google.protobuf.ByteString
getRequestIdBytes()
Used to de-dupe signal w/ start requestsRetryPolicy
getRetryPolicy()
Retry policy for the workflow Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.RetryPolicyOrBuilder
getRetryPolicyOrBuilder()
Retry policy for the workflow Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.SearchAttributes
getSearchAttributes()
.temporal.api.common.v1.SearchAttributes search_attributes = 18;
SearchAttributesOrBuilder
getSearchAttributesOrBuilder()
.temporal.api.common.v1.SearchAttributes search_attributes = 18;
Payloads
getSignalInput()
Serialized value(s) to provide with the signalPayloadsOrBuilder
getSignalInputOrBuilder()
Serialized value(s) to provide with the signaljava.lang.String
getSignalName()
The workflow author-defined name of the signal to send to the workflowcom.google.protobuf.ByteString
getSignalNameBytes()
The workflow author-defined name of the signal to send to the workflowboolean
getSkipGenerateWorkflowTask()
Indicates that a new workflow task should not be generated when this signal is received.TaskQueue
getTaskQueue()
The task queue to start this workflow on, if it will be startedTaskQueueOrBuilder
getTaskQueueOrBuilder()
The task queue to start this workflow on, if it will be startedcom.google.protobuf.Duration
getWorkflowExecutionTimeout()
Total workflow execution timeout including retries and continue as newcom.google.protobuf.DurationOrBuilder
getWorkflowExecutionTimeoutOrBuilder()
Total workflow execution timeout including retries and continue as newjava.lang.String
getWorkflowId()
string workflow_id = 2;
com.google.protobuf.ByteString
getWorkflowIdBytes()
string workflow_id = 2;
WorkflowIdReusePolicy
getWorkflowIdReusePolicy()
.temporal.api.enums.v1.WorkflowIdReusePolicy workflow_id_reuse_policy = 11;
int
getWorkflowIdReusePolicyValue()
.temporal.api.enums.v1.WorkflowIdReusePolicy workflow_id_reuse_policy = 11;
com.google.protobuf.Duration
getWorkflowRunTimeout()
Timeout of a single workflow runcom.google.protobuf.DurationOrBuilder
getWorkflowRunTimeoutOrBuilder()
Timeout of a single workflow runcom.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 taskcom.google.protobuf.DurationOrBuilder
getWorkflowTaskTimeoutOrBuilder()
Timeout of a single workflow taskWorkflowType
getWorkflowType()
.temporal.api.common.v1.WorkflowType workflow_type = 3;
WorkflowTypeOrBuilder
getWorkflowTypeOrBuilder()
.temporal.api.common.v1.WorkflowType workflow_type = 3;
boolean
hasHeader()
.temporal.api.common.v1.Header header = 19;
boolean
hasInput()
Serialized arguments to the workflow.boolean
hasMemo()
.temporal.api.common.v1.Memo memo = 17;
boolean
hasRetryPolicy()
Retry policy for the workflow Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.boolean
hasSearchAttributes()
.temporal.api.common.v1.SearchAttributes search_attributes = 18;
boolean
hasSignalInput()
Serialized value(s) to provide with the signalboolean
hasTaskQueue()
The task queue to start this workflow on, if it will be startedboolean
hasWorkflowExecutionTimeout()
Total workflow execution timeout including retries and continue as newboolean
hasWorkflowRunTimeout()
Timeout of a single workflow runboolean
hasWorkflowStartDelay()
Time to wait before dispatching the first workflow task.boolean
hasWorkflowTaskTimeout()
Timeout of a single workflow taskboolean
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()
The task queue to start this workflow on, if it will be started
.temporal.api.taskqueue.v1.TaskQueue task_queue = 4;
- Returns:
- Whether the taskQueue field is set.
-
getTaskQueue
TaskQueue getTaskQueue()
The task queue to start this workflow on, if it will be started
.temporal.api.taskqueue.v1.TaskQueue task_queue = 4;
- Returns:
- The taskQueue.
-
getTaskQueueOrBuilder
TaskQueueOrBuilder getTaskQueueOrBuilder()
The task queue to start this workflow on, if it will be started
.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 worker/client
string identity = 9;
- Returns:
- The identity.
-
getIdentityBytes
com.google.protobuf.ByteString getIdentityBytes()
The identity of the worker/client
string identity = 9;
- Returns:
- The bytes for identity.
-
getRequestId
java.lang.String getRequestId()
Used to de-dupe signal w/ start requests
string request_id = 10;
- Returns:
- The requestId.
-
getRequestIdBytes
com.google.protobuf.ByteString getRequestIdBytes()
Used to de-dupe signal w/ start requests
string request_id = 10;
- Returns:
- The bytes for requestId.
-
getWorkflowIdReusePolicyValue
int getWorkflowIdReusePolicyValue()
.temporal.api.enums.v1.WorkflowIdReusePolicy workflow_id_reuse_policy = 11;
- Returns:
- The enum numeric value on the wire for workflowIdReusePolicy.
-
getWorkflowIdReusePolicy
WorkflowIdReusePolicy getWorkflowIdReusePolicy()
.temporal.api.enums.v1.WorkflowIdReusePolicy workflow_id_reuse_policy = 11;
- Returns:
- The workflowIdReusePolicy.
-
getSignalName
java.lang.String getSignalName()
The workflow author-defined name of the signal to send to the workflow
string signal_name = 12;
- Returns:
- The signalName.
-
getSignalNameBytes
com.google.protobuf.ByteString getSignalNameBytes()
The workflow author-defined name of the signal to send to the workflow
string signal_name = 12;
- Returns:
- The bytes for signalName.
-
hasSignalInput
boolean hasSignalInput()
Serialized value(s) to provide with the signal
.temporal.api.common.v1.Payloads signal_input = 13;
- Returns:
- Whether the signalInput field is set.
-
getSignalInput
Payloads getSignalInput()
Serialized value(s) to provide with the signal
.temporal.api.common.v1.Payloads signal_input = 13;
- Returns:
- The signalInput.
-
getSignalInputOrBuilder
PayloadsOrBuilder getSignalInputOrBuilder()
Serialized value(s) to provide with the signal
.temporal.api.common.v1.Payloads signal_input = 13;
-
getControl
java.lang.String getControl()
Deprecated
string control = 14;
- Returns:
- The control.
-
getControlBytes
com.google.protobuf.ByteString getControlBytes()
Deprecated
string control = 14;
- Returns:
- The bytes for control.
-
hasRetryPolicy
boolean hasRetryPolicy()
Retry policy for the workflow Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.
.temporal.api.common.v1.RetryPolicy retry_policy = 15;
- Returns:
- Whether the retryPolicy field is set.
-
getRetryPolicy
RetryPolicy getRetryPolicy()
Retry policy for the workflow Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.
.temporal.api.common.v1.RetryPolicy retry_policy = 15;
- Returns:
- The retryPolicy.
-
getRetryPolicyOrBuilder
RetryPolicyOrBuilder getRetryPolicyOrBuilder()
Retry policy for the workflow Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.
.temporal.api.common.v1.RetryPolicy retry_policy = 15;
-
getCronSchedule
java.lang.String getCronSchedule()
See https://docs.temporal.io/docs/content/what-is-a-temporal-cron-job/
string cron_schedule = 16;
- 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 = 16;
- Returns:
- The bytes for cronSchedule.
-
hasMemo
boolean hasMemo()
.temporal.api.common.v1.Memo memo = 17;
- Returns:
- Whether the memo field is set.
-
getMemo
Memo getMemo()
.temporal.api.common.v1.Memo memo = 17;
- Returns:
- The memo.
-
getMemoOrBuilder
MemoOrBuilder getMemoOrBuilder()
.temporal.api.common.v1.Memo memo = 17;
-
hasSearchAttributes
boolean hasSearchAttributes()
.temporal.api.common.v1.SearchAttributes search_attributes = 18;
- Returns:
- Whether the searchAttributes field is set.
-
getSearchAttributes
SearchAttributes getSearchAttributes()
.temporal.api.common.v1.SearchAttributes search_attributes = 18;
- Returns:
- The searchAttributes.
-
getSearchAttributesOrBuilder
SearchAttributesOrBuilder getSearchAttributesOrBuilder()
.temporal.api.common.v1.SearchAttributes search_attributes = 18;
-
hasHeader
boolean hasHeader()
.temporal.api.common.v1.Header header = 19;
- Returns:
- Whether the header field is set.
-
getHeader
Header getHeader()
.temporal.api.common.v1.Header header = 19;
- Returns:
- The header.
-
getHeaderOrBuilder
HeaderOrBuilder getHeaderOrBuilder()
.temporal.api.common.v1.Header header = 19;
-
hasWorkflowStartDelay
boolean hasWorkflowStartDelay()
Time to wait before dispatching the first workflow task. Cannot be used with `cron_schedule`. Note that the signal will be delivered with the first workflow task. If the workflow gets another SignalWithStartWorkflow before the delay and `skip_generate_workflow_task` is false or not set, a workflow task will be dispatched immediately and the rest of the delay period will be ignored, even if that request also had a delay. Signal via SignalWorkflowExecution will not unblock the workflow.
.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`. Note that the signal will be delivered with the first workflow task. If the workflow gets another SignalWithStartWorkflow before the delay and `skip_generate_workflow_task` is false or not set, a workflow task will be dispatched immediately and the rest of the delay period will be ignored, even if that request also had a delay. Signal via SignalWorkflowExecution will not unblock the workflow.
.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`. Note that the signal will be delivered with the first workflow task. If the workflow gets another SignalWithStartWorkflow before the delay and `skip_generate_workflow_task` is false or not set, a workflow task will be dispatched immediately and the rest of the delay period will be ignored, even if that request also had a delay. Signal via SignalWorkflowExecution will not unblock the workflow.
.google.protobuf.Duration workflow_start_delay = 20 [(.gogoproto.stdduration) = true];
-
getSkipGenerateWorkflowTask
boolean getSkipGenerateWorkflowTask()
Indicates that a new workflow task should not be generated when this signal is received.
bool skip_generate_workflow_task = 21;
- Returns:
- The skipGenerateWorkflowTask.
-
-