Class Status.Builder (2.42.0)

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

Protobuf type google.rpc.Status

Implements

StatusOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllDetails(Iterable<? extends Any> values)

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

Parameter
Name Description
values Iterable<? extends com.google.protobuf.Any>
Returns
Type Description
Status.Builder

addDetails(Any value)

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;

Parameter
Name Description
value Any
Returns
Type Description
Status.Builder

addDetails(Any.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Status.Builder

addDetails(int index, Any value)

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;

Parameters
Name Description
index int
value Any
Returns
Type Description
Status.Builder

addDetails(int index, Any.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue Builder
Returns
Type Description
Status.Builder

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;

Returns
Type Description
Builder

addDetailsBuilder(int index)

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;

Parameter
Name Description
index int
Returns
Type Description
Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Status.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Status.Builder
Overrides

build()

public Status build()
Returns
Type Description
Status

buildPartial()

public Status buildPartial()
Returns
Type Description
Status

clear()

public Status.Builder clear()
Returns
Type Description
Status.Builder
Overrides

clearCode()

public Status.Builder clearCode()

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

int32 code = 1;

Returns
Type Description
Status.Builder

This builder for chaining.

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;

Returns
Type Description
Status.Builder

clearField(Descriptors.FieldDescriptor field)

public Status.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Status.Builder
Overrides

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 field, or localized by the client.

string message = 2;

Returns
Type Description
Status.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Status.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Status.Builder
Overrides

clone()

public Status.Builder clone()
Returns
Type Description
Status.Builder
Overrides

getCode()

public int getCode()

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

int32 code = 1;

Returns
Type Description
int

The code.

getDefaultInstanceForType()

public Status getDefaultInstanceForType()
Returns
Type Description
Status

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDetails(int index)

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;

Parameter
Name Description
index int
Returns
Type Description
Any

getDetailsBuilder(int index)

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;

Parameter
Name Description
index int
Returns
Type Description
Builder

getDetailsBuilderList()

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

Returns
Type Description
List<Builder>

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;

Returns
Type Description
int

getDetailsList()

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

Returns
Type Description
List<Any>

getDetailsOrBuilder(int index)

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;

Parameter
Name Description
index int
Returns
Type Description
AnyOrBuilder

getDetailsOrBuilderList()

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

Returns
Type Description
List<? extends com.google.protobuf.AnyOrBuilder>

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 field, or localized by the client.

string message = 2;

Returns
Type Description
String

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 field, or localized by the client.

string message = 2;

Returns
Type Description
ByteString

The bytes for message.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Status.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Status.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Status.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Status.Builder
Overrides

mergeFrom(Status other)

public Status.Builder mergeFrom(Status other)
Parameter
Name Description
other Status
Returns
Type Description
Status.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Status.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Status.Builder
Overrides

removeDetails(int index)

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;

Parameter
Name Description
index int
Returns
Type Description
Status.Builder

setCode(int value)

public Status.Builder setCode(int value)

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

int32 code = 1;

Parameter
Name Description
value int

The code to set.

Returns
Type Description
Status.Builder

This builder for chaining.

setDetails(int index, Any value)

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;

Parameters
Name Description
index int
value Any
Returns
Type Description
Status.Builder

setDetails(int index, Any.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue Builder
Returns
Type Description
Status.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Status.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Status.Builder
Overrides

setMessage(String value)

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 field, or localized by the client.

string message = 2;

Parameter
Name Description
value String

The message to set.

Returns
Type Description
Status.Builder

This builder for chaining.

setMessageBytes(ByteString value)

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 field, or localized by the client.

string message = 2;

Parameter
Name Description
value ByteString

The bytes for message to set.

Returns
Type Description
Status.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Status.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Status.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Status.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Status.Builder
Overrides