程序包 com.google.rpc
类 Status.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderType>
com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
com.google.rpc.Status.Builder
- 所有已实现的接口:
com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,StatusOrBuilder,Cloneable
- 封闭类:
- Status
public static final class Status.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
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-
方法概要
修饰符和类型方法说明addAllDetails(Iterable<? extends com.google.protobuf.Any> values)A list of messages that carry the error details.addDetails(int index, com.google.protobuf.Any value)A list of messages that carry the error details.addDetails(int index, com.google.protobuf.Any.Builder builderForValue)A list of messages that carry the error details.addDetails(com.google.protobuf.Any value)A list of messages that carry the error details.addDetails(com.google.protobuf.Any.Builder builderForValue)A list of messages that carry the error details.com.google.protobuf.Any.BuilderA list of messages that carry the error details.com.google.protobuf.Any.BuilderaddDetailsBuilder(int index)A list of messages that carry the error details.addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)build()clear()The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].A list of messages that carry the error details.clearField(com.google.protobuf.Descriptors.FieldDescriptor field)A developer-facing error message, which should be in English.clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)clone()intgetCode()The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].static com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.Descriptorcom.google.protobuf.AnygetDetails(int index)A list of messages that carry the error details.com.google.protobuf.Any.BuildergetDetailsBuilder(int index)A list of messages that carry the error details.List<com.google.protobuf.Any.Builder>A list of messages that carry the error details.intA list of messages that carry the error details.List<com.google.protobuf.Any>A list of messages that carry the error details.com.google.protobuf.AnyOrBuildergetDetailsOrBuilder(int index)A list of messages that carry the error details.List<? extends com.google.protobuf.AnyOrBuilder>A list of messages that carry the error details.A developer-facing error message, which should be in English.com.google.protobuf.ByteStringA developer-facing error message, which should be in English.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablebooleanmergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)mergeFrom(com.google.protobuf.Message other)mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)removeDetails(int index)A list of messages that carry the error details.setCode(int value)The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].setDetails(int index, com.google.protobuf.Any value)A list of messages that carry the error details.setDetails(int index, com.google.protobuf.Any.Builder builderForValue)A list of messages that carry the error details.setMessage(String value)A developer-facing error message, which should be in English.setMessageBytes(com.google.protobuf.ByteString value)A developer-facing error message, which should be in English.setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)从类继承的方法 com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3从类继承的方法 com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString从类继承的方法 com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException从接口继承的方法 com.google.protobuf.MessageLite.Builder
mergeFrom从接口继承的方法 com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
方法详细资料
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- 指定者:
internalGetFieldAccessorTable在类中com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
-
clear
- 指定者:
clear在接口中com.google.protobuf.Message.Builder- 指定者:
clear在接口中com.google.protobuf.MessageLite.Builder- 覆盖:
clear在类中com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- 指定者:
getDescriptorForType在接口中com.google.protobuf.Message.Builder- 指定者:
getDescriptorForType在接口中com.google.protobuf.MessageOrBuilder- 覆盖:
getDescriptorForType在类中com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
-
getDefaultInstanceForType
- 指定者:
getDefaultInstanceForType在接口中com.google.protobuf.MessageLiteOrBuilder- 指定者:
getDefaultInstanceForType在接口中com.google.protobuf.MessageOrBuilder
-
build
- 指定者:
build在接口中com.google.protobuf.Message.Builder- 指定者:
build在接口中com.google.protobuf.MessageLite.Builder
-
buildPartial
- 指定者:
buildPartial在接口中com.google.protobuf.Message.Builder- 指定者:
buildPartial在接口中com.google.protobuf.MessageLite.Builder
-
clone
- 指定者:
clone在接口中com.google.protobuf.Message.Builder- 指定者:
clone在接口中com.google.protobuf.MessageLite.Builder- 覆盖:
clone在类中com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
-
setField
public Status.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)- 指定者:
setField在接口中com.google.protobuf.Message.Builder- 覆盖:
setField在类中com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
-
clearField
- 指定者:
clearField在接口中com.google.protobuf.Message.Builder- 覆盖:
clearField在类中com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
-
clearOneof
- 指定者:
clearOneof在接口中com.google.protobuf.Message.Builder- 覆盖:
clearOneof在类中com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
-
setRepeatedField
public Status.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)- 指定者:
setRepeatedField在接口中com.google.protobuf.Message.Builder- 覆盖:
setRepeatedField在类中com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
-
addRepeatedField
public Status.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)- 指定者:
addRepeatedField在接口中com.google.protobuf.Message.Builder- 覆盖:
addRepeatedField在类中com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
-
mergeFrom
- 指定者:
mergeFrom在接口中com.google.protobuf.Message.Builder- 覆盖:
mergeFrom在类中com.google.protobuf.AbstractMessage.Builder<Status.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- 指定者:
isInitialized在接口中com.google.protobuf.MessageLiteOrBuilder- 覆盖:
isInitialized在类中com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
-
mergeFrom
public Status.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException- 指定者:
mergeFrom在接口中com.google.protobuf.Message.Builder- 指定者:
mergeFrom在接口中com.google.protobuf.MessageLite.Builder- 覆盖:
mergeFrom在类中com.google.protobuf.AbstractMessage.Builder<Status.Builder>- 抛出:
IOException
-
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.
-
setCode
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
int32 code = 1;- 参数:
value- The code to set.- 返回:
- This builder for chaining.
-
clearCode
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
int32 code = 1;- 返回:
- This builder for chaining.
-
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.
-
setMessage
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;- 参数:
value- The message to set.- 返回:
- This builder for chaining.
-
clearMessage
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;- 返回:
- This builder for chaining.
-
setMessageBytes
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;- 参数:
value- The bytes for message to set.- 返回:
- This builder for chaining.
-
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
-
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
-
setDetails
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; -
setDetails
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; -
addDetails
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; -
addDetails
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; -
addDetails
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; -
addDetails
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; -
addAllDetails
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; -
clearDetails
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; -
removeDetails
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; -
getDetailsBuilder
public com.google.protobuf.Any.Builder getDetailsBuilder(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
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
-
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
-
addDetailsBuilder
public com.google.protobuf.Any.Builder addDetailsBuilder()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; -
addDetailsBuilder
public com.google.protobuf.Any.Builder addDetailsBuilder(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; -
getDetailsBuilderList
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; -
setUnknownFields
- 指定者:
setUnknownFields在接口中com.google.protobuf.Message.Builder- 覆盖:
setUnknownFields在类中com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
-
mergeUnknownFields
- 指定者:
mergeUnknownFields在接口中com.google.protobuf.Message.Builder- 覆盖:
mergeUnknownFields在类中com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
-