Package io.temporal.api.cloud.operation.v1

Interface AsyncOperationOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      com.google.protobuf.Duration getCheckDuration()
      The recommended duration to check back for an update in the operation's state.
      com.google.protobuf.DurationOrBuilder getCheckDurationOrBuilder()
      The recommended duration to check back for an update in the operation's state.
      java.lang.String getFailureReason()
      If the operation failed, the reason for the failure.
      com.google.protobuf.ByteString getFailureReasonBytes()
      If the operation failed, the reason for the failure.
      com.google.protobuf.Timestamp getFinishedTime()
      The date and time when the operation completed.
      com.google.protobuf.TimestampOrBuilder getFinishedTimeOrBuilder()
      The date and time when the operation completed.
      java.lang.String getId()
      The operation id.
      com.google.protobuf.ByteString getIdBytes()
      The operation id.
      com.google.protobuf.Any getOperationInput()
      The input to the operation being performed.
      com.google.protobuf.AnyOrBuilder getOperationInputOrBuilder()
      The input to the operation being performed.
      java.lang.String getOperationType()
      The type of operation being performed.
      com.google.protobuf.ByteString getOperationTypeBytes()
      The type of operation being performed.
      com.google.protobuf.Timestamp getStartedTime()
      The date and time when the operation initiated.
      com.google.protobuf.TimestampOrBuilder getStartedTimeOrBuilder()
      The date and time when the operation initiated.
      AsyncOperation.State getState()
      The current state of this operation.
      java.lang.String getStateDeprecated()
      Deprecated.
      temporal.api.cloud.operation.v1.AsyncOperation.state_deprecated is deprecated.
      com.google.protobuf.ByteString getStateDeprecatedBytes()
      Deprecated.
      temporal.api.cloud.operation.v1.AsyncOperation.state_deprecated is deprecated.
      int getStateValue()
      The current state of this operation.
      boolean hasCheckDuration()
      The recommended duration to check back for an update in the operation's state.
      boolean hasFinishedTime()
      The date and time when the operation completed.
      boolean hasOperationInput()
      The input to the operation being performed.
      boolean hasStartedTime()
      The date and time when the operation initiated.

      • 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

      • getId

        java.lang.String getId()
         The operation id.
        string id = 1;
        Returns:
        The id.

      • getIdBytes

        com.google.protobuf.ByteString getIdBytes()
         The operation id.
        string id = 1;
        Returns:
        The bytes for id.

      • getStateDeprecated

        @Deprecated
java.lang.String getStateDeprecated()
        Deprecated.
        temporal.api.cloud.operation.v1.AsyncOperation.state_deprecated is deprecated. See temporal/api/cloud/operation/v1/message.proto;l=22
         The current state of this operation.
 Possible values are: pending, in_progress, failed, cancelled, fulfilled.
 Deprecated: Not supported after 2024-10-01-00 api version. Use state instead.
 temporal:versioning:max_version=2024-10-01-00
        string state_deprecated = 2 [deprecated = true];
        Returns:
        The stateDeprecated.

      • getStateDeprecatedBytes

        @Deprecated
com.google.protobuf.ByteString getStateDeprecatedBytes()
        Deprecated.
        temporal.api.cloud.operation.v1.AsyncOperation.state_deprecated is deprecated. See temporal/api/cloud/operation/v1/message.proto;l=22
         The current state of this operation.
 Possible values are: pending, in_progress, failed, cancelled, fulfilled.
 Deprecated: Not supported after 2024-10-01-00 api version. Use state instead.
 temporal:versioning:max_version=2024-10-01-00
        string state_deprecated = 2 [deprecated = true];
        Returns:
        The bytes for stateDeprecated.

      • getStateValue

        int getStateValue()
         The current state of this operation.
 temporal:versioning:min_version=2024-10-01-00
 temporal:enums:replaces=state_deprecated
        .temporal.api.cloud.operation.v1.AsyncOperation.State state = 9;
        Returns:
        The enum numeric value on the wire for state.

      • getState

        AsyncOperation.State getState()
         The current state of this operation.
 temporal:versioning:min_version=2024-10-01-00
 temporal:enums:replaces=state_deprecated
        .temporal.api.cloud.operation.v1.AsyncOperation.State state = 9;
        Returns:
        The state.

      • hasCheckDuration

        boolean hasCheckDuration()
         The recommended duration to check back for an update in the operation's state.
        .google.protobuf.Duration check_duration = 3;
        Returns:
        Whether the checkDuration field is set.

      • getCheckDuration

        com.google.protobuf.Duration getCheckDuration()
         The recommended duration to check back for an update in the operation's state.
        .google.protobuf.Duration check_duration = 3;
        Returns:
        The checkDuration.

      • getCheckDurationOrBuilder

        com.google.protobuf.DurationOrBuilder getCheckDurationOrBuilder()
         The recommended duration to check back for an update in the operation's state.
        .google.protobuf.Duration check_duration = 3;

      • getOperationType

        java.lang.String getOperationType()
         The type of operation being performed.
        string operation_type = 4;
        Returns:
        The operationType.

      • getOperationTypeBytes

        com.google.protobuf.ByteString getOperationTypeBytes()
         The type of operation being performed.
        string operation_type = 4;
        Returns:
        The bytes for operationType.

      • hasOperationInput

        boolean hasOperationInput()
         The input to the operation being performed.

 (-- api-linter: core::0146::any=disabled --)
        .google.protobuf.Any operation_input = 5;
        Returns:
        Whether the operationInput field is set.

      • getOperationInput

        com.google.protobuf.Any getOperationInput()
         The input to the operation being performed.

 (-- api-linter: core::0146::any=disabled --)
        .google.protobuf.Any operation_input = 5;
        Returns:
        The operationInput.

      • getOperationInputOrBuilder

        com.google.protobuf.AnyOrBuilder getOperationInputOrBuilder()
         The input to the operation being performed.

 (-- api-linter: core::0146::any=disabled --)
        .google.protobuf.Any operation_input = 5;

      • getFailureReason

        java.lang.String getFailureReason()
         If the operation failed, the reason for the failure.
        string failure_reason = 6;
        Returns:
        The failureReason.

      • getFailureReasonBytes

        com.google.protobuf.ByteString getFailureReasonBytes()
         If the operation failed, the reason for the failure.
        string failure_reason = 6;
        Returns:
        The bytes for failureReason.

      • hasStartedTime

        boolean hasStartedTime()
         The date and time when the operation initiated.
        .google.protobuf.Timestamp started_time = 7;
        Returns:
        Whether the startedTime field is set.

      • getStartedTime

        com.google.protobuf.Timestamp getStartedTime()
         The date and time when the operation initiated.
        .google.protobuf.Timestamp started_time = 7;
        Returns:
        The startedTime.

      • getStartedTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getStartedTimeOrBuilder()
         The date and time when the operation initiated.
        .google.protobuf.Timestamp started_time = 7;

      • hasFinishedTime

        boolean hasFinishedTime()
         The date and time when the operation completed.
        .google.protobuf.Timestamp finished_time = 8;
        Returns:
        Whether the finishedTime field is set.

      • getFinishedTime

        com.google.protobuf.Timestamp getFinishedTime()
         The date and time when the operation completed.
        .google.protobuf.Timestamp finished_time = 8;
        Returns:
        The finishedTime.

      • getFinishedTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getFinishedTimeOrBuilder()
         The date and time when the operation completed.
        .google.protobuf.Timestamp finished_time = 8;