Class Index.IndexField.SearchConfig.SearchTextIndexSpec (3.43.1)

public static final class Index.IndexField.SearchConfig.SearchTextIndexSpec extends GeneratedMessage implements Index.IndexField.SearchConfig.SearchTextIndexSpecOrBuilder

Specification of how the field should be indexed for search text indexes.

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

Inheritance

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

Static Fields

INDEX_TYPE_FIELD_NUMBER

public static final int INDEX_TYPE_FIELD_NUMBER
Field Value
Type Description
int

MATCH_TYPE_FIELD_NUMBER

public static final int MATCH_TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(Index.IndexField.SearchConfig.SearchTextIndexSpec prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

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

getIndexType()

public Index.IndexField.SearchConfig.TextIndexType getIndexType()

Required. How to index the text field value.

.google.firestore.admin.v1.Index.IndexField.SearchConfig.TextIndexType index_type = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Index.IndexField.SearchConfig.TextIndexType

The indexType.

getIndexTypeValue()

public int getIndexTypeValue()

Required. How to index the text field value.

.google.firestore.admin.v1.Index.IndexField.SearchConfig.TextIndexType index_type = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for indexType.

getMatchType()

public Index.IndexField.SearchConfig.TextMatchType getMatchType()

Required. How to match the text field value.

.google.firestore.admin.v1.Index.IndexField.SearchConfig.TextMatchType match_type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Index.IndexField.SearchConfig.TextMatchType

The matchType.

getMatchTypeValue()

public int getMatchTypeValue()

Required. How to match the text field value.

.google.firestore.admin.v1.Index.IndexField.SearchConfig.TextMatchType match_type = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for matchType.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.SearchTextIndexSpec.Builder newBuilderForType()
Returns
Type Description
Index.IndexField.SearchConfig.SearchTextIndexSpec.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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