Class BigtableOptions (0.51.0)

public final class BigtableOptions extends GeneratedMessageV3 implements BigtableOptionsOrBuilder

The Bigtable Options object that contains information to support the import.

Protobuf type google.cloud.discoveryengine.v1.BigtableOptions

Static Fields

FAMILIES_FIELD_NUMBER

public static final int FAMILIES_FIELD_NUMBER
Field Value
Type Description
int

KEY_FIELD_NAME_FIELD_NUMBER

public static final int KEY_FIELD_NAME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static BigtableOptions getDefaultInstance()
Returns
Type Description
BigtableOptions

getDescriptor()

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

newBuilder()

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

newBuilder(BigtableOptions prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsFamilies(String key)

public boolean containsFamilies(String key)

The mapping from family names to an object that contains column families level information for the given column family. If a family is not present in this map it will be ignored.

map<string, .google.cloud.discoveryengine.v1.BigtableOptions.BigtableColumnFamily> families = 2;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

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

getDefaultInstanceForType()

public BigtableOptions getDefaultInstanceForType()
Returns
Type Description
BigtableOptions

getFamilies() (deprecated)

public Map<String,BigtableOptions.BigtableColumnFamily> getFamilies()

Use #getFamiliesMap() instead.

Returns
Type Description
Map<String,BigtableColumnFamily>

getFamiliesCount()

public int getFamiliesCount()

The mapping from family names to an object that contains column families level information for the given column family. If a family is not present in this map it will be ignored.

map<string, .google.cloud.discoveryengine.v1.BigtableOptions.BigtableColumnFamily> families = 2;

Returns
Type Description
int

getFamiliesMap()

public Map<String,BigtableOptions.BigtableColumnFamily> getFamiliesMap()

The mapping from family names to an object that contains column families level information for the given column family. If a family is not present in this map it will be ignored.

map<string, .google.cloud.discoveryengine.v1.BigtableOptions.BigtableColumnFamily> families = 2;

Returns
Type Description
Map<String,BigtableColumnFamily>

getFamiliesOrDefault(String key, BigtableOptions.BigtableColumnFamily defaultValue)

public BigtableOptions.BigtableColumnFamily getFamiliesOrDefault(String key, BigtableOptions.BigtableColumnFamily defaultValue)

The mapping from family names to an object that contains column families level information for the given column family. If a family is not present in this map it will be ignored.

map<string, .google.cloud.discoveryengine.v1.BigtableOptions.BigtableColumnFamily> families = 2;

Parameters
Name Description
key String
defaultValue BigtableOptions.BigtableColumnFamily
Returns
Type Description
BigtableOptions.BigtableColumnFamily

getFamiliesOrThrow(String key)

public BigtableOptions.BigtableColumnFamily getFamiliesOrThrow(String key)

The mapping from family names to an object that contains column families level information for the given column family. If a family is not present in this map it will be ignored.

map<string, .google.cloud.discoveryengine.v1.BigtableOptions.BigtableColumnFamily> families = 2;

Parameter
Name Description
key String
Returns
Type Description
BigtableOptions.BigtableColumnFamily

getKeyFieldName()

public String getKeyFieldName()

The field name used for saving row key value in the document. The name has to match the pattern a-zA-Z0-9*.

string key_field_name = 1;

Returns
Type Description
String

The keyFieldName.

getKeyFieldNameBytes()

public ByteString getKeyFieldNameBytes()

The field name used for saving row key value in the document. The name has to match the pattern a-zA-Z0-9*.

string key_field_name = 1;

Returns
Type Description
ByteString

The bytes for keyFieldName.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected BigtableOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
BigtableOptions.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.Builder toBuilder()
Returns
Type Description
BigtableOptions.Builder

writeTo(CodedOutputStream output)

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