Class StorageError.Builder (2.28.2)

public static final class StorageError.Builder extends GeneratedMessageV3.Builder<StorageError.Builder> 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > StorageError.Builder

Implements

StorageErrorOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public StorageError.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns

Type	Description
`StorageError.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public StorageError build()

Returns

Type	Description
`StorageError`

buildPartial()

public StorageError buildPartial()

Returns

Type	Description
`StorageError`

clear()

public StorageError.Builder clear()

Returns

Type	Description
`StorageError.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearCode()

public StorageError.Builder clearCode()

BigQuery Storage specific error code.

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

Returns

Type	Description
`StorageError.Builder`	This builder for chaining.

clearEntity()

public StorageError.Builder clearEntity()

Name of the failed entity.

string entity = 2;

Returns

Type	Description
`StorageError.Builder`	This builder for chaining.

clearErrorMessage()

public StorageError.Builder clearErrorMessage()

Message that describes the error.

string error_message = 3;

Returns

Type	Description
`StorageError.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public StorageError.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
`field`	`FieldDescriptor`

Returns

Type	Description
`StorageError.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public StorageError.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
`oneof`	`OneofDescriptor`

Returns

Type	Description
`StorageError.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clone()

public StorageError.Builder clone()

Returns

Type	Description
`StorageError.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getCode()

public StorageError.StorageErrorCode getCode()

BigQuery Storage specific error code.

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

Returns

Type	Description
`StorageError.StorageErrorCode`	The code.

getCodeValue()

public int getCodeValue()

BigQuery Storage specific error code.

.google.cloud.bigquery.storage.v1beta2.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`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(StorageError other)

public StorageError.Builder mergeFrom(StorageError other)

Parameter

Name	Description
`other`	`StorageError`

Returns

Type	Description
`StorageError.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public StorageError.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns

Type	Description
`StorageError.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
`IOException`

mergeFrom(Message other)

public StorageError.Builder mergeFrom(Message other)

Parameter

Name	Description
`other`	`Message`

Returns

Type	Description
`StorageError.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StorageError.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
`unknownFields`	`UnknownFieldSet`

Returns

Type	Description
`StorageError.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setCode(StorageError.StorageErrorCode value)

public StorageError.Builder setCode(StorageError.StorageErrorCode value)

BigQuery Storage specific error code.

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

Parameter

Name	Description
`value`	`StorageError.StorageErrorCode` The code to set.

Returns

Type	Description
`StorageError.Builder`	This builder for chaining.

setCodeValue(int value)

public StorageError.Builder setCodeValue(int value)

BigQuery Storage specific error code.

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

Parameter

Name	Description
`value`	`int` The enum numeric value on the wire for code to set.

Returns

Type	Description
`StorageError.Builder`	This builder for chaining.

setEntity(String value)

public StorageError.Builder setEntity(String value)

Name of the failed entity.

string entity = 2;

Parameter

Name	Description
`value`	`String` The entity to set.

Returns

Type	Description
`StorageError.Builder`	This builder for chaining.

setEntityBytes(ByteString value)

public StorageError.Builder setEntityBytes(ByteString value)

Name of the failed entity.

string entity = 2;

Parameter

Name	Description
`value`	`ByteString` The bytes for entity to set.

Returns

Type	Description
`StorageError.Builder`	This builder for chaining.

setErrorMessage(String value)

public StorageError.Builder setErrorMessage(String value)

Message that describes the error.

string error_message = 3;

Parameter

Name	Description
`value`	`String` The errorMessage to set.

Returns

Type	Description
`StorageError.Builder`	This builder for chaining.

setErrorMessageBytes(ByteString value)

public StorageError.Builder setErrorMessageBytes(ByteString value)

Message that describes the error.

string error_message = 3;

Parameter

Name	Description
`value`	`ByteString` The bytes for errorMessage to set.

Returns

Type	Description
`StorageError.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public StorageError.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns

Type	Description
`StorageError.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public StorageError.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters

Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns

Type	Description
`StorageError.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final StorageError.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
`unknownFields`	`UnknownFieldSet`

Returns

Type	Description
`StorageError.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)