Package com.google.firestore.admin.v1

Class Index.IndexField.SearchConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.firestore.admin.v1.Index.IndexField.SearchConfig

All Implemented Interfaces:

Index.IndexField.SearchConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

Index.IndexField

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

 The configuration for how to index a field for search.
 

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

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Index.IndexField.SearchConfig.Builder	The configuration for how to index a field for search.
static final class	Index.IndexField.SearchConfig.SearchGeoSpec	The specification for how to build a geo search index for a field.
static interface	Index.IndexField.SearchConfig.SearchGeoSpecOrBuilder
static final class	Index.IndexField.SearchConfig.SearchTextIndexSpec	Specification of how the field should be indexed for search text indexes.
static interface	Index.IndexField.SearchConfig.SearchTextIndexSpecOrBuilder
static final class	Index.IndexField.SearchConfig.SearchTextSpec	The specification for how to build a text search index for a field.
static interface	Index.IndexField.SearchConfig.SearchTextSpecOrBuilder
static enum	Index.IndexField.SearchConfig.TextIndexType	Ways to index the text field value.
static enum	Index.IndexField.SearchConfig.TextMatchType	Types of text matches that are supported for the field.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	GEO_SPEC_FIELD_NUMBER
static final int	TEXT_SPEC_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static Index.IndexField.SearchConfig	getDefaultInstance()
Index.IndexField.SearchConfig	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Index.IndexField.SearchConfig.SearchGeoSpec	getGeoSpec()	Optional.
Index.IndexField.SearchConfig.SearchGeoSpecOrBuilder	getGeoSpecOrBuilder()	Optional.
com.google.protobuf.Parser<Index.IndexField.SearchConfig>	getParserForType()
int	getSerializedSize()
Index.IndexField.SearchConfig.SearchTextSpec	getTextSpec()	Optional.
Index.IndexField.SearchConfig.SearchTextSpecOrBuilder	getTextSpecOrBuilder()	Optional.
boolean	hasGeoSpec()	Optional.
int	hashCode()
boolean	hasTextSpec()	Optional.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static Index.IndexField.SearchConfig.Builder	newBuilder()
static Index.IndexField.SearchConfig.Builder	newBuilder(Index.IndexField.SearchConfig prototype)
Index.IndexField.SearchConfig.Builder	newBuilderForType()
protected Index.IndexField.SearchConfig.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static Index.IndexField.SearchConfig	parseDelimitedFrom(InputStream input)
static Index.IndexField.SearchConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Index.IndexField.SearchConfig	parseFrom(byte[] data)
static Index.IndexField.SearchConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Index.IndexField.SearchConfig	parseFrom(com.google.protobuf.ByteString data)
static Index.IndexField.SearchConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Index.IndexField.SearchConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static Index.IndexField.SearchConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Index.IndexField.SearchConfig	parseFrom(InputStream input)
static Index.IndexField.SearchConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Index.IndexField.SearchConfig	parseFrom(ByteBuffer data)
static Index.IndexField.SearchConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Index.IndexField.SearchConfig>	parser()
Index.IndexField.SearchConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Details

TEXT_SPEC_FIELD_NUMBER

public static final int TEXT_SPEC_FIELD_NUMBER

See Also:

• Constant Field Values

GEO_SPEC_FIELD_NUMBER

public static final int GEO_SPEC_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

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

Specified by:

hasTextSpec in interface Index.IndexField.SearchConfigOrBuilder

Returns:

Whether the textSpec field is set.

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

Specified by:

getTextSpec in interface Index.IndexField.SearchConfigOrBuilder

Returns:

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

Specified by:

getTextSpecOrBuilder in interface Index.IndexField.SearchConfigOrBuilder

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

Specified by:

hasGeoSpec in interface Index.IndexField.SearchConfigOrBuilder

Returns:

Whether the geoSpec field is set.

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

Specified by:

getGeoSpec in interface Index.IndexField.SearchConfigOrBuilder

Returns:

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

Specified by:

getGeoSpecOrBuilder in interface Index.IndexField.SearchConfigOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Index.IndexField.SearchConfig parseFrom(ByteBuffer data)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Index.IndexField.SearchConfig parseFrom(ByteBuffer data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Index.IndexField.SearchConfig parseFrom(com.google.protobuf.ByteString data)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Index.IndexField.SearchConfig parseFrom(com.google.protobuf.ByteString data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Index.IndexField.SearchConfig parseFrom(byte[] data)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Index.IndexField.SearchConfig parseFrom(byte[] data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Index.IndexField.SearchConfig parseFrom(InputStream input)
                                               throws IOException

Throws:

IOException

parseFrom

public static Index.IndexField.SearchConfig parseFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static Index.IndexField.SearchConfig parseDelimitedFrom(InputStream input)
                                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static Index.IndexField.SearchConfig parseDelimitedFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                        throws IOException

Throws:

IOException

parseFrom

public static Index.IndexField.SearchConfig parseFrom(com.google.protobuf.CodedInputStream input)
                                               throws IOException

Throws:

IOException

parseFrom

public static Index.IndexField.SearchConfig parseFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws IOException

Throws:

IOException

newBuilderForType

public Index.IndexField.SearchConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Index.IndexField.SearchConfig.Builder newBuilder()

newBuilder

public static Index.IndexField.SearchConfig.Builder newBuilder(Index.IndexField.SearchConfig prototype)

toBuilder

public Index.IndexField.SearchConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Index.IndexField.SearchConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static Index.IndexField.SearchConfig getDefaultInstance()

parser

public static com.google.protobuf.Parser<Index.IndexField.SearchConfig> parser()

getParserForType

public com.google.protobuf.Parser<Index.IndexField.SearchConfig> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public Index.IndexField.SearchConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder