Package com.google.rpc
Class Status.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
-
- com.google.rpc.Status.Builder
-
- All Implemented Interfaces:
com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,StatusOrBuilder
,java.lang.Cloneable
- Enclosing class:
- 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). 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 typegoogle.rpc.Status
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Status.Builder
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.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()
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].Status
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
com.google.protobuf.Descriptors.Descriptor
getDescriptorForType()
com.google.protobuf.Any
getDetails()
A list of messages that carry the error details.com.google.protobuf.Any.Builder
getDetailsBuilder()
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.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
Status.Builder
mergeDetails(com.google.protobuf.Any value)
A list of messages that carry the error details.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
setCode(Code value)
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].Status.Builder
setCodeValue(int value)
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].Status.Builder
setDetails(com.google.protobuf.Any value)
A list of messages that carry the error details.Status.Builder
setDetails(com.google.protobuf.Any.Builder builderForValue)
A list of messages that carry the error details.Status.Builder
setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
Status.Builder
setMessage(java.lang.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, java.lang.Object value)
Status.Builder
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
-
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
-
clear
public Status.Builder clear()
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
-
getDefaultInstanceForType
public Status getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
public Status build()
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public Status buildPartial()
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
clone
public Status.Builder clone()
- Specified by:
clone
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clone
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clone
in classcom.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
-
setField
public Status.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
- Specified by:
setField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
-
clearField
public Status.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
-
clearOneof
public Status.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneof
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearOneof
in classcom.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
-
setRepeatedField
public Status.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
- Specified by:
setRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
-
addRepeatedField
public Status.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
- Specified by:
addRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
addRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
-
mergeFrom
public Status.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<Status.Builder>
-
mergeFrom
public Status.Builder mergeFrom(Status other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
-
mergeFrom
public Status.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<Status.Builder>
- Throws:
java.io.IOException
-
getCodeValue
public int getCodeValue()
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
.google.rpc.Code code = 1;
- Specified by:
getCodeValue
in interfaceStatusOrBuilder
- Returns:
- The enum numeric value on the wire for code.
-
setCodeValue
public Status.Builder setCodeValue(int value)
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
.google.rpc.Code code = 1;
- Parameters:
value
- The enum numeric value on the wire for code to set.- Returns:
- This builder for chaining.
-
getCode
public Code getCode()
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
.google.rpc.Code code = 1;
- Specified by:
getCode
in interfaceStatusOrBuilder
- Returns:
- The code.
-
setCode
public Status.Builder setCode(Code value)
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
.google.rpc.Code code = 1;
- Parameters:
value
- The code to set.- Returns:
- This builder for chaining.
-
clearCode
public Status.Builder clearCode()
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
.google.rpc.Code code = 1;
- Returns:
- This builder for chaining.
-
getMessage
public 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;
- Specified by:
getMessage
in interfaceStatusOrBuilder
- Returns:
- 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;
- Specified by:
getMessageBytes
in interfaceStatusOrBuilder
- Returns:
- The bytes for message.
-
setMessage
public Status.Builder setMessage(java.lang.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;
- Parameters:
value
- The message to set.- Returns:
- This builder for chaining.
-
clearMessage
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;
- Returns:
- This builder for chaining.
-
setMessageBytes
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;
- Parameters:
value
- The bytes for message to set.- Returns:
- This builder for chaining.
-
hasDetails
public 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;
- Specified by:
hasDetails
in interfaceStatusOrBuilder
- Returns:
- Whether the details field is set.
-
getDetails
public 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;
- Specified by:
getDetails
in interfaceStatusOrBuilder
- Returns:
- The details.
-
setDetails
public Status.Builder setDetails(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.
.google.protobuf.Any details = 3;
-
setDetails
public Status.Builder setDetails(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.
.google.protobuf.Any details = 3;
-
mergeDetails
public Status.Builder mergeDetails(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.
.google.protobuf.Any details = 3;
-
clearDetails
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.
.google.protobuf.Any details = 3;
-
getDetailsBuilder
public com.google.protobuf.Any.Builder getDetailsBuilder()
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;
-
getDetailsOrBuilder
public 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;
- Specified by:
getDetailsOrBuilder
in interfaceStatusOrBuilder
-
setUnknownFields
public final Status.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
-
mergeUnknownFields
public final Status.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>
-
-