public final class StorageError extends GeneratedMessageV3 implements StorageErrorOrBuilderStructured 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.v1.StorageError
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > StorageErrorImplements
StorageErrorOrBuilderStatic Fields
CODE_FIELD_NUMBER
public static final int CODE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
ENTITY_FIELD_NUMBER
public static final int ENTITY_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
ERROR_MESSAGE_FIELD_NUMBER
public static final int ERROR_MESSAGE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static StorageError getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
StorageError | |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
newBuilder()
public static StorageError.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
StorageError.Builder | |
newBuilder(StorageError prototype)
public static StorageError.Builder newBuilder(StorageError prototype)| Parameter | |
|---|---|
| Name | Description |
prototype | StorageError |
| Returns | |
|---|---|
| Type | Description |
StorageError.Builder | |
parseDelimitedFrom(InputStream input)
public static StorageError parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input | InputStream |
| Returns | |
|---|---|
| Type | Description |
StorageError | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static StorageError parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
StorageError | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(byte[] data)
public static StorageError parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data | byte[] |
| Returns | |
|---|---|
| Type | Description |
StorageError | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static StorageError parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
StorageError | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(ByteString data)
public static StorageError parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data | ByteString |
| Returns | |
|---|---|
| Type | Description |
StorageError | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StorageError parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
StorageError | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(CodedInputStream input)
public static StorageError parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input | CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
StorageError | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static StorageError parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
StorageError | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(InputStream input)
public static StorageError parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input | InputStream |
| Returns | |
|---|---|
| Type | Description |
StorageError | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static StorageError parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
StorageError | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(ByteBuffer data)
public static StorageError parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data | ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
StorageError | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static StorageError parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
StorageError | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parser()
public static Parser<StorageError> parser()| Returns | |
|---|---|
| Type | Description |
Parser<StorageError> | |
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj | Object |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getCode()
public StorageError.StorageErrorCode getCode()BigQuery Storage specific error code.
.google.cloud.bigquery.storage.v1.StorageError.StorageErrorCode code = 1;
| Returns | |
|---|---|
| Type | Description |
StorageError.StorageErrorCode | The code. |
getCodeValue()
public int getCodeValue()BigQuery Storage specific error code.
.google.cloud.bigquery.storage.v1.StorageError.StorageErrorCode code = 1;
| Returns | |
|---|---|
| Type | Description |
int | The enum numeric value on the wire for code. |
getDefaultInstanceForType()
public StorageError getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
StorageError | |
getEntity()
public String getEntity()Name of the failed entity.
string entity = 2;
| Returns | |
|---|---|
| Type | Description |
String | The entity. |
getEntityBytes()
public ByteString getEntityBytes()Name of the failed entity.
string entity = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for entity. |
getErrorMessage()
public String getErrorMessage()Message that describes the error.
string error_message = 3;
| Returns | |
|---|---|
| Type | Description |
String | The errorMessage. |
getErrorMessageBytes()
public ByteString getErrorMessageBytes()Message that describes the error.
string error_message = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for errorMessage. |
getParserForType()
public Parser<StorageError> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<StorageError> | |
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int | |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int | |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
newBuilderForType()
public StorageError.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
StorageError.Builder | |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected StorageError.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent | BuilderParent |
| Returns | |
|---|---|
| Type | Description |
StorageError.Builder | |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused | UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object | |
toBuilder()
public StorageError.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
StorageError.Builder | |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output | CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |