Class Error (1.32.0)

public final class Error extends GeneratedMessageV3 implements ErrorOrBuilder

Represent a user-facing Error.

Protobuf type google.cloud.datastream.v1.Error

Implements

ErrorOrBuilder

Static Fields

DETAILS_FIELD_NUMBER

public static final int DETAILS_FIELD_NUMBER
Field Value
TypeDescription
int

ERROR_TIME_FIELD_NUMBER

public static final int ERROR_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

ERROR_UUID_FIELD_NUMBER

public static final int ERROR_UUID_FIELD_NUMBER
Field Value
TypeDescription
int

MESSAGE_FIELD_NUMBER

public static final int MESSAGE_FIELD_NUMBER
Field Value
TypeDescription
int

REASON_FIELD_NUMBER

public static final int REASON_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Error getDefaultInstance()
Returns
TypeDescription
Error

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Error.Builder newBuilder()
Returns
TypeDescription
Error.Builder

newBuilder(Error prototype)

public static Error.Builder newBuilder(Error prototype)
Parameter
NameDescription
prototypeError
Returns
TypeDescription
Error.Builder

parseDelimitedFrom(InputStream input)

public static Error parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Error
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Error parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Error
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Error parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Error
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Error parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Error
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Error parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Error
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Error parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Error
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Error parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Error
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Error parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Error
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Error parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Error
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Error parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Error
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Error parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Error
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Error parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Error
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Error> parser()
Returns
TypeDescription
Parser<Error>

Methods

containsDetails(String key)

public boolean containsDetails(String key)

Additional information about the error.

map<string, string> details = 5;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Error getDefaultInstanceForType()
Returns
TypeDescription
Error

getDetails() (deprecated)

public Map<String,String> getDetails()

Use #getDetailsMap() instead.

Returns
TypeDescription
Map<String,String>

getDetailsCount()

public int getDetailsCount()

Additional information about the error.

map<string, string> details = 5;

Returns
TypeDescription
int

getDetailsMap()

public Map<String,String> getDetailsMap()

Additional information about the error.

map<string, string> details = 5;

Returns
TypeDescription
Map<String,String>

getDetailsOrDefault(String key, String defaultValue)

public String getDetailsOrDefault(String key, String defaultValue)

Additional information about the error.

map<string, string> details = 5;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getDetailsOrThrow(String key)

public String getDetailsOrThrow(String key)

Additional information about the error.

map<string, string> details = 5;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getErrorTime()

public Timestamp getErrorTime()

The time when the error occurred.

.google.protobuf.Timestamp error_time = 4;

Returns
TypeDescription
Timestamp

The errorTime.

getErrorTimeOrBuilder()

public TimestampOrBuilder getErrorTimeOrBuilder()

The time when the error occurred.

.google.protobuf.Timestamp error_time = 4;

Returns
TypeDescription
TimestampOrBuilder

getErrorUuid()

public String getErrorUuid()

A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.

string error_uuid = 2;

Returns
TypeDescription
String

The errorUuid.

getErrorUuidBytes()

public ByteString getErrorUuidBytes()

A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.

string error_uuid = 2;

Returns
TypeDescription
ByteString

The bytes for errorUuid.

getMessage()

public String getMessage()

A message containing more information about the error that occurred.

string message = 3;

Returns
TypeDescription
String

The message.

getMessageBytes()

public ByteString getMessageBytes()

A message containing more information about the error that occurred.

string message = 3;

Returns
TypeDescription
ByteString

The bytes for message.

getParserForType()

public Parser<Error> getParserForType()
Returns
TypeDescription
Parser<Error>
Overrides

getReason()

public String getReason()

A title that explains the reason for the error.

string reason = 1;

Returns
TypeDescription
String

The reason.

getReasonBytes()

public ByteString getReasonBytes()

A title that explains the reason for the error.

string reason = 1;

Returns
TypeDescription
ByteString

The bytes for reason.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasErrorTime()

public boolean hasErrorTime()

The time when the error occurred.

.google.protobuf.Timestamp error_time = 4;

Returns
TypeDescription
boolean

Whether the errorTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Error.Builder newBuilderForType()
Returns
TypeDescription
Error.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Error.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Error.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Error.Builder toBuilder()
Returns
TypeDescription
Error.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException