Class StorageError (2.21.0)

public final class StorageError extends GeneratedMessageV3 implements StorageErrorOrBuilder

Structured custom BigQuery Storage error message. The error can be attached as error details in the returned rpc Status. In particular, the use of error codes allows more structured error handling, and reduces the need to evaluate unstructured error text strings.

Protobuf type google.cloud.bigquery.storage.v1beta2.StorageError

Static Fields

CODE_FIELD_NUMBER

public static final int CODE_FIELD_NUMBER
Field Value
TypeDescription
int

ENTITY_FIELD_NUMBER

public static final int ENTITY_FIELD_NUMBER
Field Value
TypeDescription
int

ERROR_MESSAGE_FIELD_NUMBER

public static final int ERROR_MESSAGE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static StorageError getDefaultInstance()
Returns
TypeDescription
StorageError

getDescriptor()

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

newBuilder()

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

newBuilder(StorageError prototype)

public static StorageError.Builder newBuilder(StorageError prototype)
Parameter
NameDescription
prototypeStorageError
Returns
TypeDescription
StorageError.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getCode()

public StorageError.StorageErrorCode getCode()

BigQuery Storage specific error code.

.google.cloud.bigquery.storage.v1beta2.StorageError.StorageErrorCode code = 1;

Returns
TypeDescription
StorageError.StorageErrorCode

The code.

getCodeValue()

public int getCodeValue()

BigQuery Storage specific error code.

.google.cloud.bigquery.storage.v1beta2.StorageError.StorageErrorCode code = 1;

Returns
TypeDescription
int

The enum numeric value on the wire for code.

getDefaultInstanceForType()

public StorageError getDefaultInstanceForType()
Returns
TypeDescription
StorageError

getEntity()

public String getEntity()

Name of the failed entity.

string entity = 2;

Returns
TypeDescription
String

The entity.

getEntityBytes()

public ByteString getEntityBytes()

Name of the failed entity.

string entity = 2;

Returns
TypeDescription
ByteString

The bytes for entity.

getErrorMessage()

public String getErrorMessage()

Message that describes the error.

string error_message = 3;

Returns
TypeDescription
String

The errorMessage.

getErrorMessageBytes()

public ByteString getErrorMessageBytes()

Message that describes the error.

string error_message = 3;

Returns
TypeDescription
ByteString

The bytes for errorMessage.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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