程序包 com.google.rpc

# 类 Status

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.rpc.Status

所有已实现的接口:
  `com.google.protobuf.Message`, `com.google.protobuf.MessageLite`, `com.google.protobuf.MessageLiteOrBuilder`, `com.google.protobuf.MessageOrBuilder`, `StatusOrBuilder`, `Serializable`

public final class Status extends com.google.protobuf.GeneratedMessageV3 implements StatusOrBuilder

     The `Status` type defines a logical error model that is suitable for different
     programming environments, including REST APIs and RPC APIs. It is used by
     [gRPC](https://github.com/grpc). The error model is designed to be:
     - Simple to use and understand for most users
     - Flexible enough to meet unexpected needs
     # Overview
     The `Status` message contains three pieces of data: error code, error message,
     and error details. The error code should be an enum value of
     [google.rpc.Code][google.rpc.Code], but it may accept additional error codes if needed.  The
     error message should be a developer-facing English message that helps
     developers *understand* and *resolve* the error. If a localized user-facing
     error message is needed, put the localized message in the error details or
     localize it in the client. The optional error details may contain arbitrary
     information about the error. There is a predefined set of error detail types
     in the package `google.rpc` that can be used for common error conditions.
     # Language mapping
     The `Status` message is the logical representation of the error model, but it
     is not necessarily the actual wire format. When the `Status` message is
     exposed in different client libraries and different wire protocols, it can be
     mapped differently. For example, it will likely be mapped to some exceptions
     in Java, but more likely mapped to some error codes in C.
     # Other uses
     The error model and the `Status` message can be used in a variety of
     environments, either with or without APIs, to provide a
     consistent developer experience across different environments.
     Example uses of this error model include:
     - Partial errors. If a service needs to return partial errors to the client,
         it may embed the `Status` in the normal response to indicate the partial
         errors.
     - Workflow errors. A typical workflow has multiple steps. Each step may
         have a `Status` message for error reporting.
     - Batch operations. If a client uses batch request and batch response, the
         `Status` message should be used directly inside batch response, one for
         each error sub-response.
     - Asynchronous operations. If an API call embeds asynchronous operation
         results in its response, the status of those operations should be
         represented directly using the `Status` message.
     - Logging. If some API errors are stored in logs, the message `Status` could
         be used directly after any stripping needed for security/privacy reasons.

Protobuf type `google.rpc.Status`

另请参阅:
  序列化表格

- ## 嵌套类概要

  嵌套类
  修饰符和类型
  类
  说明
  `static class`
  `Status.Builder`
  The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.

  ## 从类继承的嵌套类/接口 com.google.protobuf.GeneratedMessageV3

  `com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter`

  ## 从类继承的嵌套类/接口 com.google.protobuf.AbstractMessageLite

  `com.google.protobuf.AbstractMessageLite.InternalOneOfEnum`

- ## 字段概要

  字段
  修饰符和类型
  字段
  说明
  `static int`
  `CODE_FIELD_NUMBER`
  `static int`
  `DETAILS_FIELD_NUMBER`
  `static int`
  `MESSAGE_FIELD_NUMBER`

  ### 从类继承的字段 com.google.protobuf.GeneratedMessageV3

  `alwaysUseFieldBuilders, unknownFields`

  ### 从类继承的字段 com.google.protobuf.AbstractMessage

  `memoizedSize`

  ### 从类继承的字段 com.google.protobuf.AbstractMessageLite

  `memoizedHashCode`

- ## 方法概要

  修饰符和类型
  方法
  说明
  `boolean`
  `equals​(Object obj)`
  `int`
  `getCode()`
  The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
  `static Status`
  `getDefaultInstance()`
  `Status`
  `getDefaultInstanceForType()`
  `static com.google.protobuf.Descriptors.Descriptor`
  `getDescriptor()`
  `com.google.protobuf.Any`
  `getDetails​(int index)`
  A list of messages that carry the error details.
  `int`
  `getDetailsCount()`
  A list of messages that carry the error details.
  `List<com.google.protobuf.Any>`
  `getDetailsList()`
  A list of messages that carry the error details.
  `com.google.protobuf.AnyOrBuilder`
  `getDetailsOrBuilder​(int index)`
  A list of messages that carry the error details.
  `List<? extends com.google.protobuf.AnyOrBuilder>`
  `getDetailsOrBuilderList()`
  A list of messages that carry the error details.
  `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.
  `com.google.protobuf.Parser<Status>`
  `getParserForType()`
  `int`
  `getSerializedSize()`
  `com.google.protobuf.UnknownFieldSet`
  `getUnknownFields()`
  `int`
  `hashCode()`
  `protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`
  `internalGetFieldAccessorTable()`
  `boolean`
  `isInitialized()`
  `static Status.Builder`
  `newBuilder()`
  `static Status.Builder`
  `newBuilder​(Status prototype)`
  `Status.Builder`
  `newBuilderForType()`
  `protected Status.Builder`
  `newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
  `protected Object`
  `newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
  `static Status`
  `parseDelimitedFrom​(InputStream input)`
  `static Status`
  `parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
  `static Status`
  `parseFrom​(byte[] data)`
  `static Status`
  `parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
  `static Status`
  `parseFrom​(com.google.protobuf.ByteString data)`
  `static Status`
  `parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
  `static Status`
  `parseFrom​(com.google.protobuf.CodedInputStream input)`
  `static Status`
  `parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
  `static Status`
  `parseFrom​(InputStream input)`
  `static Status`
  `parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
  `static Status`
  `parseFrom​(ByteBuffer data)`
  `static Status`
  `parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
  `static com.google.protobuf.Parser<Status>`
  `parser()`
  `Status.Builder`
  `toBuilder()`
  `void`
  `writeTo​(com.google.protobuf.CodedOutputStream output)`

  ### 从类继承的方法 com.google.protobuf.GeneratedMessageV3

  `canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag`

  ### 从类继承的方法 com.google.protobuf.AbstractMessage

  `findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString`

  ### 从类继承的方法 com.google.protobuf.AbstractMessageLite

  `addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo`

  ### 从类继承的方法 java.lang.Object

  `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

  ### 从接口继承的方法 com.google.protobuf.MessageLite

  `toByteArray, toByteString, writeDelimitedTo, writeTo`

  ### 从接口继承的方法 com.google.protobuf.MessageOrBuilder

  `findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof`

- ## 字段详细资料

  - ### CODE_FIELD_NUMBER

    public static final int CODE_FIELD_NUMBER
    另请参阅:
      常量字段值

  - ### MESSAGE_FIELD_NUMBER

    public static final int MESSAGE_FIELD_NUMBER
    另请参阅:
      常量字段值

  - ### DETAILS_FIELD_NUMBER

    public static final int DETAILS_FIELD_NUMBER
    另请参阅:
      常量字段值

- ## 方法详细资料

  - ### newInstance

    protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
    覆盖:
      `newInstance` 在类中 `com.google.protobuf.GeneratedMessageV3`

  - ### getUnknownFields

    public final com.google.protobuf.UnknownFieldSet getUnknownFields()
    指定者:
      `getUnknownFields` 在接口中 `com.google.protobuf.MessageOrBuilder`
    覆盖:
      `getUnknownFields` 在类中 `com.google.protobuf.GeneratedMessageV3`

  - ### getDescriptor

    public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

  - ### internalGetFieldAccessorTable

    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
    指定者:
      `internalGetFieldAccessorTable` 在类中 `com.google.protobuf.GeneratedMessageV3`

  - ### getCode

    public int getCode()

         The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

    `int32 code = 1;`
    指定者:
      `getCode` 在接口中 `StatusOrBuilder`
    返回:
      The code.

  - ### getMessage

    public 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;`
    指定者:
      `getMessage` 在接口中 `StatusOrBuilder`
    返回:
      The message.

  - ### getMessageBytes

    public 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;`
    指定者:
      `getMessageBytes` 在接口中 `StatusOrBuilder`
    返回:
      The bytes for message.

  - ### getDetailsList

    public List<com.google.protobuf.Any> getDetailsList()

         A list of messages that carry the error details.  There is a common set of
         message types for APIs to use.

    `repeated .google.protobuf.Any details = 3;`
    指定者:
      `getDetailsList` 在接口中 `StatusOrBuilder`

  - ### getDetailsOrBuilderList

    public List<? extends com.google.protobuf.AnyOrBuilder> getDetailsOrBuilderList()

         A list of messages that carry the error details.  There is a common set of
         message types for APIs to use.

    `repeated .google.protobuf.Any details = 3;`
    指定者:
      `getDetailsOrBuilderList` 在接口中 `StatusOrBuilder`

  - ### getDetailsCount

    public int getDetailsCount()

         A list of messages that carry the error details.  There is a common set of
         message types for APIs to use.

    `repeated .google.protobuf.Any details = 3;`
    指定者:
      `getDetailsCount` 在接口中 `StatusOrBuilder`

  - ### getDetails

    public com.google.protobuf.Any getDetails​(int index)

         A list of messages that carry the error details.  There is a common set of
         message types for APIs to use.

    `repeated .google.protobuf.Any details = 3;`
    指定者:
      `getDetails` 在接口中 `StatusOrBuilder`

  - ### getDetailsOrBuilder

    public com.google.protobuf.AnyOrBuilder getDetailsOrBuilder​(int index)

         A list of messages that carry the error details.  There is a common set of
         message types for APIs to use.

    `repeated .google.protobuf.Any details = 3;`
    指定者:
      `getDetailsOrBuilder` 在接口中 `StatusOrBuilder`

  - ### isInitialized

    public final boolean isInitialized()
    指定者:
      `isInitialized` 在接口中 `com.google.protobuf.MessageLiteOrBuilder`
    覆盖:
      `isInitialized` 在类中 `com.google.protobuf.GeneratedMessageV3`

  - ### writeTo

    public void writeTo​(com.google.protobuf.CodedOutputStream output) throws IOException
    指定者:
      `writeTo` 在接口中 `com.google.protobuf.MessageLite`
    覆盖:
      `writeTo` 在类中 `com.google.protobuf.GeneratedMessageV3`
    抛出:
      `IOException`

  - ### getSerializedSize

    public int getSerializedSize()
    指定者:
      `getSerializedSize` 在接口中 `com.google.protobuf.MessageLite`
    覆盖:
      `getSerializedSize` 在类中 `com.google.protobuf.GeneratedMessageV3`

  - ### equals

    public boolean equals​(Object obj)
    指定者:
      `equals` 在接口中 `com.google.protobuf.Message`
    覆盖:
      `equals` 在类中 `com.google.protobuf.AbstractMessage`

  - ### hashCode

    public int hashCode()
    指定者:
      `hashCode` 在接口中 `com.google.protobuf.Message`
    覆盖:
      `hashCode` 在类中 `com.google.protobuf.AbstractMessage`

  - ### parseFrom

    public static Status parseFrom​(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
    抛出:
      `com.google.protobuf.InvalidProtocolBufferException`

  - ### parseFrom

    public static Status parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
    抛出:
      `com.google.protobuf.InvalidProtocolBufferException`

  - ### parseFrom

    public static Status parseFrom​(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
    抛出:
      `com.google.protobuf.InvalidProtocolBufferException`

  - ### parseFrom

    public static Status parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
    抛出:
      `com.google.protobuf.InvalidProtocolBufferException`

  - ### parseFrom

    public static Status parseFrom​(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
    抛出:
      `com.google.protobuf.InvalidProtocolBufferException`

  - ### parseFrom

    public static Status parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
    抛出:
      `com.google.protobuf.InvalidProtocolBufferException`

  - ### parseFrom

    public static Status parseFrom​(InputStream input) throws IOException
    抛出:
      `IOException`

  - ### parseFrom

    public static Status parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
    抛出:
      `IOException`

  - ### parseDelimitedFrom

    public static Status parseDelimitedFrom​(InputStream input) throws IOException
    抛出:
      `IOException`

  - ### parseDelimitedFrom

    public static Status parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
    抛出:
      `IOException`

  - ### parseFrom

    public static Status parseFrom​(com.google.protobuf.CodedInputStream input) throws IOException
    抛出:
      `IOException`

  - ### parseFrom

    public static Status parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
    抛出:
      `IOException`

  - ### newBuilderForType

    public Status.Builder newBuilderForType()
    指定者:
      `newBuilderForType` 在接口中 `com.google.protobuf.Message`
    指定者:
      `newBuilderForType` 在接口中 `com.google.protobuf.MessageLite`

  - ### newBuilder

    public static Status.Builder newBuilder()

  - ### newBuilder

    public static Status.Builder newBuilder​(Status prototype)

  - ### toBuilder

    public Status.Builder toBuilder()
    指定者:
      `toBuilder` 在接口中 `com.google.protobuf.Message`
    指定者:
      `toBuilder` 在接口中 `com.google.protobuf.MessageLite`

  - ### newBuilderForType

    protected Status.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
    指定者:
      `newBuilderForType` 在类中 `com.google.protobuf.GeneratedMessageV3`

  - ### getDefaultInstance

    public static Status getDefaultInstance()

  - ### parser

    public static com.google.protobuf.Parser<Status> parser()

  - ### getParserForType

    public com.google.protobuf.Parser<Status> getParserForType()
    指定者:
      `getParserForType` 在接口中 `com.google.protobuf.Message`
    指定者:
      `getParserForType` 在接口中 `com.google.protobuf.MessageLite`
    覆盖:
      `getParserForType` 在类中 `com.google.protobuf.GeneratedMessageV3`

  - ### getDefaultInstanceForType

    public Status getDefaultInstanceForType()
    指定者:
      `getDefaultInstanceForType` 在接口中 `com.google.protobuf.MessageLiteOrBuilder`
    指定者:
      `getDefaultInstanceForType` 在接口中 `com.google.protobuf.MessageOrBuilder`