Class Family (2.14.0)

public final class Family extends GeneratedMessageV3 implements FamilyOrBuilder

Specifies (some of) the contents of a single row/column family intersection of a table.

Protobuf type google.bigtable.v2.Family

Implements

FamilyOrBuilder

Static Fields

COLUMNS_FIELD_NUMBER

public static final int COLUMNS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Family getDefaultInstance()
Returns
TypeDescription
Family

getDescriptor()

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

newBuilder()

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

newBuilder(Family prototype)

public static Family.Builder newBuilder(Family prototype)
Parameter
NameDescription
prototypeFamily
Returns
TypeDescription
Family.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getColumns(int index)

public Column getColumns(int index)

Must not be empty. Sorted in order of increasing "qualifier".

repeated .google.bigtable.v2.Column columns = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
Column

getColumnsCount()

public int getColumnsCount()

Must not be empty. Sorted in order of increasing "qualifier".

repeated .google.bigtable.v2.Column columns = 2;

Returns
TypeDescription
int

getColumnsList()

public List<Column> getColumnsList()

Must not be empty. Sorted in order of increasing "qualifier".

repeated .google.bigtable.v2.Column columns = 2;

Returns
TypeDescription
List<Column>

getColumnsOrBuilder(int index)

public ColumnOrBuilder getColumnsOrBuilder(int index)

Must not be empty. Sorted in order of increasing "qualifier".

repeated .google.bigtable.v2.Column columns = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
ColumnOrBuilder

getColumnsOrBuilderList()

public List<? extends ColumnOrBuilder> getColumnsOrBuilderList()

Must not be empty. Sorted in order of increasing "qualifier".

repeated .google.bigtable.v2.Column columns = 2;

Returns
TypeDescription
List<? extends com.google.bigtable.v2.ColumnOrBuilder>

getDefaultInstanceForType()

public Family getDefaultInstanceForType()
Returns
TypeDescription
Family

getName()

public String getName()

The unique key which identifies this family within its row. This is the same key that's used to identify the family in, for example, a RowFilter which sets its "family_name_regex_filter" field. Must match [-_.a-zA-Z0-9]+, except that AggregatingRowProcessors may produce cells in a sentinel family with an empty name. Must be no greater than 64 characters in length.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The unique key which identifies this family within its row. This is the same key that's used to identify the family in, for example, a RowFilter which sets its "family_name_regex_filter" field. Must match [-_.a-zA-Z0-9]+, except that AggregatingRowProcessors may produce cells in a sentinel family with an empty name. Must be no greater than 64 characters in length.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Family> getParserForType()
Returns
TypeDescription
Parser<Family>
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 Family.Builder newBuilderForType()
Returns
TypeDescription
Family.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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