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). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).Protobuf type
google.rpc.Status
Modifier and Type | Method and Description |
---|---|
Status.Builder |
addAllDetails(Iterable<? extends com.google.protobuf.Any> values)
A list of messages that carry the error details.
|
Status.Builder |
addDetails(com.google.protobuf.Any.Builder builderForValue)
A list of messages that carry the error details.
|
Status.Builder |
addDetails(com.google.protobuf.Any value)
A list of messages that carry the error details.
|
Status.Builder |
addDetails(int index,
com.google.protobuf.Any.Builder builderForValue)
A list of messages that carry the error details.
|
Status.Builder |
addDetails(int index,
com.google.protobuf.Any value)
A list of messages that carry the error details.
|
com.google.protobuf.Any.Builder |
addDetailsBuilder()
A list of messages that carry the error details.
|
com.google.protobuf.Any.Builder |
addDetailsBuilder(int index)
A list of messages that carry the error details.
|
Status.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Status |
build() |
Status |
buildPartial() |
Status.Builder |
clear() |
Status.Builder |
clearCode()
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
|
Status.Builder |
clearDetails()
A list of messages that carry the error details.
|
Status.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
Status.Builder |
clearMessage()
A developer-facing error message, which should be in English.
|
Status.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
Status.Builder |
clone() |
int |
getCode()
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
|
Status |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
com.google.protobuf.Any |
getDetails(int index)
A list of messages that carry the error details.
|
com.google.protobuf.Any.Builder |
getDetailsBuilder(int index)
A list of messages that carry the error details.
|
List<com.google.protobuf.Any.Builder> |
getDetailsBuilderList()
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.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
Status.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
Status.Builder |
mergeFrom(com.google.protobuf.Message other) |
Status.Builder |
mergeFrom(Status other) |
Status.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Status.Builder |
removeDetails(int index)
A list of messages that carry the error details.
|
Status.Builder |
setCode(int value)
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
|
Status.Builder |
setDetails(int index,
com.google.protobuf.Any.Builder builderForValue)
A list of messages that carry the error details.
|
Status.Builder |
setDetails(int index,
com.google.protobuf.Any value)
A list of messages that carry the error details.
|
Status.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Status.Builder |
setMessage(String value)
A developer-facing error message, which should be in English.
|
Status.Builder |
setMessageBytes(com.google.protobuf.ByteString value)
A developer-facing error message, which should be in English.
|
Status.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
Status.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
addAll, addAll, mergeFrom, newUninitializedMessageException
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
public Status.Builder clear()
clear
in interface com.google.protobuf.Message.Builder
clear
in interface com.google.protobuf.MessageLite.Builder
clear
in class com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType
in interface com.google.protobuf.Message.Builder
getDescriptorForType
in interface com.google.protobuf.MessageOrBuilder
getDescriptorForType
in class com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
public Status getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder
public Status build()
build
in interface com.google.protobuf.Message.Builder
build
in interface com.google.protobuf.MessageLite.Builder
public Status buildPartial()
buildPartial
in interface com.google.protobuf.Message.Builder
buildPartial
in interface com.google.protobuf.MessageLite.Builder
public Status.Builder clone()
clone
in interface com.google.protobuf.Message.Builder
clone
in interface com.google.protobuf.MessageLite.Builder
clone
in class com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
public Status.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField
in interface com.google.protobuf.Message.Builder
setField
in class com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
public Status.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField
in interface com.google.protobuf.Message.Builder
clearField
in class com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
public Status.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof
in interface com.google.protobuf.Message.Builder
clearOneof
in class com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
public Status.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField
in interface com.google.protobuf.Message.Builder
setRepeatedField
in class com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
public Status.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField
in interface com.google.protobuf.Message.Builder
addRepeatedField
in class com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
public Status.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom
in interface com.google.protobuf.Message.Builder
mergeFrom
in class com.google.protobuf.AbstractMessage.Builder<Status.Builder>
public Status.Builder mergeFrom(Status other)
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
public Status.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom
in interface com.google.protobuf.Message.Builder
mergeFrom
in interface com.google.protobuf.MessageLite.Builder
mergeFrom
in class com.google.protobuf.AbstractMessage.Builder<Status.Builder>
IOException
public int getCode()
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
int32 code = 1;
getCode
in interface StatusOrBuilder
public Status.Builder setCode(int value)
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
int32 code = 1;
value
- The code to set.public Status.Builder clearCode()
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
int32 code = 1;
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
in interface StatusOrBuilder
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
in interface StatusOrBuilder
public Status.Builder setMessage(String value)
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.public Status.Builder 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;
public Status.Builder setMessageBytes(com.google.protobuf.ByteString value)
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.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
in interface StatusOrBuilder
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
in interface StatusOrBuilder
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
in interface StatusOrBuilder
public Status.Builder setDetails(int index, com.google.protobuf.Any value)
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;
public Status.Builder setDetails(int index, com.google.protobuf.Any.Builder builderForValue)
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;
public Status.Builder addDetails(com.google.protobuf.Any value)
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;
public Status.Builder addDetails(int index, com.google.protobuf.Any value)
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;
public Status.Builder addDetails(com.google.protobuf.Any.Builder builderForValue)
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;
public Status.Builder addDetails(int index, com.google.protobuf.Any.Builder builderForValue)
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;
public Status.Builder addAllDetails(Iterable<? extends com.google.protobuf.Any> values)
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;
public Status.Builder 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;
public Status.Builder removeDetails(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;
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;
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
in interface StatusOrBuilder
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
in interface StatusOrBuilder
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;
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;
public List<com.google.protobuf.Any.Builder> 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;
public final Status.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields
in interface com.google.protobuf.Message.Builder
setUnknownFields
in class com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
public final Status.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields
in interface com.google.protobuf.Message.Builder
mergeUnknownFields
in class com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
Copyright © 2020 Google LLC. All rights reserved.