Class BigtableOptions.BigtableColumn.Builder (0.48.0)

public static final class BigtableOptions.BigtableColumn.Builder extends GeneratedMessageV3.Builder<BigtableOptions.BigtableColumn.Builder> implements BigtableOptions.BigtableColumnOrBuilder

The column of the Bigtable.

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

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

buildPartial()

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

clear()

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

clearEncoding()

public BigtableOptions.BigtableColumn.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.v1.BigtableOptions.Encoding encoding = 3;

Returns
Type Description
BigtableOptions.BigtableColumn.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearFieldName()

public BigtableOptions.BigtableColumn.Builder clearFieldName()

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearQualifier()

public BigtableOptions.BigtableColumn.Builder clearQualifier()

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

This builder for chaining.

clearType()

public BigtableOptions.BigtableColumn.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.v1.BigtableOptions.Type type = 4;

Returns
Type Description
BigtableOptions.BigtableColumn.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

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

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

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(BigtableOptions.BigtableColumn other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setEncoding(BigtableOptions.Encoding value)

public BigtableOptions.BigtableColumn.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.v1.BigtableOptions.Encoding encoding = 3;

Parameter
Name Description
value BigtableOptions.Encoding

The encoding to set.

Returns
Type Description
BigtableOptions.BigtableColumn.Builder

This builder for chaining.

setEncodingValue(int value)

public BigtableOptions.BigtableColumn.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.v1.BigtableOptions.Encoding encoding = 3;

Parameter
Name Description
value int

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

Returns
Type Description
BigtableOptions.BigtableColumn.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setFieldName(String value)

public BigtableOptions.BigtableColumn.Builder setFieldName(String value)

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;

Parameter
Name Description
value String

The fieldName to set.

Returns
Type Description
BigtableOptions.BigtableColumn.Builder

This builder for chaining.

setFieldNameBytes(ByteString value)

public BigtableOptions.BigtableColumn.Builder setFieldNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for fieldName to set.

Returns
Type Description
BigtableOptions.BigtableColumn.Builder

This builder for chaining.

setQualifier(ByteString value)

public BigtableOptions.BigtableColumn.Builder setQualifier(ByteString value)

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];

Parameter
Name Description
value ByteString

The qualifier to set.

Returns
Type Description
BigtableOptions.BigtableColumn.Builder

This builder for chaining.

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

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

setType(BigtableOptions.Type value)

public BigtableOptions.BigtableColumn.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.v1.BigtableOptions.Type type = 4;

Parameter
Name Description
value BigtableOptions.Type

The type to set.

Returns
Type Description
BigtableOptions.BigtableColumn.Builder

This builder for chaining.

setTypeValue(int value)

public BigtableOptions.BigtableColumn.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.v1.BigtableOptions.Type type = 4;

Parameter
Name Description
value int

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

Returns
Type Description
BigtableOptions.BigtableColumn.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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