Package io.temporal.api.workflow.v1

Interface NewWorkflowExecutionInfoOrBuilder

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

    • Method Detail

      • getWorkflowId

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

      • getWorkflowIdBytes

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

      • hasWorkflowType

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

      • getWorkflowType

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

      • getWorkflowTypeOrBuilder

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

      • hasTaskQueue

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

      • getTaskQueue

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

      • getTaskQueueOrBuilder

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

      • hasInput

        boolean hasInput()
         Serialized arguments to the workflow.
        .temporal.api.common.v1.Payloads input = 4;
        Returns:
        Whether the input field is set.

      • getInput

        Payloads getInput()
         Serialized arguments to the workflow.
        .temporal.api.common.v1.Payloads input = 4;
        Returns:
        The input.

      • getInputOrBuilder

        PayloadsOrBuilder getInputOrBuilder()
         Serialized arguments to the workflow.
        .temporal.api.common.v1.Payloads input = 4;

      • hasWorkflowExecutionTimeout

        boolean hasWorkflowExecutionTimeout()
         Total workflow execution timeout including retries and continue as new.
        .google.protobuf.Duration workflow_execution_timeout = 5;
        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 = 5;
        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 = 5;

      • hasWorkflowRunTimeout

        boolean hasWorkflowRunTimeout()
         Timeout of a single workflow run.
        .google.protobuf.Duration workflow_run_timeout = 6;
        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 = 6;
        Returns:
        The workflowRunTimeout.

      • getWorkflowRunTimeoutOrBuilder

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

      • hasWorkflowTaskTimeout

        boolean hasWorkflowTaskTimeout()
         Timeout of a single workflow task.
        .google.protobuf.Duration workflow_task_timeout = 7;
        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 = 7;
        Returns:
        The workflowTaskTimeout.

      • getWorkflowTaskTimeoutOrBuilder

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

      • getWorkflowIdReusePolicyValue

        int getWorkflowIdReusePolicyValue()
         Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.
        .temporal.api.enums.v1.WorkflowIdReusePolicy workflow_id_reuse_policy = 8;
        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 = 8;
        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 = 9;
        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 = 9;
        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 = 9;

      • getCronSchedule

        java.lang.String getCronSchedule()
         See https://docs.temporal.io/docs/content/what-is-a-temporal-cron-job/
        string cron_schedule = 10;
        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 = 10;
        Returns:
        The bytes for cronSchedule.

      • hasMemo

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

      • getMemo

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

      • getMemoOrBuilder

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

      • hasSearchAttributes

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

      • getSearchAttributes

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

      • getSearchAttributesOrBuilder

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

      • hasHeader

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

      • getHeader

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

      • getHeaderOrBuilder

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

      • hasUserMetadata

        boolean hasUserMetadata()
         Metadata on the workflow if it is started. This is carried over to the WorkflowExecutionConfig
 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 = 14;
        Returns:
        Whether the userMetadata field is set.

      • getUserMetadata

        UserMetadata getUserMetadata()
         Metadata on the workflow if it is started. This is carried over to the WorkflowExecutionConfig
 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 = 14;
        Returns:
        The userMetadata.

      • getUserMetadataOrBuilder

        UserMetadataOrBuilder getUserMetadataOrBuilder()
         Metadata on the workflow if it is started. This is carried over to the WorkflowExecutionConfig
 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 = 14;

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