com.google.rpc

Interface StatusOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Status, Status.Builder

public interface StatusOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
int	getCode() The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
com.google.protobuf.Any	getDetails(int index) 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.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getCode

int getCode()

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

int32 code = 1 [json_name = "code"];

Returns:

The code.

getMessage

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 [json_name = "message"];

Returns:

The message.

getMessageBytes

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 [json_name = "message"];

Returns:

The bytes for message.

getDetailsList

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 [json_name = "details"];

getDetails

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 [json_name = "details"];

getDetailsCount

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 [json_name = "details"];

getDetailsOrBuilderList

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 [json_name = "details"];

getDetailsOrBuilder

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 [json_name = "details"];