Package com.google.rpc

Class 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

All Implemented Interfaces:

Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, StatusOrBuilder, java.lang.Cloneable

Enclosing class:

Status

public static final class Status.Builder
extends 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

Method Summary

Modifier and Type	Method	Description
Status.Builder	addAllDetails(java.lang.Iterable<? extends Any> values)	A list of messages that carry the error details.
Status.Builder	addDetails(int index, Any value)	A list of messages that carry the error details.
Status.Builder	addDetails(int index, Any.Builder builderForValue)	A list of messages that carry the error details.
Status.Builder	addDetails(Any value)	A list of messages that carry the error details.
Status.Builder	addDetails(Any.Builder builderForValue)	A list of messages that carry the error details.
Any.Builder	addDetailsBuilder()	A list of messages that carry the error details.
Any.Builder	addDetailsBuilder(int index)	A list of messages that carry the error details.
Status.Builder	addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)	Like setRepeatedField, but appends the value as a new element.
Status	build()	Constructs the message based on the state of the Builder.
Status	buildPartial()	Like MessageLite.Builder.build(), but does not throw an exception if the message is missing required fields.
Status.Builder	clear()	Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.
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(Descriptors.FieldDescriptor field)	Clears the field.
Status.Builder	clearMessage()	A developer-facing error message, which should be in English.
Status.Builder	clearOneof(Descriptors.OneofDescriptor oneof)	TODO(jieluo): Clear it when all subclasses have implemented this method.
Status.Builder	clone()	Clones the Builder.
int	getCode()	The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
Status	getDefaultInstanceForType()	Get an instance of the type with no fields set.
static Descriptors.Descriptor	getDescriptor()
Descriptors.Descriptor	getDescriptorForType()	Get the message's type's descriptor.
Any	getDetails(int index)	A list of messages that carry the error details.
Any.Builder	getDetailsBuilder(int index)	A list of messages that carry the error details.
java.util.List<Any.Builder>	getDetailsBuilderList()	A list of messages that carry the error details.
int	getDetailsCount()	A list of messages that carry the error details.
java.util.List<Any>	getDetailsList()	A list of messages that carry the error details.
AnyOrBuilder	getDetailsOrBuilder(int index)	A list of messages that carry the error details.
java.util.List<? extends AnyOrBuilder>	getDetailsOrBuilderList()	A list of messages that carry the error details.
java.lang.String	getMessage()	A developer-facing error message, which should be in English.
ByteString	getMessageBytes()	A developer-facing error message, which should be in English.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()	Get the FieldAccessorTable for this type.
boolean	isInitialized()	Returns true if all required fields in the message and all embedded messages are set, false otherwise.
Status.Builder	mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)	Like MessageLite.Builder.mergeFrom(CodedInputStream), but also parses extensions.
Status.Builder	mergeFrom(Message other)	Merge other into the message being built.
Status.Builder	mergeFrom(Status other)
Status.Builder	mergeUnknownFields(UnknownFieldSet unknownFields)	Merge some unknown fields into the UnknownFieldSet for this message.
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, Any value)	A list of messages that carry the error details.
Status.Builder	setDetails(int index, Any.Builder builderForValue)	A list of messages that carry the error details.
Status.Builder	setField(Descriptors.FieldDescriptor field, java.lang.Object value)	Sets a field to the given value.
Status.Builder	setMessage(java.lang.String value)	A developer-facing error message, which should be in English.
Status.Builder	setMessageBytes(ByteString value)	A developer-facing error message, which should be in English.
Status.Builder	setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)	Sets an element of a repeated field to the given value.
Status.Builder	setUnknownFields(UnknownFieldSet unknownFields)	Set the UnknownFieldSet for this message.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Description copied from class: GeneratedMessageV3.Builder

Get the FieldAccessorTable for this type. We can't have the message class pass this in to the constructor because of bootstrapping trouble with DescriptorProtos.

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<Status.Builder>

clear

public Status.Builder clear()

Description copied from class: GeneratedMessageV3.Builder

Called by the initialization and clear code paths to allow subclasses to reset any of their builtin fields back to the initial values.

Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<Status.Builder>

getDescriptorForType

public Descriptors.Descriptor getDescriptorForType()

Description copied from interface: Message.Builder

Get the message's type's descriptor. See MessageOrBuilder.getDescriptorForType().

Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<Status.Builder>

getDefaultInstanceForType

public Status getDefaultInstanceForType()

Description copied from interface: MessageLiteOrBuilder

Get an instance of the type with no fields set. Because no fields are set, all getters for singular fields will return default values and repeated fields will appear empty. This may or may not be a singleton. This differs from the getDefaultInstance() method of generated message classes in that this method is an abstract method of the MessageLite interface whereas getDefaultInstance() is a static method of a specific class. They return the same thing.

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build

public Status build()

Description copied from interface: MessageLite.Builder

Constructs the message based on the state of the Builder. Subsequent changes to the Builder will not affect the returned message.

Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial

public Status buildPartial()

Description copied from interface: MessageLite.Builder

Like MessageLite.Builder.build(), but does not throw an exception if the message is missing required fields. Instead, a partial message is returned. Subsequent changes to the Builder will not affect the returned message.

Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone

public Status.Builder clone()

Description copied from interface: MessageLite.Builder

Clones the Builder.

Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<Status.Builder>

See Also:

Object.clone()

setField

public Status.Builder setField(Descriptors.FieldDescriptor field,
                               java.lang.Object value)

Description copied from interface: Message.Builder

Sets a field to the given value. The value must be of the correct type for this field, i.e. the same type that MessageOrBuilder.getField(Descriptors.FieldDescriptor) would return.

Specified by:

setField in interface Message.Builder

Overrides:

setField in class GeneratedMessageV3.Builder<Status.Builder>

clearField

public Status.Builder clearField(Descriptors.FieldDescriptor field)

Description copied from interface: Message.Builder

Clears the field. This is exactly equivalent to calling the generated "clear" accessor method corresponding to the field.

Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<Status.Builder>

clearOneof

public Status.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Description copied from class: AbstractMessage.Builder

TODO(jieluo): Clear it when all subclasses have implemented this method.

Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<Status.Builder>

setRepeatedField

public Status.Builder setRepeatedField(Descriptors.FieldDescriptor field,
                                       int index,
                                       java.lang.Object value)

Description copied from interface: Message.Builder

Sets an element of a repeated field to the given value. The value must be of the correct type for this field, i.e. the same type that MessageOrBuilder.getRepeatedField(Descriptors.FieldDescriptor,int) would return.

Specified by:

setRepeatedField in interface Message.Builder

Overrides:

setRepeatedField in class GeneratedMessageV3.Builder<Status.Builder>

addRepeatedField

public Status.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                       java.lang.Object value)

Description copied from interface: Message.Builder

Like setRepeatedField, but appends the value as a new element.

Specified by:

addRepeatedField in interface Message.Builder

Overrides:

addRepeatedField in class GeneratedMessageV3.Builder<Status.Builder>

mergeFrom

public Status.Builder mergeFrom(Message other)

Description copied from interface: Message.Builder

Merge other into the message being built. other must have the exact same type as this (i.e. getDescriptorForType() == other.getDescriptorForType()).

Merging occurs as follows. For each field:
* For singular primitive fields, if the field is set in other, then other's value overwrites the value in this message.
* For singular message fields, if the field is set in other, it is merged into the corresponding sub-message of this message using the same merging rules.
* For repeated fields, the elements in other are concatenated with the elements in this message.
* For oneof groups, if the other message has one of the fields set, the group of this message is cleared and replaced by the field of the other message, so that the oneof constraint is preserved.

This is equivalent to the Message::MergeFrom method in C++.

Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<Status.Builder>

mergeFrom

public Status.Builder mergeFrom(Status other)

isInitialized

public final boolean isInitialized()

Description copied from interface: MessageLiteOrBuilder

Returns true if all required fields in the message and all embedded messages are set, false otherwise.

See also: MessageOrBuilder.getInitializationErrorString()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<Status.Builder>

mergeFrom

public Status.Builder mergeFrom(CodedInputStream input,
                                ExtensionRegistryLite extensionRegistry)
                         throws java.io.IOException

Description copied from interface: MessageLite.Builder

Like MessageLite.Builder.mergeFrom(CodedInputStream), but also parses extensions. The extensions that you want to be able to parse must be registered in extensionRegistry. Extensions not in the registry will be treated as unknown fields.

Specified by:

mergeFrom in interface Message.Builder

Specified by:

mergeFrom in interface MessageLite.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<Status.Builder>

Throws:

java.io.IOException

getCode

public int getCode()

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

int32 code = 1;

Specified by:

getCode in interface StatusOrBuilder

Returns:

The code.

setCode

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;

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].
 

int32 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 interface StatusOrBuilder

Returns:

The message.

getMessageBytes

public 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 interface StatusOrBuilder

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(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.

getDetailsList

public java.util.List<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;

Specified by:

getDetailsList in interface 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;

Specified by:

getDetailsCount in interface StatusOrBuilder

getDetails

public 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;

Specified by:

getDetails in interface StatusOrBuilder

setDetails

public Status.Builder setDetails(int index,
                                 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;

setDetails

public Status.Builder setDetails(int index,
                                 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;

addDetails

public Status.Builder addDetails(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;

addDetails

public Status.Builder addDetails(int index,
                                 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;

addDetails

public Status.Builder addDetails(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;

addDetails

public Status.Builder addDetails(int index,
                                 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;

addAllDetails

public Status.Builder addAllDetails(java.lang.Iterable<? extends 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;

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.
 

repeated .google.protobuf.Any details = 3;

removeDetails

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;

getDetailsBuilder

public 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 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;

Specified by:

getDetailsOrBuilder in interface StatusOrBuilder

getDetailsOrBuilderList

public java.util.List<? extends 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;

Specified by:

getDetailsOrBuilderList in interface StatusOrBuilder

addDetailsBuilder

public 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 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

public java.util.List<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;

setUnknownFields

public final Status.Builder setUnknownFields(UnknownFieldSet unknownFields)

Description copied from interface: Message.Builder

Set the UnknownFieldSet for this message.

Specified by:

setUnknownFields in interface Message.Builder

Overrides:

setUnknownFields in class GeneratedMessageV3.Builder<Status.Builder>

mergeUnknownFields

public final Status.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Description copied from interface: Message.Builder

Merge some unknown fields into the UnknownFieldSet for this message.

Specified by:

mergeUnknownFields in interface Message.Builder

Overrides:

mergeUnknownFields in class GeneratedMessageV3.Builder<Status.Builder>