Class BigtableOptions.BigtableColumnFamily (0.39.0)

Version latest

• 0.39.0 (latest)
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public static final class BigtableOptions.BigtableColumnFamily extends GeneratedMessageV3 implements BigtableOptions.BigtableColumnFamilyOrBuilder

The column family of the Bigtable.

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

Inheritance

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

Implements

BigtableOptions.BigtableColumnFamilyOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

COLUMNS_FIELD_NUMBER

public static final int COLUMNS_FIELD_NUMBER

Field Value
Type	Description
int

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

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static BigtableOptions.BigtableColumnFamily getDefaultInstance()

Returns
Type	Description
BigtableOptions.BigtableColumnFamily

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static BigtableOptions.BigtableColumnFamily.Builder newBuilder()

Returns
Type	Description
BigtableOptions.BigtableColumnFamily.Builder

newBuilder(BigtableOptions.BigtableColumnFamily prototype)

public static BigtableOptions.BigtableColumnFamily.Builder newBuilder(BigtableOptions.BigtableColumnFamily prototype)

Parameter
Name	Description
prototype	BigtableOptions.BigtableColumnFamily

Returns
Type	Description
BigtableOptions.BigtableColumnFamily.Builder

parseDelimitedFrom(InputStream input)

public static BigtableOptions.BigtableColumnFamily parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
BigtableOptions.BigtableColumnFamily

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BigtableOptions.BigtableColumnFamily parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BigtableOptions.BigtableColumnFamily

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static BigtableOptions.BigtableColumnFamily parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
BigtableOptions.BigtableColumnFamily

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static BigtableOptions.BigtableColumnFamily parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BigtableOptions.BigtableColumnFamily

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static BigtableOptions.BigtableColumnFamily parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
BigtableOptions.BigtableColumnFamily

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static BigtableOptions.BigtableColumnFamily parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BigtableOptions.BigtableColumnFamily

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static BigtableOptions.BigtableColumnFamily parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
BigtableOptions.BigtableColumnFamily

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static BigtableOptions.BigtableColumnFamily parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BigtableOptions.BigtableColumnFamily

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static BigtableOptions.BigtableColumnFamily parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
BigtableOptions.BigtableColumnFamily

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static BigtableOptions.BigtableColumnFamily parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BigtableOptions.BigtableColumnFamily

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static BigtableOptions.BigtableColumnFamily parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
BigtableOptions.BigtableColumnFamily

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static BigtableOptions.BigtableColumnFamily parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
BigtableOptions.BigtableColumnFamily

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<BigtableOptions.BigtableColumnFamily> parser()

Returns
Type	Description
Parser<BigtableColumnFamily>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getColumns(int index)

public BigtableOptions.BigtableColumn getColumns(int index)

The list of objects that contains column level information for each column. If a column is not present in this list it will be ignored.

repeated .google.cloud.discoveryengine.v1.BigtableOptions.BigtableColumn columns = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
BigtableOptions.BigtableColumn

getColumnsCount()

public int getColumnsCount()

The list of objects that contains column level information for each column. If a column is not present in this list it will be ignored.

repeated .google.cloud.discoveryengine.v1.BigtableOptions.BigtableColumn columns = 4;

Returns
Type	Description
int

getColumnsList()

public List<BigtableOptions.BigtableColumn> getColumnsList()

The list of objects that contains column level information for each column. If a column is not present in this list it will be ignored.

repeated .google.cloud.discoveryengine.v1.BigtableOptions.BigtableColumn columns = 4;

Returns
Type	Description
List<BigtableColumn>

getColumnsOrBuilder(int index)

public BigtableOptions.BigtableColumnOrBuilder getColumnsOrBuilder(int index)

The list of objects that contains column level information for each column. If a column is not present in this list it will be ignored.

repeated .google.cloud.discoveryengine.v1.BigtableOptions.BigtableColumn columns = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
BigtableOptions.BigtableColumnOrBuilder

getColumnsOrBuilderList()

public List<? extends BigtableOptions.BigtableColumnOrBuilder> getColumnsOrBuilderList()

The list of objects that contains column level information for each column. If a column is not present in this list it will be ignored.

repeated .google.cloud.discoveryengine.v1.BigtableOptions.BigtableColumn columns = 4;

Returns
Type	Description
List<? extends com.google.cloud.discoveryengine.v1.BigtableOptions.BigtableColumnOrBuilder>

getDefaultInstanceForType()

public BigtableOptions.BigtableColumnFamily getDefaultInstanceForType()

Returns
Type	Description
BigtableOptions.BigtableColumnFamily

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 = 2;

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 = 2;

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 family in the document. The name has to match the pattern a-zA-Z0-9*. If not set, it is parsed from the family name with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined.

string field_name = 1;

Returns
Type	Description
String	The fieldName.

getFieldNameBytes()

public ByteString getFieldNameBytes()

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

string field_name = 1;

Returns
Type	Description
ByteString	The bytes for fieldName.

getParserForType()

public Parser<BigtableOptions.BigtableColumnFamily> getParserForType()

Returns
Type	Description
Parser<BigtableColumnFamily>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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 = 3;

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 = 3;

Returns
Type	Description
int	The enum numeric value on the wire for type.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public BigtableOptions.BigtableColumnFamily.Builder newBuilderForType()

Returns
Type	Description
BigtableOptions.BigtableColumnFamily.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BigtableOptions.BigtableColumnFamily.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
BigtableOptions.BigtableColumnFamily.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public BigtableOptions.BigtableColumnFamily.Builder toBuilder()

Returns
Type	Description
BigtableOptions.BigtableColumnFamily.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException