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:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, StatusOrBuilder, 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 type google.rpc.Status

Method Summary

Modifier and Type	Method	Description
Status.Builder	addAllDetails(Iterable<? extends com.google.protobuf.Any> values)	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.
Status.Builder	addDetails(int index, 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(com.google.protobuf.Any.Builder builderForValue)	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 value)	A list of messages that carry the error details.
Status.Builder	setDetails(int index, com.google.protobuf.Any.Builder builderForValue)	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)

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

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

mergeDelimitedFrom, mergeDelimitedFrom

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 com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>

clear

public Status.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>

getDefaultInstanceForType

public Status getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Status build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Status buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public Status.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>

setField

public Status.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                               Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>

clearField

public Status.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>

clearOneof

public Status.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>

setRepeatedField

public Status.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       int index,
                                       Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>

addRepeatedField

public Status.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                       Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>

mergeFrom

public Status.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Status.Builder>

mergeFrom

public Status.Builder mergeFrom(Status other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>

mergeFrom

public Status.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Status.Builder>

Throws:

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

Returns:

The bytes for message.

setMessage

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;

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.

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;

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

Specified by:

getDetails in interface StatusOrBuilder

setDetails

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;

setDetails

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;

addDetails

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;

addDetails

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;

addDetails

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;

addDetails

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;

addAllDetails

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;

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

Specified by:

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

Specified by:

getDetailsOrBuilderList in interface 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

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;

setUnknownFields

public final Status.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>

mergeUnknownFields

public final Status.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Status.Builder>