Package com.google.rpc

Class Status.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.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.GeneratedMessage.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
    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
    clearMessage()
    A developer-facing error message, which should be in English.
    Code
    getCode()
    The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
    int
    getCodeValue()
    The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
    Status
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    com.google.protobuf.Any
    getDetails()
    A list of messages that carry the error details.
    com.google.protobuf.Any.Builder
    getDetailsBuilder()
    A list of messages that carry the error details.
    com.google.protobuf.AnyOrBuilder
    getDetailsOrBuilder()
    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.
    boolean
    hasDetails()
    A list of messages that carry the error details.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    Status.Builder
    mergeDetails(com.google.protobuf.Any value)
    A list of messages that carry the error details.
    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
    setCode(Code value)
    The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
    Status.Builder
    setCodeValue(int value)
    The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
    Status.Builder
    setDetails(com.google.protobuf.Any value)
    A list of messages that carry the error details.
    Status.Builder
    setDetails(com.google.protobuf.Any.Builder builderForValue)
    A list of messages that carry the error details.
    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.

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

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, 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 Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.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.GeneratedMessage.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.GeneratedMessage.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

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

    • getCodeValue

      public int getCodeValue()
       The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
      .google.rpc.Code code = 1;
      Specified by:
      getCodeValue in interface StatusOrBuilder
      Returns:
      The enum numeric value on the wire for code.

    • setCodeValue

      public Status.Builder setCodeValue(int value)
       The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
      .google.rpc.Code code = 1;
      Parameters:
      value - The enum numeric value on the wire for code to set.
      Returns:
      This builder for chaining.

    • getCode

      public Code getCode()
       The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
      .google.rpc.Code code = 1;
      Specified by:
      getCode in interface StatusOrBuilder
      Returns:
      The code.

    • setCode

      public Status.Builder setCode(Code value)
       The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
      .google.rpc.Code 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].
      .google.rpc.Code 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.

    • hasDetails

      public boolean hasDetails()
       A list of messages that carry the error details.  There is a common set of
 message types for APIs to use.
      .google.protobuf.Any details = 3;
      Specified by:
      hasDetails in interface StatusOrBuilder
      Returns:
      Whether the details field is set.

    • getDetails

      public com.google.protobuf.Any getDetails()
       A list of messages that carry the error details.  There is a common set of
 message types for APIs to use.
      .google.protobuf.Any details = 3;
      Specified by:
      getDetails in interface StatusOrBuilder
      Returns:
      The details.

    • setDetails

      public Status.Builder setDetails(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.
      .google.protobuf.Any details = 3;

    • setDetails

      public Status.Builder setDetails(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.
      .google.protobuf.Any details = 3;

    • mergeDetails

      public Status.Builder mergeDetails(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.
      .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.
      .google.protobuf.Any details = 3;

    • getDetailsBuilder

      public com.google.protobuf.Any.Builder getDetailsBuilder()
       A list of messages that carry the error details.  There is a common set of
 message types for APIs to use.
      .google.protobuf.Any details = 3;

    • getDetailsOrBuilder

      public com.google.protobuf.AnyOrBuilder getDetailsOrBuilder()
       A list of messages that carry the error details.  There is a common set of
 message types for APIs to use.
      .google.protobuf.Any details = 3;
      Specified by:
      getDetailsOrBuilder in interface StatusOrBuilder