Package io.temporal.api.workflow.v1

Class NewWorkflowExecutionInfo

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, NewWorkflowExecutionInfoOrBuilder, java.io.Serializable
    @Generated(value="protoc",
           comments="annotations:NewWorkflowExecutionInfo.java.pb.meta")
public final class NewWorkflowExecutionInfo
extends com.google.protobuf.GeneratedMessageV3
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
    See Also:
    Serialized Form

    • Field Detail

      • WORKFLOW_ID_FIELD_NUMBER

        public static final int WORKFLOW_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WORKFLOW_TYPE_FIELD_NUMBER

        public static final int WORKFLOW_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TASK_QUEUE_FIELD_NUMBER

        public static final int TASK_QUEUE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WORKFLOW_EXECUTION_TIMEOUT_FIELD_NUMBER

        public static final int WORKFLOW_EXECUTION_TIMEOUT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WORKFLOW_RUN_TIMEOUT_FIELD_NUMBER

        public static final int WORKFLOW_RUN_TIMEOUT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WORKFLOW_TASK_TIMEOUT_FIELD_NUMBER

        public static final int WORKFLOW_TASK_TIMEOUT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WORKFLOW_ID_REUSE_POLICY_FIELD_NUMBER

        public static final int WORKFLOW_ID_REUSE_POLICY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RETRY_POLICY_FIELD_NUMBER

        public static final int RETRY_POLICY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CRON_SCHEDULE_FIELD_NUMBER

        public static final int CRON_SCHEDULE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SEARCH_ATTRIBUTES_FIELD_NUMBER

        public static final int SEARCH_ATTRIBUTES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • USER_METADATA_FIELD_NUMBER

        public static final int USER_METADATA_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • 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

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

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

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

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

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

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

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

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

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

      • 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

      • isInitialized

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

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static NewWorkflowExecutionInfo parseFrom​(java.nio.ByteBuffer data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static NewWorkflowExecutionInfo parseFrom​(java.nio.ByteBuffer data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static NewWorkflowExecutionInfo parseFrom​(com.google.protobuf.ByteString data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static NewWorkflowExecutionInfo parseFrom​(com.google.protobuf.ByteString data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static NewWorkflowExecutionInfo parseFrom​(byte[] data)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static NewWorkflowExecutionInfo parseFrom​(byte[] data,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static NewWorkflowExecutionInfo parseFrom​(java.io.InputStream input)
                                          throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static NewWorkflowExecutionInfo parseFrom​(java.io.InputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static NewWorkflowExecutionInfo parseDelimitedFrom​(java.io.InputStream input)
                                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static NewWorkflowExecutionInfo parseDelimitedFrom​(java.io.InputStream input,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static NewWorkflowExecutionInfo parseFrom​(com.google.protobuf.CodedInputStream input)
                                          throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static NewWorkflowExecutionInfo parseFrom​(com.google.protobuf.CodedInputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected NewWorkflowExecutionInfo.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<NewWorkflowExecutionInfo> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

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