Class BigtableOptions.BigtableColumn (0.47.0) 

public static final class BigtableOptions.BigtableColumn extends GeneratedMessageV3 implements BigtableOptions.BigtableColumnOrBuilder

The column of the Bigtable.

Protobuf type google.cloud.discoveryengine.v1.BigtableOptions.BigtableColumn

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > BigtableOptions.BigtableColumn

Static Fields

ENCODING_FIELD_NUMBER

public static final int ENCODING_FIELD_NUMBER
Field Value
Type Description
int

FIELD_NAME_FIELD_NUMBER

public static final int FIELD_NAME_FIELD_NUMBER
Field Value
Type Description
int

QUALIFIER_FIELD_NUMBER

public static final int QUALIFIER_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BigtableOptions.BigtableColumn getDefaultInstance()
Returns
Type Description
BigtableOptions.BigtableColumn

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static BigtableOptions.BigtableColumn.Builder newBuilder()
Returns
Type Description
BigtableOptions.BigtableColumn.Builder

newBuilder(BigtableOptions.BigtableColumn prototype)

public static BigtableOptions.BigtableColumn.Builder newBuilder(BigtableOptions.BigtableColumn prototype)
Parameter
Name Description
prototype BigtableOptions.BigtableColumn
Returns
Type Description
BigtableOptions.BigtableColumn.Builder

parseDelimitedFrom(InputStream input)

public static BigtableOptions.BigtableColumn parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BigtableOptions.BigtableColumn
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BigtableOptions.BigtableColumn parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigtableOptions.BigtableColumn
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static BigtableOptions.BigtableColumn parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
BigtableOptions.BigtableColumn
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BigtableOptions.BigtableColumn parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigtableOptions.BigtableColumn
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BigtableOptions.BigtableColumn parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
BigtableOptions.BigtableColumn
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BigtableOptions.BigtableColumn parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigtableOptions.BigtableColumn
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BigtableOptions.BigtableColumn parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
BigtableOptions.BigtableColumn
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BigtableOptions.BigtableColumn parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigtableOptions.BigtableColumn
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static BigtableOptions.BigtableColumn parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
BigtableOptions.BigtableColumn
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BigtableOptions.BigtableColumn parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigtableOptions.BigtableColumn
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static BigtableOptions.BigtableColumn parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
BigtableOptions.BigtableColumn
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BigtableOptions.BigtableColumn parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigtableOptions.BigtableColumn
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<BigtableOptions.BigtableColumn> parser()
Returns
Type Description
Parser<BigtableColumn>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public BigtableOptions.BigtableColumn getDefaultInstanceForType()
Returns
Type Description
BigtableOptions.BigtableColumn

getEncoding()

public BigtableOptions.Encoding getEncoding()

The encoding mode of the values when the type is not STRING. Acceptable encoding values are:

  • TEXT: indicates values are alphanumeric text strings.
  • BINARY: indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in columns and specifying an encoding for it.

.google.cloud.discoveryengine.v1.BigtableOptions.Encoding encoding = 3;

Returns
Type Description
BigtableOptions.Encoding

The encoding.

getEncodingValue()

public int getEncodingValue()

The encoding mode of the values when the type is not STRING. Acceptable encoding values are:

  • TEXT: indicates values are alphanumeric text strings.
  • BINARY: indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in columns and specifying an encoding for it.

.google.cloud.discoveryengine.v1.BigtableOptions.Encoding encoding = 3;

Returns
Type Description
int

The enum numeric value on the wire for encoding.

getFieldName()

public String getFieldName()

The field name to use for this column in the document. The name has to match the pattern a-zA-Z0-9*. If not set, it is parsed from the qualifier bytes with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined.

string field_name = 2;

Returns
Type Description
String

The fieldName.

getFieldNameBytes()

public ByteString getFieldNameBytes()

The field name to use for this column in the document. The name has to match the pattern a-zA-Z0-9*. If not set, it is parsed from the qualifier bytes with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined.

string field_name = 2;

Returns
Type Description
ByteString

The bytes for fieldName.

getParserForType()

public Parser<BigtableOptions.BigtableColumn> getParserForType()
Returns
Type Description
Parser<BigtableColumn>
Overrides

getQualifier()

public ByteString getQualifier()

Required. Qualifier of the column. If it cannot be decoded with utf-8, use a base-64 encoded string instead.

bytes qualifier = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The qualifier.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getType()

public BigtableOptions.Type getType()

The type of values in this column family. The values are expected to be encoded using HBase Bytes.toBytes function when the encoding value is set to BINARY.

.google.cloud.discoveryengine.v1.BigtableOptions.Type type = 4;

Returns
Type Description
BigtableOptions.Type

The type.

getTypeValue()

public int getTypeValue()

The type of values in this column family. The values are expected to be encoded using HBase Bytes.toBytes function when the encoding value is set to BINARY.

.google.cloud.discoveryengine.v1.BigtableOptions.Type type = 4;

Returns
Type Description
int

The enum numeric value on the wire for type.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public BigtableOptions.BigtableColumn.Builder newBuilderForType()
Returns
Type Description
BigtableOptions.BigtableColumn.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BigtableOptions.BigtableColumn.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BigtableOptions.BigtableColumn.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public BigtableOptions.BigtableColumn.Builder toBuilder()
Returns
Type Description
BigtableOptions.BigtableColumn.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException