Interface StatusOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Status, Status.Builder

    public interface StatusOrBuilder
    extends com.google.protobuf.MessageOrBuilder
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Code getCode()
      The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
      int getCodeValue()
      The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
      com.google.protobuf.Any getDetails()
      A list of messages that carry the error details.
      com.google.protobuf.AnyOrBuilder getDetailsOrBuilder()
      A list of messages that carry the error details.
      java.lang.String getMessage()
      A developer-facing error message, which should be in English.
      com.google.protobuf.ByteString getMessageBytes()
      A developer-facing error message, which should be in English.
      boolean hasDetails()
      A list of messages that carry the error details.
      • 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

      • getCodeValue

        int getCodeValue()
         The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
         
        .google.rpc.Code code = 1;
        Returns:
        The enum numeric value on the wire for code.
      • getCode

        Code getCode()
         The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
         
        .google.rpc.Code code = 1;
        Returns:
        The code.
      • getMessage

        java.lang.String getMessage()
         A developer-facing error message, which should be in English. Any
         user-facing error message should be localized and sent in the
         [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
         
        string message = 2;
        Returns:
        The message.
      • getMessageBytes

        com.google.protobuf.ByteString getMessageBytes()
         A developer-facing error message, which should be in English. Any
         user-facing error message should be localized and sent in the
         [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
         
        string message = 2;
        Returns:
        The bytes for message.
      • hasDetails

        boolean hasDetails()
         A list of messages that carry the error details.  There is a common set of
         message types for APIs to use.
         
        .google.protobuf.Any details = 3;
        Returns:
        Whether the details field is set.
      • getDetails

        com.google.protobuf.Any getDetails()
         A list of messages that carry the error details.  There is a common set of
         message types for APIs to use.
         
        .google.protobuf.Any details = 3;
        Returns:
        The details.
      • getDetailsOrBuilder

        com.google.protobuf.AnyOrBuilder getDetailsOrBuilder()
         A list of messages that carry the error details.  There is a common set of
         message types for APIs to use.
         
        .google.protobuf.Any details = 3;