Package io.temporal.api.workflow.v1

Class NewWorkflowExecutionInfo.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, NewWorkflowExecutionInfoOrBuilder, java.lang.Cloneable
    Enclosing class:
    NewWorkflowExecutionInfo
    public static final class NewWorkflowExecutionInfo.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<NewWorkflowExecutionInfo.Builder>
implements NewWorkflowExecutionInfoOrBuilder
     NewWorkflowExecutionInfo is a shared message that encapsulates all the
 required arguments to starting a workflow in different contexts.
    Protobuf type temporal.api.workflow.v1.NewWorkflowExecutionInfo

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<NewWorkflowExecutionInfo.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<NewWorkflowExecutionInfo.Builder>

      • getDefaultInstanceForType

        public NewWorkflowExecutionInfo getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public NewWorkflowExecutionInfo build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public NewWorkflowExecutionInfo buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • setField

        public NewWorkflowExecutionInfo.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 java.lang.Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<NewWorkflowExecutionInfo.Builder>

      • setRepeatedField

        public NewWorkflowExecutionInfo.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                         int index,
                                                         java.lang.Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<NewWorkflowExecutionInfo.Builder>

      • addRepeatedField

        public NewWorkflowExecutionInfo.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                         java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<NewWorkflowExecutionInfo.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<NewWorkflowExecutionInfo.Builder>

      • mergeFrom

        public NewWorkflowExecutionInfo.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<NewWorkflowExecutionInfo.Builder>
        Throws:
        java.io.IOException

      • setWorkflowId

        public NewWorkflowExecutionInfo.Builder setWorkflowId​(java.lang.String value)
        string workflow_id = 1;
        Parameters:
        value - The workflowId to set.
        Returns:
        This builder for chaining.

      • setWorkflowIdBytes

        public NewWorkflowExecutionInfo.Builder setWorkflowIdBytes​(com.google.protobuf.ByteString value)
        string workflow_id = 1;
        Parameters:
        value - The bytes for workflowId to set.
        Returns:
        This builder for chaining.

      • getWorkflowTypeBuilder

        public WorkflowType.Builder getWorkflowTypeBuilder()
        .temporal.api.common.v1.WorkflowType workflow_type = 2;

      • getTaskQueueBuilder

        public TaskQueue.Builder getTaskQueueBuilder()
        .temporal.api.taskqueue.v1.TaskQueue task_queue = 3;

      • hasInput

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

      • getInputBuilder

        public Payloads.Builder getInputBuilder()
         Serialized arguments to the workflow.
        .temporal.api.common.v1.Payloads input = 4;

      • hasWorkflowExecutionTimeout

        public boolean hasWorkflowExecutionTimeout()
         Total workflow execution timeout including retries and continue as new.
        .google.protobuf.Duration workflow_execution_timeout = 5;
        Specified by:
        hasWorkflowExecutionTimeout in interface NewWorkflowExecutionInfoOrBuilder
        Returns:
        Whether the workflowExecutionTimeout field is set.

      • getWorkflowExecutionTimeout

        public com.google.protobuf.Duration getWorkflowExecutionTimeout()
         Total workflow execution timeout including retries and continue as new.
        .google.protobuf.Duration workflow_execution_timeout = 5;
        Specified by:
        getWorkflowExecutionTimeout in interface NewWorkflowExecutionInfoOrBuilder
        Returns:
        The workflowExecutionTimeout.

      • setWorkflowExecutionTimeout

        public NewWorkflowExecutionInfo.Builder setWorkflowExecutionTimeout​(com.google.protobuf.Duration value)
         Total workflow execution timeout including retries and continue as new.
        .google.protobuf.Duration workflow_execution_timeout = 5;

      • setWorkflowExecutionTimeout

        public NewWorkflowExecutionInfo.Builder setWorkflowExecutionTimeout​(com.google.protobuf.Duration.Builder builderForValue)
         Total workflow execution timeout including retries and continue as new.
        .google.protobuf.Duration workflow_execution_timeout = 5;

      • mergeWorkflowExecutionTimeout

        public NewWorkflowExecutionInfo.Builder mergeWorkflowExecutionTimeout​(com.google.protobuf.Duration value)
         Total workflow execution timeout including retries and continue as new.
        .google.protobuf.Duration workflow_execution_timeout = 5;

      • clearWorkflowExecutionTimeout

        public NewWorkflowExecutionInfo.Builder clearWorkflowExecutionTimeout()
         Total workflow execution timeout including retries and continue as new.
        .google.protobuf.Duration workflow_execution_timeout = 5;

      • getWorkflowExecutionTimeoutBuilder

        public com.google.protobuf.Duration.Builder getWorkflowExecutionTimeoutBuilder()
         Total workflow execution timeout including retries and continue as new.
        .google.protobuf.Duration workflow_execution_timeout = 5;

      • getWorkflowExecutionTimeoutOrBuilder

        public com.google.protobuf.DurationOrBuilder getWorkflowExecutionTimeoutOrBuilder()
         Total workflow execution timeout including retries and continue as new.
        .google.protobuf.Duration workflow_execution_timeout = 5;
        Specified by:
        getWorkflowExecutionTimeoutOrBuilder in interface NewWorkflowExecutionInfoOrBuilder

      • hasWorkflowRunTimeout

        public boolean hasWorkflowRunTimeout()
         Timeout of a single workflow run.
        .google.protobuf.Duration workflow_run_timeout = 6;
        Specified by:
        hasWorkflowRunTimeout in interface NewWorkflowExecutionInfoOrBuilder
        Returns:
        Whether the workflowRunTimeout field is set.

      • getWorkflowRunTimeout

        public com.google.protobuf.Duration getWorkflowRunTimeout()
         Timeout of a single workflow run.
        .google.protobuf.Duration workflow_run_timeout = 6;
        Specified by:
        getWorkflowRunTimeout in interface NewWorkflowExecutionInfoOrBuilder
        Returns:
        The workflowRunTimeout.

      • setWorkflowRunTimeout

        public NewWorkflowExecutionInfo.Builder setWorkflowRunTimeout​(com.google.protobuf.Duration value)
         Timeout of a single workflow run.
        .google.protobuf.Duration workflow_run_timeout = 6;

      • setWorkflowRunTimeout

        public NewWorkflowExecutionInfo.Builder setWorkflowRunTimeout​(com.google.protobuf.Duration.Builder builderForValue)
         Timeout of a single workflow run.
        .google.protobuf.Duration workflow_run_timeout = 6;

      • mergeWorkflowRunTimeout

        public NewWorkflowExecutionInfo.Builder mergeWorkflowRunTimeout​(com.google.protobuf.Duration value)
         Timeout of a single workflow run.
        .google.protobuf.Duration workflow_run_timeout = 6;

      • clearWorkflowRunTimeout

        public NewWorkflowExecutionInfo.Builder clearWorkflowRunTimeout()
         Timeout of a single workflow run.
        .google.protobuf.Duration workflow_run_timeout = 6;

      • getWorkflowRunTimeoutBuilder

        public com.google.protobuf.Duration.Builder getWorkflowRunTimeoutBuilder()
         Timeout of a single workflow run.
        .google.protobuf.Duration workflow_run_timeout = 6;

      • hasWorkflowTaskTimeout

        public boolean hasWorkflowTaskTimeout()
         Timeout of a single workflow task.
        .google.protobuf.Duration workflow_task_timeout = 7;
        Specified by:
        hasWorkflowTaskTimeout in interface NewWorkflowExecutionInfoOrBuilder
        Returns:
        Whether the workflowTaskTimeout field is set.

      • getWorkflowTaskTimeout

        public com.google.protobuf.Duration getWorkflowTaskTimeout()
         Timeout of a single workflow task.
        .google.protobuf.Duration workflow_task_timeout = 7;
        Specified by:
        getWorkflowTaskTimeout in interface NewWorkflowExecutionInfoOrBuilder
        Returns:
        The workflowTaskTimeout.

      • setWorkflowTaskTimeout

        public NewWorkflowExecutionInfo.Builder setWorkflowTaskTimeout​(com.google.protobuf.Duration value)
         Timeout of a single workflow task.
        .google.protobuf.Duration workflow_task_timeout = 7;

      • setWorkflowTaskTimeout

        public NewWorkflowExecutionInfo.Builder setWorkflowTaskTimeout​(com.google.protobuf.Duration.Builder builderForValue)
         Timeout of a single workflow task.
        .google.protobuf.Duration workflow_task_timeout = 7;

      • mergeWorkflowTaskTimeout

        public NewWorkflowExecutionInfo.Builder mergeWorkflowTaskTimeout​(com.google.protobuf.Duration value)
         Timeout of a single workflow task.
        .google.protobuf.Duration workflow_task_timeout = 7;

      • clearWorkflowTaskTimeout

        public NewWorkflowExecutionInfo.Builder clearWorkflowTaskTimeout()
         Timeout of a single workflow task.
        .google.protobuf.Duration workflow_task_timeout = 7;

      • getWorkflowTaskTimeoutBuilder

        public com.google.protobuf.Duration.Builder getWorkflowTaskTimeoutBuilder()
         Timeout of a single workflow task.
        .google.protobuf.Duration workflow_task_timeout = 7;

      • getWorkflowIdReusePolicyValue

        public int getWorkflowIdReusePolicyValue()
         Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.
        .temporal.api.enums.v1.WorkflowIdReusePolicy workflow_id_reuse_policy = 8;
        Specified by:
        getWorkflowIdReusePolicyValue in interface NewWorkflowExecutionInfoOrBuilder
        Returns:
        The enum numeric value on the wire for workflowIdReusePolicy.

      • setWorkflowIdReusePolicyValue

        public NewWorkflowExecutionInfo.Builder setWorkflowIdReusePolicyValue​(int value)
         Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.
        .temporal.api.enums.v1.WorkflowIdReusePolicy workflow_id_reuse_policy = 8;
        Parameters:
        value - The enum numeric value on the wire for workflowIdReusePolicy to set.
        Returns:
        This builder for chaining.

      • setWorkflowIdReusePolicy

        public NewWorkflowExecutionInfo.Builder setWorkflowIdReusePolicy​(WorkflowIdReusePolicy value)
         Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.
        .temporal.api.enums.v1.WorkflowIdReusePolicy workflow_id_reuse_policy = 8;
        Parameters:
        value - The workflowIdReusePolicy to set.
        Returns:
        This builder for chaining.

      • clearWorkflowIdReusePolicy

        public NewWorkflowExecutionInfo.Builder clearWorkflowIdReusePolicy()
         Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.
        .temporal.api.enums.v1.WorkflowIdReusePolicy workflow_id_reuse_policy = 8;
        Returns:
        This builder for chaining.

      • hasRetryPolicy

        public boolean hasRetryPolicy()
         The retry policy for the workflow. Will never exceed `workflow_execution_timeout`.
        .temporal.api.common.v1.RetryPolicy retry_policy = 9;
        Specified by:
        hasRetryPolicy in interface NewWorkflowExecutionInfoOrBuilder
        Returns:
        Whether the retryPolicy field is set.

      • getRetryPolicy

        public RetryPolicy getRetryPolicy()
         The retry policy for the workflow. Will never exceed `workflow_execution_timeout`.
        .temporal.api.common.v1.RetryPolicy retry_policy = 9;
        Specified by:
        getRetryPolicy in interface NewWorkflowExecutionInfoOrBuilder
        Returns:
        The retryPolicy.

      • setRetryPolicy

        public NewWorkflowExecutionInfo.Builder setRetryPolicy​(RetryPolicy value)
         The retry policy for the workflow. Will never exceed `workflow_execution_timeout`.
        .temporal.api.common.v1.RetryPolicy retry_policy = 9;

      • mergeRetryPolicy

        public NewWorkflowExecutionInfo.Builder mergeRetryPolicy​(RetryPolicy value)
         The retry policy for the workflow. Will never exceed `workflow_execution_timeout`.
        .temporal.api.common.v1.RetryPolicy retry_policy = 9;

      • clearRetryPolicy

        public NewWorkflowExecutionInfo.Builder clearRetryPolicy()
         The retry policy for the workflow. Will never exceed `workflow_execution_timeout`.
        .temporal.api.common.v1.RetryPolicy retry_policy = 9;

      • getRetryPolicyBuilder

        public RetryPolicy.Builder getRetryPolicyBuilder()
         The retry policy for the workflow. Will never exceed `workflow_execution_timeout`.
        .temporal.api.common.v1.RetryPolicy retry_policy = 9;

      • getCronSchedule

        public java.lang.String getCronSchedule()
         See https://docs.temporal.io/docs/content/what-is-a-temporal-cron-job/
        string cron_schedule = 10;
        Specified by:
        getCronSchedule in interface NewWorkflowExecutionInfoOrBuilder
        Returns:
        The cronSchedule.

      • getCronScheduleBytes

        public com.google.protobuf.ByteString getCronScheduleBytes()
         See https://docs.temporal.io/docs/content/what-is-a-temporal-cron-job/
        string cron_schedule = 10;
        Specified by:
        getCronScheduleBytes in interface NewWorkflowExecutionInfoOrBuilder
        Returns:
        The bytes for cronSchedule.

      • setCronSchedule

        public NewWorkflowExecutionInfo.Builder setCronSchedule​(java.lang.String value)
         See https://docs.temporal.io/docs/content/what-is-a-temporal-cron-job/
        string cron_schedule = 10;
        Parameters:
        value - The cronSchedule to set.
        Returns:
        This builder for chaining.

      • clearCronSchedule

        public NewWorkflowExecutionInfo.Builder clearCronSchedule()
         See https://docs.temporal.io/docs/content/what-is-a-temporal-cron-job/
        string cron_schedule = 10;
        Returns:
        This builder for chaining.

      • setCronScheduleBytes

        public NewWorkflowExecutionInfo.Builder setCronScheduleBytes​(com.google.protobuf.ByteString value)
         See https://docs.temporal.io/docs/content/what-is-a-temporal-cron-job/
        string cron_schedule = 10;
        Parameters:
        value - The bytes for cronSchedule to set.
        Returns:
        This builder for chaining.

      • getMemoBuilder

        public Memo.Builder getMemoBuilder()
        .temporal.api.common.v1.Memo memo = 11;

      • hasSearchAttributes

        public boolean hasSearchAttributes()
        .temporal.api.common.v1.SearchAttributes search_attributes = 12;
        Specified by:
        hasSearchAttributes in interface NewWorkflowExecutionInfoOrBuilder
        Returns:
        Whether the searchAttributes field is set.

      • getSearchAttributesBuilder

        public SearchAttributes.Builder getSearchAttributesBuilder()
        .temporal.api.common.v1.SearchAttributes search_attributes = 12;

      • getHeaderBuilder

        public Header.Builder getHeaderBuilder()
        .temporal.api.common.v1.Header header = 13;

      • hasUserMetadata

        public 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;
        Specified by:
        hasUserMetadata in interface NewWorkflowExecutionInfoOrBuilder
        Returns:
        Whether the userMetadata field is set.

      • getUserMetadata

        public 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;
        Specified by:
        getUserMetadata in interface NewWorkflowExecutionInfoOrBuilder
        Returns:
        The userMetadata.

      • setUserMetadata

        public NewWorkflowExecutionInfo.Builder setUserMetadata​(UserMetadata value)
         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;

      • setUserMetadata

        public NewWorkflowExecutionInfo.Builder setUserMetadata​(UserMetadata.Builder builderForValue)
         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;

      • mergeUserMetadata

        public NewWorkflowExecutionInfo.Builder mergeUserMetadata​(UserMetadata value)
         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;

      • clearUserMetadata

        public NewWorkflowExecutionInfo.Builder clearUserMetadata()
         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;

      • getUserMetadataBuilder

        public UserMetadata.Builder getUserMetadataBuilder()
         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;

      • getUserMetadataOrBuilder

        public 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;
        Specified by:
        getUserMetadataOrBuilder in interface NewWorkflowExecutionInfoOrBuilder

      • setUnknownFields

        public final NewWorkflowExecutionInfo.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<NewWorkflowExecutionInfo.Builder>

      • mergeUnknownFields

        public final NewWorkflowExecutionInfo.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<NewWorkflowExecutionInfo.Builder>