Package io.temporal.api.failure.v1

Interface FailureOrBuilder

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

    • Method Detail

      • getMessage

        java.lang.String getMessage()
        string message = 1;
        Returns:
        The message.

      • getMessageBytes

        com.google.protobuf.ByteString getMessageBytes()
        string message = 1;
        Returns:
        The bytes for message.

      • getSource

        java.lang.String getSource()
         The source this Failure originated in, e.g. TypeScriptSDK / JavaSDK
 In some SDKs this is used to rehydrate the stack trace into an exception object.
        string source = 2;
        Returns:
        The source.

      • getSourceBytes

        com.google.protobuf.ByteString getSourceBytes()
         The source this Failure originated in, e.g. TypeScriptSDK / JavaSDK
 In some SDKs this is used to rehydrate the stack trace into an exception object.
        string source = 2;
        Returns:
        The bytes for source.

      • getStackTrace

        java.lang.String getStackTrace()
        string stack_trace = 3;
        Returns:
        The stackTrace.

      • getStackTraceBytes

        com.google.protobuf.ByteString getStackTraceBytes()
        string stack_trace = 3;
        Returns:
        The bytes for stackTrace.

      • hasEncodedAttributes

        boolean hasEncodedAttributes()
         Alternative way to supply `message` and `stack_trace` and possibly other attributes, used for encryption of
 errors originating in user code which might contain sensitive information.
 The `encoded_attributes` Payload could represent any serializable object, e.g. JSON object or a `Failure` proto
 message.

 SDK authors:
 - The SDK should provide a default `encodeFailureAttributes` and `decodeFailureAttributes` implementation that:
   - Uses a JSON object to represent `{ message, stack_trace }`.
   - Overwrites the original message with "Encoded failure" to indicate that more information could be extracted.
   - Overwrites the original stack_trace with an empty string.
   - The resulting JSON object is converted to Payload using the default PayloadConverter and should be processed
     by the user-provided PayloadCodec

 - If there's demand, we could allow overriding the default SDK implementation to encode other opaque Failure attributes.
 (-- api-linter: core::0203::optional=disabled --)
        .temporal.api.common.v1.Payload encoded_attributes = 20;
        Returns:
        Whether the encodedAttributes field is set.

      • getEncodedAttributes

        Payload getEncodedAttributes()
         Alternative way to supply `message` and `stack_trace` and possibly other attributes, used for encryption of
 errors originating in user code which might contain sensitive information.
 The `encoded_attributes` Payload could represent any serializable object, e.g. JSON object or a `Failure` proto
 message.

 SDK authors:
 - The SDK should provide a default `encodeFailureAttributes` and `decodeFailureAttributes` implementation that:
   - Uses a JSON object to represent `{ message, stack_trace }`.
   - Overwrites the original message with "Encoded failure" to indicate that more information could be extracted.
   - Overwrites the original stack_trace with an empty string.
   - The resulting JSON object is converted to Payload using the default PayloadConverter and should be processed
     by the user-provided PayloadCodec

 - If there's demand, we could allow overriding the default SDK implementation to encode other opaque Failure attributes.
 (-- api-linter: core::0203::optional=disabled --)
        .temporal.api.common.v1.Payload encoded_attributes = 20;
        Returns:
        The encodedAttributes.

      • getEncodedAttributesOrBuilder

        PayloadOrBuilder getEncodedAttributesOrBuilder()
         Alternative way to supply `message` and `stack_trace` and possibly other attributes, used for encryption of
 errors originating in user code which might contain sensitive information.
 The `encoded_attributes` Payload could represent any serializable object, e.g. JSON object or a `Failure` proto
 message.

 SDK authors:
 - The SDK should provide a default `encodeFailureAttributes` and `decodeFailureAttributes` implementation that:
   - Uses a JSON object to represent `{ message, stack_trace }`.
   - Overwrites the original message with "Encoded failure" to indicate that more information could be extracted.
   - Overwrites the original stack_trace with an empty string.
   - The resulting JSON object is converted to Payload using the default PayloadConverter and should be processed
     by the user-provided PayloadCodec

 - If there's demand, we could allow overriding the default SDK implementation to encode other opaque Failure attributes.
 (-- api-linter: core::0203::optional=disabled --)
        .temporal.api.common.v1.Payload encoded_attributes = 20;

      • hasCause

        boolean hasCause()
        .temporal.api.failure.v1.Failure cause = 4;
        Returns:
        Whether the cause field is set.

      • getCause

        Failure getCause()
        .temporal.api.failure.v1.Failure cause = 4;
        Returns:
        The cause.

      • getCauseOrBuilder

        FailureOrBuilder getCauseOrBuilder()
        .temporal.api.failure.v1.Failure cause = 4;

      • hasApplicationFailureInfo

        boolean hasApplicationFailureInfo()
        .temporal.api.failure.v1.ApplicationFailureInfo application_failure_info = 5;
        Returns:
        Whether the applicationFailureInfo field is set.

      • getApplicationFailureInfo

        ApplicationFailureInfo getApplicationFailureInfo()
        .temporal.api.failure.v1.ApplicationFailureInfo application_failure_info = 5;
        Returns:
        The applicationFailureInfo.

      • getApplicationFailureInfoOrBuilder

        ApplicationFailureInfoOrBuilder getApplicationFailureInfoOrBuilder()
        .temporal.api.failure.v1.ApplicationFailureInfo application_failure_info = 5;

      • hasTimeoutFailureInfo

        boolean hasTimeoutFailureInfo()
        .temporal.api.failure.v1.TimeoutFailureInfo timeout_failure_info = 6;
        Returns:
        Whether the timeoutFailureInfo field is set.

      • getTimeoutFailureInfo

        TimeoutFailureInfo getTimeoutFailureInfo()
        .temporal.api.failure.v1.TimeoutFailureInfo timeout_failure_info = 6;
        Returns:
        The timeoutFailureInfo.

      • getTimeoutFailureInfoOrBuilder

        TimeoutFailureInfoOrBuilder getTimeoutFailureInfoOrBuilder()
        .temporal.api.failure.v1.TimeoutFailureInfo timeout_failure_info = 6;

      • hasCanceledFailureInfo

        boolean hasCanceledFailureInfo()
        .temporal.api.failure.v1.CanceledFailureInfo canceled_failure_info = 7;
        Returns:
        Whether the canceledFailureInfo field is set.

      • getCanceledFailureInfo

        CanceledFailureInfo getCanceledFailureInfo()
        .temporal.api.failure.v1.CanceledFailureInfo canceled_failure_info = 7;
        Returns:
        The canceledFailureInfo.

      • getCanceledFailureInfoOrBuilder

        CanceledFailureInfoOrBuilder getCanceledFailureInfoOrBuilder()
        .temporal.api.failure.v1.CanceledFailureInfo canceled_failure_info = 7;

      • hasTerminatedFailureInfo

        boolean hasTerminatedFailureInfo()
        .temporal.api.failure.v1.TerminatedFailureInfo terminated_failure_info = 8;
        Returns:
        Whether the terminatedFailureInfo field is set.

      • getTerminatedFailureInfo

        TerminatedFailureInfo getTerminatedFailureInfo()
        .temporal.api.failure.v1.TerminatedFailureInfo terminated_failure_info = 8;
        Returns:
        The terminatedFailureInfo.

      • getTerminatedFailureInfoOrBuilder

        TerminatedFailureInfoOrBuilder getTerminatedFailureInfoOrBuilder()
        .temporal.api.failure.v1.TerminatedFailureInfo terminated_failure_info = 8;

      • hasServerFailureInfo

        boolean hasServerFailureInfo()
        .temporal.api.failure.v1.ServerFailureInfo server_failure_info = 9;
        Returns:
        Whether the serverFailureInfo field is set.

      • getServerFailureInfo

        ServerFailureInfo getServerFailureInfo()
        .temporal.api.failure.v1.ServerFailureInfo server_failure_info = 9;
        Returns:
        The serverFailureInfo.

      • getServerFailureInfoOrBuilder

        ServerFailureInfoOrBuilder getServerFailureInfoOrBuilder()
        .temporal.api.failure.v1.ServerFailureInfo server_failure_info = 9;

      • hasResetWorkflowFailureInfo

        boolean hasResetWorkflowFailureInfo()
        .temporal.api.failure.v1.ResetWorkflowFailureInfo reset_workflow_failure_info = 10;
        Returns:
        Whether the resetWorkflowFailureInfo field is set.

      • getResetWorkflowFailureInfo

        ResetWorkflowFailureInfo getResetWorkflowFailureInfo()
        .temporal.api.failure.v1.ResetWorkflowFailureInfo reset_workflow_failure_info = 10;
        Returns:
        The resetWorkflowFailureInfo.

      • getResetWorkflowFailureInfoOrBuilder

        ResetWorkflowFailureInfoOrBuilder getResetWorkflowFailureInfoOrBuilder()
        .temporal.api.failure.v1.ResetWorkflowFailureInfo reset_workflow_failure_info = 10;

      • hasActivityFailureInfo

        boolean hasActivityFailureInfo()
        .temporal.api.failure.v1.ActivityFailureInfo activity_failure_info = 11;
        Returns:
        Whether the activityFailureInfo field is set.

      • getActivityFailureInfo

        ActivityFailureInfo getActivityFailureInfo()
        .temporal.api.failure.v1.ActivityFailureInfo activity_failure_info = 11;
        Returns:
        The activityFailureInfo.

      • getActivityFailureInfoOrBuilder

        ActivityFailureInfoOrBuilder getActivityFailureInfoOrBuilder()
        .temporal.api.failure.v1.ActivityFailureInfo activity_failure_info = 11;

      • hasChildWorkflowExecutionFailureInfo

        boolean hasChildWorkflowExecutionFailureInfo()
        .temporal.api.failure.v1.ChildWorkflowExecutionFailureInfo child_workflow_execution_failure_info = 12;
        Returns:
        Whether the childWorkflowExecutionFailureInfo field is set.

      • getChildWorkflowExecutionFailureInfo

        ChildWorkflowExecutionFailureInfo getChildWorkflowExecutionFailureInfo()
        .temporal.api.failure.v1.ChildWorkflowExecutionFailureInfo child_workflow_execution_failure_info = 12;
        Returns:
        The childWorkflowExecutionFailureInfo.

      • getChildWorkflowExecutionFailureInfoOrBuilder

        ChildWorkflowExecutionFailureInfoOrBuilder getChildWorkflowExecutionFailureInfoOrBuilder()
        .temporal.api.failure.v1.ChildWorkflowExecutionFailureInfo child_workflow_execution_failure_info = 12;

      • hasNexusOperationExecutionFailureInfo

        boolean hasNexusOperationExecutionFailureInfo()
        .temporal.api.failure.v1.NexusOperationFailureInfo nexus_operation_execution_failure_info = 13;
        Returns:
        Whether the nexusOperationExecutionFailureInfo field is set.

      • getNexusOperationExecutionFailureInfo

        NexusOperationFailureInfo getNexusOperationExecutionFailureInfo()
        .temporal.api.failure.v1.NexusOperationFailureInfo nexus_operation_execution_failure_info = 13;
        Returns:
        The nexusOperationExecutionFailureInfo.

      • getNexusOperationExecutionFailureInfoOrBuilder

        NexusOperationFailureInfoOrBuilder getNexusOperationExecutionFailureInfoOrBuilder()
        .temporal.api.failure.v1.NexusOperationFailureInfo nexus_operation_execution_failure_info = 13;

      • hasNexusHandlerFailureInfo

        boolean hasNexusHandlerFailureInfo()
        .temporal.api.failure.v1.NexusHandlerFailureInfo nexus_handler_failure_info = 14;
        Returns:
        Whether the nexusHandlerFailureInfo field is set.

      • getNexusHandlerFailureInfo

        NexusHandlerFailureInfo getNexusHandlerFailureInfo()
        .temporal.api.failure.v1.NexusHandlerFailureInfo nexus_handler_failure_info = 14;
        Returns:
        The nexusHandlerFailureInfo.

      • getNexusHandlerFailureInfoOrBuilder

        NexusHandlerFailureInfoOrBuilder getNexusHandlerFailureInfoOrBuilder()
        .temporal.api.failure.v1.NexusHandlerFailureInfo nexus_handler_failure_info = 14;