Package io.temporal.api.workflowservice.v1

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 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;
        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 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()
         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_reuse_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_reuse_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_USE_EXISTING.
 Note that WORKFLOW_ID_CONFLICT_POLICY_FAIL is an invalid option.
 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_USE_EXISTING.
 Note that WORKFLOW_ID_CONFLICT_POLICY_FAIL is an invalid option.
 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.

      • 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
        .temporal.api.common.v1.RetryPolicy retry_policy = 15;
        Returns:
        Whether the retryPolicy field is set.

      • getRetryPolicy

        RetryPolicy getRetryPolicy()
         Retry policy for the workflow
        .temporal.api.common.v1.RetryPolicy retry_policy = 15;
        Returns:
        The retryPolicy.

      • getRetryPolicyOrBuilder

        RetryPolicyOrBuilder getRetryPolicyOrBuilder()
         Retry policy for the workflow
        .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;
        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;
        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;

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

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