Class NewWorkflowExecutionInfo

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.temporal.api.workflow.v1.NewWorkflowExecutionInfo
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, NewWorkflowExecutionInfoOrBuilder, 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:

  • Field Details

    • WORKFLOW_ID_FIELD_NUMBER

      public static final int WORKFLOW_ID_FIELD_NUMBER
      See Also:

    • WORKFLOW_TYPE_FIELD_NUMBER

      public static final int WORKFLOW_TYPE_FIELD_NUMBER
      See Also:

    • TASK_QUEUE_FIELD_NUMBER

      public static final int TASK_QUEUE_FIELD_NUMBER
      See Also:

    • INPUT_FIELD_NUMBER

      public static final int INPUT_FIELD_NUMBER
      See Also:

    • WORKFLOW_EXECUTION_TIMEOUT_FIELD_NUMBER

      public static final int WORKFLOW_EXECUTION_TIMEOUT_FIELD_NUMBER
      See Also:

    • WORKFLOW_RUN_TIMEOUT_FIELD_NUMBER

      public static final int WORKFLOW_RUN_TIMEOUT_FIELD_NUMBER
      See Also:

    • WORKFLOW_TASK_TIMEOUT_FIELD_NUMBER

      public static final int WORKFLOW_TASK_TIMEOUT_FIELD_NUMBER
      See Also:

    • WORKFLOW_ID_REUSE_POLICY_FIELD_NUMBER

      public static final int WORKFLOW_ID_REUSE_POLICY_FIELD_NUMBER
      See Also:

    • RETRY_POLICY_FIELD_NUMBER

      public static final int RETRY_POLICY_FIELD_NUMBER
      See Also:

    • CRON_SCHEDULE_FIELD_NUMBER

      public static final int CRON_SCHEDULE_FIELD_NUMBER
      See Also:

    • MEMO_FIELD_NUMBER

      public static final int MEMO_FIELD_NUMBER
      See Also:

    • SEARCH_ATTRIBUTES_FIELD_NUMBER

      public static final int SEARCH_ATTRIBUTES_FIELD_NUMBER
      See Also:

    • HEADER_FIELD_NUMBER

      public static final int HEADER_FIELD_NUMBER
      See Also:

    • USER_METADATA_FIELD_NUMBER

      public static final int USER_METADATA_FIELD_NUMBER
      See Also:

    • VERSIONING_OVERRIDE_FIELD_NUMBER

      public static final int VERSIONING_OVERRIDE_FIELD_NUMBER
      See Also:

    • PRIORITY_FIELD_NUMBER

      public static final int PRIORITY_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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

    • getWorkflowId

      public String getWorkflowId()
      string workflow_id = 1;
      Specified by:
      getWorkflowId in interface NewWorkflowExecutionInfoOrBuilder
      Returns:
      The workflowId.

    • getWorkflowIdBytes

      public com.google.protobuf.ByteString getWorkflowIdBytes()
      string workflow_id = 1;
      Specified by:
      getWorkflowIdBytes in interface NewWorkflowExecutionInfoOrBuilder
      Returns:
      The bytes for workflowId.

    • hasWorkflowType

      public boolean hasWorkflowType()
      .temporal.api.common.v1.WorkflowType workflow_type = 2;
      Specified by:
      hasWorkflowType in interface NewWorkflowExecutionInfoOrBuilder
      Returns:
      Whether the workflowType field is set.

    • getWorkflowType

      public WorkflowType getWorkflowType()
      .temporal.api.common.v1.WorkflowType workflow_type = 2;
      Specified by:
      getWorkflowType in interface NewWorkflowExecutionInfoOrBuilder
      Returns:
      The workflowType.

    • getWorkflowTypeOrBuilder

      public WorkflowTypeOrBuilder getWorkflowTypeOrBuilder()
      .temporal.api.common.v1.WorkflowType workflow_type = 2;
      Specified by:
      getWorkflowTypeOrBuilder in interface NewWorkflowExecutionInfoOrBuilder

    • hasTaskQueue

      public boolean hasTaskQueue()
      .temporal.api.taskqueue.v1.TaskQueue task_queue = 3;
      Specified by:
      hasTaskQueue in interface NewWorkflowExecutionInfoOrBuilder
      Returns:
      Whether the taskQueue field is set.

    • getTaskQueue

      public TaskQueue getTaskQueue()
      .temporal.api.taskqueue.v1.TaskQueue task_queue = 3;
      Specified by:
      getTaskQueue in interface NewWorkflowExecutionInfoOrBuilder
      Returns:
      The taskQueue.

    • getTaskQueueOrBuilder

      public TaskQueueOrBuilder getTaskQueueOrBuilder()
      .temporal.api.taskqueue.v1.TaskQueue task_queue = 3;
      Specified by:
      getTaskQueueOrBuilder in interface NewWorkflowExecutionInfoOrBuilder

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

    • getInput

      public Payloads getInput()
       Serialized arguments to the workflow.
      .temporal.api.common.v1.Payloads input = 4;
      Specified by:
      getInput in interface NewWorkflowExecutionInfoOrBuilder
      Returns:
      The input.

    • getInputOrBuilder

      public PayloadsOrBuilder getInputOrBuilder()
       Serialized arguments to the workflow.
      .temporal.api.common.v1.Payloads input = 4;
      Specified by:
      getInputOrBuilder in interface NewWorkflowExecutionInfoOrBuilder

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

    • getWorkflowRunTimeoutOrBuilder

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

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

    • getWorkflowTaskTimeoutOrBuilder

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

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

    • getWorkflowIdReusePolicy

      public WorkflowIdReusePolicy getWorkflowIdReusePolicy()
       Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.
      .temporal.api.enums.v1.WorkflowIdReusePolicy workflow_id_reuse_policy = 8;
      Specified by:
      getWorkflowIdReusePolicy in interface NewWorkflowExecutionInfoOrBuilder
      Returns:
      The 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.

    • getRetryPolicyOrBuilder

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

    • getCronSchedule

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

    • hasMemo

      public boolean hasMemo()
      .temporal.api.common.v1.Memo memo = 11;
      Specified by:
      hasMemo in interface NewWorkflowExecutionInfoOrBuilder
      Returns:
      Whether the memo field is set.

    • getMemo

      public Memo getMemo()
      .temporal.api.common.v1.Memo memo = 11;
      Specified by:
      getMemo in interface NewWorkflowExecutionInfoOrBuilder
      Returns:
      The memo.

    • getMemoOrBuilder

      public MemoOrBuilder getMemoOrBuilder()
      .temporal.api.common.v1.Memo memo = 11;
      Specified by:
      getMemoOrBuilder in interface NewWorkflowExecutionInfoOrBuilder

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

    • getSearchAttributes

      public SearchAttributes getSearchAttributes()
      .temporal.api.common.v1.SearchAttributes search_attributes = 12;
      Specified by:
      getSearchAttributes in interface NewWorkflowExecutionInfoOrBuilder
      Returns:
      The searchAttributes.

    • getSearchAttributesOrBuilder

      public SearchAttributesOrBuilder getSearchAttributesOrBuilder()
      .temporal.api.common.v1.SearchAttributes search_attributes = 12;
      Specified by:
      getSearchAttributesOrBuilder in interface NewWorkflowExecutionInfoOrBuilder

    • hasHeader

      public boolean hasHeader()
      .temporal.api.common.v1.Header header = 13;
      Specified by:
      hasHeader in interface NewWorkflowExecutionInfoOrBuilder
      Returns:
      Whether the header field is set.

    • getHeader

      public Header getHeader()
      .temporal.api.common.v1.Header header = 13;
      Specified by:
      getHeader in interface NewWorkflowExecutionInfoOrBuilder
      Returns:
      The header.

    • getHeaderOrBuilder

      public HeaderOrBuilder getHeaderOrBuilder()
      .temporal.api.common.v1.Header header = 13;
      Specified by:
      getHeaderOrBuilder in interface NewWorkflowExecutionInfoOrBuilder

    • 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

    • hasVersioningOverride

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

    • getVersioningOverride

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

    • getVersioningOverrideOrBuilder

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

    • hasPriority

      public boolean hasPriority()
       Priority metadata
      .temporal.api.common.v1.Priority priority = 16;
      Specified by:
      hasPriority in interface NewWorkflowExecutionInfoOrBuilder
      Returns:
      Whether the priority field is set.

    • getPriority

      public Priority getPriority()
       Priority metadata
      .temporal.api.common.v1.Priority priority = 16;
      Specified by:
      getPriority in interface NewWorkflowExecutionInfoOrBuilder
      Returns:
      The priority.

    • getPriorityOrBuilder

      public PriorityOrBuilder getPriorityOrBuilder()
       Priority metadata
      .temporal.api.common.v1.Priority priority = 16;
      Specified by:
      getPriorityOrBuilder 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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      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(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(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static NewWorkflowExecutionInfo parseFrom(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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static NewWorkflowExecutionInfo parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static NewWorkflowExecutionInfo.Builder newBuilder()

    • newBuilder

      public static NewWorkflowExecutionInfo.Builder newBuilder(NewWorkflowExecutionInfo prototype)

    • 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

    • getDefaultInstance

      public static NewWorkflowExecutionInfo getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<NewWorkflowExecutionInfo> parser()

    • 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