Status.Builder (common-protos-java 1.14.0 API)

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, 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). The error model is designed to be:
- Simple to use and understand for most users
- Flexible enough to meet unexpected needs
# Overview
The `Status` message contains three pieces of data: error code, error message,
and error details. The error code should be an enum value of
[google.rpc.Code][google.rpc.Code], but it may accept additional error codes if needed. The
error message should be a developer-facing English message that helps
developers *understand* and *resolve* the error. If a localized user-facing
error message is needed, put the localized message in the error details or
localize it in the client. The optional error details may contain arbitrary
information about the error. There is a predefined set of error detail types
in the package `google.rpc` that can be used for common error conditions.
# Language mapping
The `Status` message is the logical representation of the error model, but it
is not necessarily the actual wire format. When the `Status` message is
exposed in different client libraries and different wire protocols, it can be
mapped differently. For example, it will likely be mapped to some exceptions
in Java, but more likely mapped to some error codes in C.
# Other uses
The error model and the `Status` message can be used in a variety of
environments, either with or without APIs, to provide a
consistent developer experience across different environments.
Example uses of this error model include:
- Partial errors. If a service needs to return partial errors to the client,
it may embed the `Status` in the normal response to indicate the partial
errors.
- Workflow errors. A typical workflow has multiple steps. Each step may
have a `Status` message for error reporting.
- Batch operations. If a client uses batch request and batch response, the
`Status` message should be used directly inside batch response, one for
each error sub-response.
- Asynchronous operations. If an API call embeds asynchronous operation
results in its response, the status of those operations should be
represented directly using the `Status` message.
- Logging. If some API errors are stored in logs, the message `Status` could
be used directly after any stripping needed for security/privacy reasons.

Protobuf type google.rpc.Status

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Status.Builder`	`addAllDetails(java.lang.Iterable<? extends com.google.protobuf.Any> values)` 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.
`Status.Builder`	`addDetails(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(int index, com.google.protobuf.Any value)` 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, 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()`
`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.
`java.util.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.
`java.util.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.
`java.util.List<? extends com.google.protobuf.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.
`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.Builder builderForValue)` A list of messages that carry the error details.
`Status.Builder`	`setDetails(int index, com.google.protobuf.Any value)` 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, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, 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.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

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

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,
                               java.lang.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,
                                       java.lang.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,
                                       java.lang.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 java.io.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:

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

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;

clearCode

public Status.Builder clearCode()

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

int32 code = 1;

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

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

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;

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;

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;