Package io.temporal.api.workflowservice.v1

Class UpdateWorkflowExecutionRequest

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, UpdateWorkflowExecutionRequestOrBuilder, java.io.Serializable
    @Generated(value="protoc",
           comments="annotations:UpdateWorkflowExecutionRequest.java.pb.meta")
public final class UpdateWorkflowExecutionRequest
extends com.google.protobuf.GeneratedMessageV3
implements UpdateWorkflowExecutionRequestOrBuilder
     (-- api-linter: core::0134=disabled
     aip.dev/not-precedent: Update RPCs don't follow Google API format. --)
    Protobuf type temporal.api.workflowservice.v1.UpdateWorkflowExecutionRequest
    See Also:
    Serialized Form

    • Field Detail

      • WORKFLOW_EXECUTION_FIELD_NUMBER

        public static final int WORKFLOW_EXECUTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FIRST_EXECUTION_RUN_ID_FIELD_NUMBER

        public static final int FIRST_EXECUTION_RUN_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

      • WAIT_POLICY_FIELD_NUMBER

        public static final int WAIT_POLICY_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

      • 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

      • hasWorkflowExecution

        public boolean hasWorkflowExecution()
         The target Workflow Id and (optionally) a specific Run Id thereof.
 (-- api-linter: core::0203::optional=disabled
     aip.dev/not-precedent: false positive triggered by the word "optional" --)
        .temporal.api.common.v1.WorkflowExecution workflow_execution = 2;
        Specified by:
        hasWorkflowExecution in interface UpdateWorkflowExecutionRequestOrBuilder
        Returns:
        Whether the workflowExecution field is set.

      • getWorkflowExecution

        public WorkflowExecution getWorkflowExecution()
         The target Workflow Id and (optionally) a specific Run Id thereof.
 (-- api-linter: core::0203::optional=disabled
     aip.dev/not-precedent: false positive triggered by the word "optional" --)
        .temporal.api.common.v1.WorkflowExecution workflow_execution = 2;
        Specified by:
        getWorkflowExecution in interface UpdateWorkflowExecutionRequestOrBuilder
        Returns:
        The workflowExecution.

      • getFirstExecutionRunId

        public java.lang.String getFirstExecutionRunId()
         If set, this call will error if the most recent (if no Run Id is set on
 `workflow_execution`), or specified (if it is) Workflow Execution is not
 part of the same execution chain as this Id.
        string first_execution_run_id = 3;
        Specified by:
        getFirstExecutionRunId in interface UpdateWorkflowExecutionRequestOrBuilder
        Returns:
        The firstExecutionRunId.

      • getFirstExecutionRunIdBytes

        public com.google.protobuf.ByteString getFirstExecutionRunIdBytes()
         If set, this call will error if the most recent (if no Run Id is set on
 `workflow_execution`), or specified (if it is) Workflow Execution is not
 part of the same execution chain as this Id.
        string first_execution_run_id = 3;
        Specified by:
        getFirstExecutionRunIdBytes in interface UpdateWorkflowExecutionRequestOrBuilder
        Returns:
        The bytes for firstExecutionRunId.

      • hasWaitPolicy

        public boolean hasWaitPolicy()
         Specifies client's intent to wait for Update results.
 NOTE: This field works together with API call timeout which is limited by
 server timeout (maximum wait time). If server timeout is expired before
 user specified timeout, API call returns even if specified stage is not reached.
 Actual reached stage will be included in the response.
        .temporal.api.update.v1.WaitPolicy wait_policy = 4;
        Specified by:
        hasWaitPolicy in interface UpdateWorkflowExecutionRequestOrBuilder
        Returns:
        Whether the waitPolicy field is set.

      • getWaitPolicy

        public WaitPolicy getWaitPolicy()
         Specifies client's intent to wait for Update results.
 NOTE: This field works together with API call timeout which is limited by
 server timeout (maximum wait time). If server timeout is expired before
 user specified timeout, API call returns even if specified stage is not reached.
 Actual reached stage will be included in the response.
        .temporal.api.update.v1.WaitPolicy wait_policy = 4;
        Specified by:
        getWaitPolicy in interface UpdateWorkflowExecutionRequestOrBuilder
        Returns:
        The waitPolicy.

      • getWaitPolicyOrBuilder

        public WaitPolicyOrBuilder getWaitPolicyOrBuilder()
         Specifies client's intent to wait for Update results.
 NOTE: This field works together with API call timeout which is limited by
 server timeout (maximum wait time). If server timeout is expired before
 user specified timeout, API call returns even if specified stage is not reached.
 Actual reached stage will be included in the response.
        .temporal.api.update.v1.WaitPolicy wait_policy = 4;
        Specified by:
        getWaitPolicyOrBuilder in interface UpdateWorkflowExecutionRequestOrBuilder

      • hasRequest

        public boolean hasRequest()
         The request information that will be delivered all the way down to the
 Workflow Execution.
        .temporal.api.update.v1.Request request = 5;
        Specified by:
        hasRequest in interface UpdateWorkflowExecutionRequestOrBuilder
        Returns:
        Whether the request field is set.

      • getRequest

        public Request getRequest()
         The request information that will be delivered all the way down to the
 Workflow Execution.
        .temporal.api.update.v1.Request request = 5;
        Specified by:
        getRequest in interface UpdateWorkflowExecutionRequestOrBuilder
        Returns:
        The request.

      • 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 UpdateWorkflowExecutionRequest parseFrom​(java.nio.ByteBuffer data)
                                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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