Class WorkflowTaskStartedEventAttributes

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.temporal.api.history.v1.WorkflowTaskStartedEventAttributes
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, WorkflowTaskStartedEventAttributesOrBuilder, Serializable

@Generated(value="protoc", comments="annotations:WorkflowTaskStartedEventAttributes.java.pb.meta") public final class WorkflowTaskStartedEventAttributes extends com.google.protobuf.GeneratedMessageV3 implements WorkflowTaskStartedEventAttributesOrBuilder
Protobuf type temporal.api.history.v1.WorkflowTaskStartedEventAttributes
See Also:
  • Field Details

    • SCHEDULED_EVENT_ID_FIELD_NUMBER

      public static final int SCHEDULED_EVENT_ID_FIELD_NUMBER
      See Also:
    • IDENTITY_FIELD_NUMBER

      public static final int IDENTITY_FIELD_NUMBER
      See Also:
    • REQUEST_ID_FIELD_NUMBER

      public static final int REQUEST_ID_FIELD_NUMBER
      See Also:
    • SUGGEST_CONTINUE_AS_NEW_FIELD_NUMBER

      public static final int SUGGEST_CONTINUE_AS_NEW_FIELD_NUMBER
      See Also:
    • SUGGEST_CONTINUE_AS_NEW_REASONS_FIELD_NUMBER

      public static final int SUGGEST_CONTINUE_AS_NEW_REASONS_FIELD_NUMBER
      See Also:
    • TARGET_WORKER_DEPLOYMENT_VERSION_CHANGED_FIELD_NUMBER

      public static final int TARGET_WORKER_DEPLOYMENT_VERSION_CHANGED_FIELD_NUMBER
      See Also:
    • HISTORY_SIZE_BYTES_FIELD_NUMBER

      public static final int HISTORY_SIZE_BYTES_FIELD_NUMBER
      See Also:
    • WORKER_VERSION_FIELD_NUMBER

      public static final int WORKER_VERSION_FIELD_NUMBER
      See Also:
    • BUILD_ID_REDIRECT_COUNTER_FIELD_NUMBER

      public static final int BUILD_ID_REDIRECT_COUNTER_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
    • getScheduledEventId

      public long getScheduledEventId()
       The id of the `WORKFLOW_TASK_SCHEDULED` event this task corresponds to
       
      int64 scheduled_event_id = 1;
      Specified by:
      getScheduledEventId in interface WorkflowTaskStartedEventAttributesOrBuilder
      Returns:
      The scheduledEventId.
    • getIdentity

      public String getIdentity()
       Identity of the worker who picked up this task
       
      string identity = 2;
      Specified by:
      getIdentity in interface WorkflowTaskStartedEventAttributesOrBuilder
      Returns:
      The identity.
    • getIdentityBytes

      public com.google.protobuf.ByteString getIdentityBytes()
       Identity of the worker who picked up this task
       
      string identity = 2;
      Specified by:
      getIdentityBytes in interface WorkflowTaskStartedEventAttributesOrBuilder
      Returns:
      The bytes for identity.
    • getRequestId

      public String getRequestId()
       This field is populated from the RecordWorkflowTaskStartedRequest. Matching service would
       set the request_id on the RecordWorkflowTaskStartedRequest to a new UUID. This is useful
       in case a RecordWorkflowTaskStarted call succeed but matching doesn't get that response,
       so matching could retry and history service would return success if the request_id matches.
       In that case, matching will continue to deliver the task to worker. Without this field, history
       service would return AlreadyStarted error, and matching would drop the task.
       
      string request_id = 3;
      Specified by:
      getRequestId in interface WorkflowTaskStartedEventAttributesOrBuilder
      Returns:
      The requestId.
    • getRequestIdBytes

      public com.google.protobuf.ByteString getRequestIdBytes()
       This field is populated from the RecordWorkflowTaskStartedRequest. Matching service would
       set the request_id on the RecordWorkflowTaskStartedRequest to a new UUID. This is useful
       in case a RecordWorkflowTaskStarted call succeed but matching doesn't get that response,
       so matching could retry and history service would return success if the request_id matches.
       In that case, matching will continue to deliver the task to worker. Without this field, history
       service would return AlreadyStarted error, and matching would drop the task.
       
      string request_id = 3;
      Specified by:
      getRequestIdBytes in interface WorkflowTaskStartedEventAttributesOrBuilder
      Returns:
      The bytes for requestId.
    • getSuggestContinueAsNew

      public boolean getSuggestContinueAsNew()
       True if this workflow should continue-as-new soon. See `suggest_continue_as_new_reasons` for why.
       
      bool suggest_continue_as_new = 4;
      Specified by:
      getSuggestContinueAsNew in interface WorkflowTaskStartedEventAttributesOrBuilder
      Returns:
      The suggestContinueAsNew.
    • getSuggestContinueAsNewReasonsList

      public List<SuggestContinueAsNewReason> getSuggestContinueAsNewReasonsList()
       The reason(s) that suggest_continue_as_new is true, if it is.
       Unset if suggest_continue_as_new is false.
       
      repeated .temporal.api.enums.v1.SuggestContinueAsNewReason suggest_continue_as_new_reasons = 8;
      Specified by:
      getSuggestContinueAsNewReasonsList in interface WorkflowTaskStartedEventAttributesOrBuilder
      Returns:
      A list containing the suggestContinueAsNewReasons.
    • getSuggestContinueAsNewReasonsCount

      public int getSuggestContinueAsNewReasonsCount()
       The reason(s) that suggest_continue_as_new is true, if it is.
       Unset if suggest_continue_as_new is false.
       
      repeated .temporal.api.enums.v1.SuggestContinueAsNewReason suggest_continue_as_new_reasons = 8;
      Specified by:
      getSuggestContinueAsNewReasonsCount in interface WorkflowTaskStartedEventAttributesOrBuilder
      Returns:
      The count of suggestContinueAsNewReasons.
    • getSuggestContinueAsNewReasons

      public SuggestContinueAsNewReason getSuggestContinueAsNewReasons(int index)
       The reason(s) that suggest_continue_as_new is true, if it is.
       Unset if suggest_continue_as_new is false.
       
      repeated .temporal.api.enums.v1.SuggestContinueAsNewReason suggest_continue_as_new_reasons = 8;
      Specified by:
      getSuggestContinueAsNewReasons in interface WorkflowTaskStartedEventAttributesOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The suggestContinueAsNewReasons at the given index.
    • getSuggestContinueAsNewReasonsValueList

      public List<Integer> getSuggestContinueAsNewReasonsValueList()
       The reason(s) that suggest_continue_as_new is true, if it is.
       Unset if suggest_continue_as_new is false.
       
      repeated .temporal.api.enums.v1.SuggestContinueAsNewReason suggest_continue_as_new_reasons = 8;
      Specified by:
      getSuggestContinueAsNewReasonsValueList in interface WorkflowTaskStartedEventAttributesOrBuilder
      Returns:
      A list containing the enum numeric values on the wire for suggestContinueAsNewReasons.
    • getSuggestContinueAsNewReasonsValue

      public int getSuggestContinueAsNewReasonsValue(int index)
       The reason(s) that suggest_continue_as_new is true, if it is.
       Unset if suggest_continue_as_new is false.
       
      repeated .temporal.api.enums.v1.SuggestContinueAsNewReason suggest_continue_as_new_reasons = 8;
      Specified by:
      getSuggestContinueAsNewReasonsValue in interface WorkflowTaskStartedEventAttributesOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of suggestContinueAsNewReasons at the given index.
    • getTargetWorkerDeploymentVersionChanged

      public boolean getTargetWorkerDeploymentVersionChanged()
       True if Workflow's Target Worker Deployment Version is different from its Pinned Version and
       the workflow is Pinned.
       Experimental.
       
      bool target_worker_deployment_version_changed = 9;
      Specified by:
      getTargetWorkerDeploymentVersionChanged in interface WorkflowTaskStartedEventAttributesOrBuilder
      Returns:
      The targetWorkerDeploymentVersionChanged.
    • getHistorySizeBytes

      public long getHistorySizeBytes()
       Total history size in bytes, which the workflow might use to decide when to
       continue-as-new regardless of the suggestion. Note that history event count is
       just the event id of this event, so we don't include it explicitly here.
       
      int64 history_size_bytes = 5;
      Specified by:
      getHistorySizeBytes in interface WorkflowTaskStartedEventAttributesOrBuilder
      Returns:
      The historySizeBytes.
    • hasWorkerVersion

      @Deprecated public boolean hasWorkerVersion()
      Deprecated.
      temporal.api.history.v1.WorkflowTaskStartedEventAttributes.worker_version is deprecated. See temporal/api/history/v1/message.proto;l=333
       Version info of the worker to whom this task was dispatched.
       Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
       
      .temporal.api.common.v1.WorkerVersionStamp worker_version = 6 [deprecated = true];
      Specified by:
      hasWorkerVersion in interface WorkflowTaskStartedEventAttributesOrBuilder
      Returns:
      Whether the workerVersion field is set.
    • getWorkerVersion

      @Deprecated public WorkerVersionStamp getWorkerVersion()
      Deprecated.
      temporal.api.history.v1.WorkflowTaskStartedEventAttributes.worker_version is deprecated. See temporal/api/history/v1/message.proto;l=333
       Version info of the worker to whom this task was dispatched.
       Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
       
      .temporal.api.common.v1.WorkerVersionStamp worker_version = 6 [deprecated = true];
      Specified by:
      getWorkerVersion in interface WorkflowTaskStartedEventAttributesOrBuilder
      Returns:
      The workerVersion.
    • getWorkerVersionOrBuilder

      @Deprecated public WorkerVersionStampOrBuilder getWorkerVersionOrBuilder()
      Deprecated.
       Version info of the worker to whom this task was dispatched.
       Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
       
      .temporal.api.common.v1.WorkerVersionStamp worker_version = 6 [deprecated = true];
      Specified by:
      getWorkerVersionOrBuilder in interface WorkflowTaskStartedEventAttributesOrBuilder
    • getBuildIdRedirectCounter

      @Deprecated public long getBuildIdRedirectCounter()
      Deprecated.
      temporal.api.history.v1.WorkflowTaskStartedEventAttributes.build_id_redirect_counter is deprecated. See temporal/api/history/v1/message.proto;l=337
       Used by server internally to properly reapply build ID redirects to an execution
       when rebuilding it from events.
       Deprecated. This field should be cleaned up when versioning-2 API is removed. [cleanup-experimental-wv]
       
      int64 build_id_redirect_counter = 7 [deprecated = true];
      Specified by:
      getBuildIdRedirectCounter in interface WorkflowTaskStartedEventAttributesOrBuilder
      Returns:
      The buildIdRedirectCounter.
    • 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 WorkflowTaskStartedEventAttributes parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static WorkflowTaskStartedEventAttributes parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static WorkflowTaskStartedEventAttributes parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

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

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

      public static WorkflowTaskStartedEventAttributes parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

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

      public static WorkflowTaskStartedEventAttributes parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

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

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

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

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

      public static WorkflowTaskStartedEventAttributes.Builder newBuilder()
    • newBuilder

    • toBuilder

      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected WorkflowTaskStartedEventAttributes.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3
    • getDefaultInstance

      public static WorkflowTaskStartedEventAttributes getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<WorkflowTaskStartedEventAttributes> parser()
    • getParserForType

      public com.google.protobuf.Parser<WorkflowTaskStartedEventAttributes> 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 WorkflowTaskStartedEventAttributes getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder