Class Index.IndexField.SearchConfig.SearchTextSpec (3.43.1)

public static final class Index.IndexField.SearchConfig.SearchTextSpec extends GeneratedMessage implements Index.IndexField.SearchConfig.SearchTextSpecOrBuilder

The specification for how to build a text search index for a field.

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

Inheritance

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

Static Fields

INDEX_SPECS_FIELD_NUMBER

public static final int INDEX_SPECS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(Index.IndexField.SearchConfig.SearchTextSpec prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

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

getIndexSpecs(int index)

public Index.IndexField.SearchConfig.SearchTextIndexSpec getIndexSpecs(int index)

Required. Specifications for how the field should be indexed. Repeated so that the field can be indexed in multiple ways.

repeated .google.firestore.admin.v1.Index.IndexField.SearchConfig.SearchTextIndexSpec index_specs = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
Index.IndexField.SearchConfig.SearchTextIndexSpec

getIndexSpecsCount()

public int getIndexSpecsCount()

Required. Specifications for how the field should be indexed. Repeated so that the field can be indexed in multiple ways.

repeated .google.firestore.admin.v1.Index.IndexField.SearchConfig.SearchTextIndexSpec index_specs = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getIndexSpecsList()

public List<Index.IndexField.SearchConfig.SearchTextIndexSpec> getIndexSpecsList()

Required. Specifications for how the field should be indexed. Repeated so that the field can be indexed in multiple ways.

repeated .google.firestore.admin.v1.Index.IndexField.SearchConfig.SearchTextIndexSpec index_specs = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<SearchTextIndexSpec>

getIndexSpecsOrBuilder(int index)

public Index.IndexField.SearchConfig.SearchTextIndexSpecOrBuilder getIndexSpecsOrBuilder(int index)

Required. Specifications for how the field should be indexed. Repeated so that the field can be indexed in multiple ways.

repeated .google.firestore.admin.v1.Index.IndexField.SearchConfig.SearchTextIndexSpec index_specs = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
Index.IndexField.SearchConfig.SearchTextIndexSpecOrBuilder

getIndexSpecsOrBuilderList()

public List<? extends Index.IndexField.SearchConfig.SearchTextIndexSpecOrBuilder> getIndexSpecsOrBuilderList()

Required. Specifications for how the field should be indexed. Repeated so that the field can be indexed in multiple ways.

repeated .google.firestore.admin.v1.Index.IndexField.SearchConfig.SearchTextIndexSpec index_specs = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.firestore.admin.v1.Index.IndexField.SearchConfig.SearchTextIndexSpecOrBuilder>

getParserForType()

public Parser<Index.IndexField.SearchConfig.SearchTextSpec> getParserForType()
Returns
Type Description
Parser<SearchTextSpec>
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.SearchTextSpec.Builder newBuilderForType()
Returns
Type Description
Index.IndexField.SearchConfig.SearchTextSpec.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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