Package io.temporal.api.workflowservice.v1

Interface UpdateWorkflowExecutionRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    UpdateWorkflowExecutionRequest, UpdateWorkflowExecutionRequest.Builder
    @Generated(value="protoc",
           comments="annotations:UpdateWorkflowExecutionRequestOrBuilder.java.pb.meta")
public interface UpdateWorkflowExecutionRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      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.
      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.
      java.lang.String getNamespace()
      The namespace name of the target Workflow.
      com.google.protobuf.ByteString getNamespaceBytes()
      The namespace name of the target Workflow.
      Request getRequest()
      The request information that will be delivered all the way down to the Workflow Execution.
      RequestOrBuilder getRequestOrBuilder()
      The request information that will be delivered all the way down to the Workflow Execution.
      WaitPolicy getWaitPolicy()
      Specifies client's intent to wait for Update results.
      WaitPolicyOrBuilder getWaitPolicyOrBuilder()
      Specifies client's intent to wait for Update results.
      WorkflowExecution getWorkflowExecution()
      The target Workflow Id and (optionally) a specific Run Id thereof.
      WorkflowExecutionOrBuilder getWorkflowExecutionOrBuilder()
      The target Workflow Id and (optionally) a specific Run Id thereof.
      boolean hasRequest()
      The request information that will be delivered all the way down to the Workflow Execution.
      boolean hasWaitPolicy()
      Specifies client's intent to wait for Update results.
      boolean hasWorkflowExecution()
      The target Workflow Id and (optionally) a specific Run Id thereof.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getNamespace

        java.lang.String getNamespace()
         The namespace name of the target Workflow.
        string namespace = 1;
        Returns:
        The namespace.

      • getNamespaceBytes

        com.google.protobuf.ByteString getNamespaceBytes()
         The namespace name of the target Workflow.
        string namespace = 1;
        Returns:
        The bytes for namespace.

      • hasWorkflowExecution

        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;
        Returns:
        Whether the workflowExecution field is set.

      • getWorkflowExecution

        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;
        Returns:
        The workflowExecution.

      • getWorkflowExecutionOrBuilder

        WorkflowExecutionOrBuilder getWorkflowExecutionOrBuilder()
         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;

      • getFirstExecutionRunId

        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;
        Returns:
        The firstExecutionRunId.

      • getFirstExecutionRunIdBytes

        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;
        Returns:
        The bytes for firstExecutionRunId.

      • hasWaitPolicy

        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;
        Returns:
        Whether the waitPolicy field is set.

      • getWaitPolicy

        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;
        Returns:
        The waitPolicy.

      • getWaitPolicyOrBuilder

        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;

      • hasRequest

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

      • getRequest

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

      • getRequestOrBuilder

        RequestOrBuilder getRequestOrBuilder()
         The request information that will be delivered all the way down to the
 Workflow Execution.
        .temporal.api.update.v1.Request request = 5;