Class Index.IndexField.SearchConfig (3.43.1)

public static final class Index.IndexField.SearchConfig extends GeneratedMessage implements Index.IndexField.SearchConfigOrBuilder

The configuration for how to index a field for search.

Protobuf type google.firestore.admin.v1.Index.IndexField.SearchConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > Index.IndexField.SearchConfig

Static Fields

GEO_SPEC_FIELD_NUMBER

public static final int GEO_SPEC_FIELD_NUMBER
Field Value
Type Description
int

TEXT_SPEC_FIELD_NUMBER

public static final int TEXT_SPEC_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Index.IndexField.SearchConfig getDefaultInstance()
Returns
Type Description
Index.IndexField.SearchConfig

getDescriptor()

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

newBuilder()

public static Index.IndexField.SearchConfig.Builder newBuilder()
Returns
Type Description
Index.IndexField.SearchConfig.Builder

newBuilder(Index.IndexField.SearchConfig prototype)

public static Index.IndexField.SearchConfig.Builder newBuilder(Index.IndexField.SearchConfig prototype)
Parameter
Name Description
prototype Index.IndexField.SearchConfig
Returns
Type Description
Index.IndexField.SearchConfig.Builder

parseDelimitedFrom(InputStream input)

public static Index.IndexField.SearchConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Index.IndexField.SearchConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Index.IndexField.SearchConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Index.IndexField.SearchConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Index.IndexField.SearchConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Index.IndexField.SearchConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Index.IndexField.SearchConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Index.IndexField.SearchConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Index.IndexField.SearchConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Index.IndexField.SearchConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Index.IndexField.SearchConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Index.IndexField.SearchConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Index.IndexField.SearchConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Index.IndexField.SearchConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Index.IndexField.SearchConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Index.IndexField.SearchConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Index.IndexField.SearchConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Index.IndexField.SearchConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Index.IndexField.SearchConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Index.IndexField.SearchConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Index.IndexField.SearchConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Index.IndexField.SearchConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Index.IndexField.SearchConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Index.IndexField.SearchConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Index.IndexField.SearchConfig> parser()
Returns
Type Description
Parser<SearchConfig>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public Index.IndexField.SearchConfig getDefaultInstanceForType()
Returns
Type Description
Index.IndexField.SearchConfig

getGeoSpec()

public Index.IndexField.SearchConfig.SearchGeoSpec getGeoSpec()

Optional. The specification for building a geo search index for a field.

.google.firestore.admin.v1.Index.IndexField.SearchConfig.SearchGeoSpec geo_spec = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Index.IndexField.SearchConfig.SearchGeoSpec

The geoSpec.

getGeoSpecOrBuilder()

public Index.IndexField.SearchConfig.SearchGeoSpecOrBuilder getGeoSpecOrBuilder()

Optional. The specification for building a geo search index for a field.

.google.firestore.admin.v1.Index.IndexField.SearchConfig.SearchGeoSpec geo_spec = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Index.IndexField.SearchConfig.SearchGeoSpecOrBuilder

getParserForType()

public Parser<Index.IndexField.SearchConfig> getParserForType()
Returns
Type Description
Parser<SearchConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTextSpec()

public Index.IndexField.SearchConfig.SearchTextSpec getTextSpec()

Optional. The specification for building a text search index for a field.

.google.firestore.admin.v1.Index.IndexField.SearchConfig.SearchTextSpec text_spec = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Index.IndexField.SearchConfig.SearchTextSpec

The textSpec.

getTextSpecOrBuilder()

public Index.IndexField.SearchConfig.SearchTextSpecOrBuilder getTextSpecOrBuilder()

Optional. The specification for building a text search index for a field.

.google.firestore.admin.v1.Index.IndexField.SearchConfig.SearchTextSpec text_spec = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Index.IndexField.SearchConfig.SearchTextSpecOrBuilder

hasGeoSpec()

public boolean hasGeoSpec()

Optional. The specification for building a geo search index for a field.

.google.firestore.admin.v1.Index.IndexField.SearchConfig.SearchGeoSpec geo_spec = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the geoSpec field is set.

hasTextSpec()

public boolean hasTextSpec()

Optional. The specification for building a text search index for a field.

.google.firestore.admin.v1.Index.IndexField.SearchConfig.SearchTextSpec text_spec = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the textSpec field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Index.IndexField.SearchConfig.Builder newBuilderForType()
Returns
Type Description
Index.IndexField.SearchConfig.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Index.IndexField.SearchConfig.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Index.IndexField.SearchConfig.Builder
Overrides

toBuilder()

public Index.IndexField.SearchConfig.Builder toBuilder()
Returns
Type Description
Index.IndexField.SearchConfig.Builder

writeTo(CodedOutputStream output)

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