Class BigtableOptions.BigtableColumnFamily.Builder (0.38.0)

public static final class BigtableOptions.BigtableColumnFamily.Builder extends GeneratedMessageV3.Builder<BigtableOptions.BigtableColumnFamily.Builder> implements BigtableOptions.BigtableColumnFamilyOrBuilder

The column family of the Bigtable.

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

Static Methods

getDescriptor()

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

Methods

addAllColumns(Iterable<? extends BigtableOptions.BigtableColumn> values)

public BigtableOptions.BigtableColumnFamily.Builder addAllColumns(Iterable<? extends BigtableOptions.BigtableColumn> values)

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.v1beta.BigtableOptions.BigtableColumn columns = 4;

Parameter
Name Description
values Iterable<? extends com.google.cloud.discoveryengine.v1beta.BigtableOptions.BigtableColumn>
Returns
Type Description
BigtableOptions.BigtableColumnFamily.Builder

addColumns(BigtableOptions.BigtableColumn value)

public BigtableOptions.BigtableColumnFamily.Builder addColumns(BigtableOptions.BigtableColumn value)

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.v1beta.BigtableOptions.BigtableColumn columns = 4;

Parameter
Name Description
value BigtableOptions.BigtableColumn
Returns
Type Description
BigtableOptions.BigtableColumnFamily.Builder

addColumns(BigtableOptions.BigtableColumn.Builder builderForValue)

public BigtableOptions.BigtableColumnFamily.Builder addColumns(BigtableOptions.BigtableColumn.Builder builderForValue)

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.v1beta.BigtableOptions.BigtableColumn columns = 4;

Parameter
Name Description
builderForValue BigtableOptions.BigtableColumn.Builder
Returns
Type Description
BigtableOptions.BigtableColumnFamily.Builder

addColumns(int index, BigtableOptions.BigtableColumn value)

public BigtableOptions.BigtableColumnFamily.Builder addColumns(int index, BigtableOptions.BigtableColumn value)

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.v1beta.BigtableOptions.BigtableColumn columns = 4;

Parameters
Name Description
index int
value BigtableOptions.BigtableColumn
Returns
Type Description
BigtableOptions.BigtableColumnFamily.Builder

addColumns(int index, BigtableOptions.BigtableColumn.Builder builderForValue)

public BigtableOptions.BigtableColumnFamily.Builder addColumns(int index, BigtableOptions.BigtableColumn.Builder builderForValue)

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.v1beta.BigtableOptions.BigtableColumn columns = 4;

Parameters
Name Description
index int
builderForValue BigtableOptions.BigtableColumn.Builder
Returns
Type Description
BigtableOptions.BigtableColumnFamily.Builder

addColumnsBuilder()

public BigtableOptions.BigtableColumn.Builder addColumnsBuilder()

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.v1beta.BigtableOptions.BigtableColumn columns = 4;

Returns
Type Description
BigtableOptions.BigtableColumn.Builder

addColumnsBuilder(int index)

public BigtableOptions.BigtableColumn.Builder addColumnsBuilder(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.v1beta.BigtableOptions.BigtableColumn columns = 4;

Parameter
Name Description
index int
Returns
Type Description
BigtableOptions.BigtableColumn.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BigtableOptions.BigtableColumnFamily.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BigtableOptions.BigtableColumnFamily.Builder
Overrides

build()

public BigtableOptions.BigtableColumnFamily build()
Returns
Type Description
BigtableOptions.BigtableColumnFamily

buildPartial()

public BigtableOptions.BigtableColumnFamily buildPartial()
Returns
Type Description
BigtableOptions.BigtableColumnFamily

clear()

public BigtableOptions.BigtableColumnFamily.Builder clear()
Returns
Type Description
BigtableOptions.BigtableColumnFamily.Builder
Overrides

clearColumns()

public BigtableOptions.BigtableColumnFamily.Builder clearColumns()

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.v1beta.BigtableOptions.BigtableColumn columns = 4;

Returns
Type Description
BigtableOptions.BigtableColumnFamily.Builder

clearEncoding()

public BigtableOptions.BigtableColumnFamily.Builder clearEncoding()

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.v1beta.BigtableOptions.Encoding encoding = 2;

Returns
Type Description
BigtableOptions.BigtableColumnFamily.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public BigtableOptions.BigtableColumnFamily.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
BigtableOptions.BigtableColumnFamily.Builder
Overrides

clearFieldName()

public BigtableOptions.BigtableColumnFamily.Builder clearFieldName()

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
BigtableOptions.BigtableColumnFamily.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public BigtableOptions.BigtableColumnFamily.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
BigtableOptions.BigtableColumnFamily.Builder
Overrides

clearType()

public BigtableOptions.BigtableColumnFamily.Builder clearType()

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.v1beta.BigtableOptions.Type type = 3;

Returns
Type Description
BigtableOptions.BigtableColumnFamily.Builder

This builder for chaining.

clone()

public BigtableOptions.BigtableColumnFamily.Builder clone()
Returns
Type Description
BigtableOptions.BigtableColumnFamily.Builder
Overrides

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.v1beta.BigtableOptions.BigtableColumn columns = 4;

Parameter
Name Description
index int
Returns
Type Description
BigtableOptions.BigtableColumn

getColumnsBuilder(int index)

public BigtableOptions.BigtableColumn.Builder getColumnsBuilder(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.v1beta.BigtableOptions.BigtableColumn columns = 4;

Parameter
Name Description
index int
Returns
Type Description
BigtableOptions.BigtableColumn.Builder

getColumnsBuilderList()

public List<BigtableOptions.BigtableColumn.Builder> getColumnsBuilderList()

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.v1beta.BigtableOptions.BigtableColumn columns = 4;

Returns
Type Description
List<Builder>

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.v1beta.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.v1beta.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.v1beta.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.v1beta.BigtableOptions.BigtableColumn columns = 4;

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

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.v1beta.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.v1beta.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.

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.v1beta.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.v1beta.BigtableOptions.Type type = 3;

Returns
Type Description
int

The enum numeric value on the wire for type.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(BigtableOptions.BigtableColumnFamily other)

public BigtableOptions.BigtableColumnFamily.Builder mergeFrom(BigtableOptions.BigtableColumnFamily other)
Parameter
Name Description
other BigtableOptions.BigtableColumnFamily
Returns
Type Description
BigtableOptions.BigtableColumnFamily.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BigtableOptions.BigtableColumnFamily.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
BigtableOptions.BigtableColumnFamily.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public BigtableOptions.BigtableColumnFamily.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
BigtableOptions.BigtableColumnFamily.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BigtableOptions.BigtableColumnFamily.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BigtableOptions.BigtableColumnFamily.Builder
Overrides

removeColumns(int index)

public BigtableOptions.BigtableColumnFamily.Builder removeColumns(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.v1beta.BigtableOptions.BigtableColumn columns = 4;

Parameter
Name Description
index int
Returns
Type Description
BigtableOptions.BigtableColumnFamily.Builder

setColumns(int index, BigtableOptions.BigtableColumn value)

public BigtableOptions.BigtableColumnFamily.Builder setColumns(int index, BigtableOptions.BigtableColumn value)

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.v1beta.BigtableOptions.BigtableColumn columns = 4;

Parameters
Name Description
index int
value BigtableOptions.BigtableColumn
Returns
Type Description
BigtableOptions.BigtableColumnFamily.Builder

setColumns(int index, BigtableOptions.BigtableColumn.Builder builderForValue)

public BigtableOptions.BigtableColumnFamily.Builder setColumns(int index, BigtableOptions.BigtableColumn.Builder builderForValue)

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.v1beta.BigtableOptions.BigtableColumn columns = 4;

Parameters
Name Description
index int
builderForValue BigtableOptions.BigtableColumn.Builder
Returns
Type Description
BigtableOptions.BigtableColumnFamily.Builder

setEncoding(BigtableOptions.Encoding value)

public BigtableOptions.BigtableColumnFamily.Builder setEncoding(BigtableOptions.Encoding value)

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.v1beta.BigtableOptions.Encoding encoding = 2;

Parameter
Name Description
value BigtableOptions.Encoding

The encoding to set.

Returns
Type Description
BigtableOptions.BigtableColumnFamily.Builder

This builder for chaining.

setEncodingValue(int value)

public BigtableOptions.BigtableColumnFamily.Builder setEncodingValue(int value)

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.v1beta.BigtableOptions.Encoding encoding = 2;

Parameter
Name Description
value int

The enum numeric value on the wire for encoding to set.

Returns
Type Description
BigtableOptions.BigtableColumnFamily.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public BigtableOptions.BigtableColumnFamily.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
BigtableOptions.BigtableColumnFamily.Builder
Overrides

setFieldName(String value)

public BigtableOptions.BigtableColumnFamily.Builder setFieldName(String value)

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;

Parameter
Name Description
value String

The fieldName to set.

Returns
Type Description
BigtableOptions.BigtableColumnFamily.Builder

This builder for chaining.

setFieldNameBytes(ByteString value)

public BigtableOptions.BigtableColumnFamily.Builder setFieldNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for fieldName to set.

Returns
Type Description
BigtableOptions.BigtableColumnFamily.Builder

This builder for chaining.

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

public BigtableOptions.BigtableColumnFamily.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
BigtableOptions.BigtableColumnFamily.Builder
Overrides

setType(BigtableOptions.Type value)

public BigtableOptions.BigtableColumnFamily.Builder setType(BigtableOptions.Type value)

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.v1beta.BigtableOptions.Type type = 3;

Parameter
Name Description
value BigtableOptions.Type

The type to set.

Returns
Type Description
BigtableOptions.BigtableColumnFamily.Builder

This builder for chaining.

setTypeValue(int value)

public BigtableOptions.BigtableColumnFamily.Builder setTypeValue(int value)

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.v1beta.BigtableOptions.Type type = 3;

Parameter
Name Description
value int

The enum numeric value on the wire for type to set.

Returns
Type Description
BigtableOptions.BigtableColumnFamily.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final BigtableOptions.BigtableColumnFamily.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
BigtableOptions.BigtableColumnFamily.Builder
Overrides