Class Index.IndexField.SearchConfig.SearchTextIndexSpec.Builder (3.43.1)

public static final class Index.IndexField.SearchConfig.SearchTextIndexSpec.Builder extends GeneratedMessage.Builder<Index.IndexField.SearchConfig.SearchTextIndexSpec.Builder> 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

Static Methods

getDescriptor()

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

Methods

build()

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

buildPartial()

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

clear()

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

clearIndexType()

public Index.IndexField.SearchConfig.SearchTextIndexSpec.Builder clearIndexType()

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.SearchTextIndexSpec.Builder

This builder for chaining.

clearMatchType()

public Index.IndexField.SearchConfig.SearchTextIndexSpec.Builder clearMatchType()

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.SearchTextIndexSpec.Builder

This builder for chaining.

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Index.IndexField.SearchConfig.SearchTextIndexSpec other)

public Index.IndexField.SearchConfig.SearchTextIndexSpec.Builder mergeFrom(Index.IndexField.SearchConfig.SearchTextIndexSpec other)
Parameter
Name Description
other Index.IndexField.SearchConfig.SearchTextIndexSpec
Returns
Type Description
Index.IndexField.SearchConfig.SearchTextIndexSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public Index.IndexField.SearchConfig.SearchTextIndexSpec.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Index.IndexField.SearchConfig.SearchTextIndexSpec.Builder
Overrides

setIndexType(Index.IndexField.SearchConfig.TextIndexType value)

public Index.IndexField.SearchConfig.SearchTextIndexSpec.Builder setIndexType(Index.IndexField.SearchConfig.TextIndexType value)

Required. How to index the text field value.

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

Parameter
Name Description
value Index.IndexField.SearchConfig.TextIndexType

The indexType to set.

Returns
Type Description
Index.IndexField.SearchConfig.SearchTextIndexSpec.Builder

This builder for chaining.

setIndexTypeValue(int value)

public Index.IndexField.SearchConfig.SearchTextIndexSpec.Builder setIndexTypeValue(int value)

Required. How to index the text field value.

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

Parameter
Name Description
value int

The enum numeric value on the wire for indexType to set.

Returns
Type Description
Index.IndexField.SearchConfig.SearchTextIndexSpec.Builder

This builder for chaining.

setMatchType(Index.IndexField.SearchConfig.TextMatchType value)

public Index.IndexField.SearchConfig.SearchTextIndexSpec.Builder setMatchType(Index.IndexField.SearchConfig.TextMatchType value)

Required. How to match the text field value.

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

Parameter
Name Description
value Index.IndexField.SearchConfig.TextMatchType

The matchType to set.

Returns
Type Description
Index.IndexField.SearchConfig.SearchTextIndexSpec.Builder

This builder for chaining.

setMatchTypeValue(int value)

public Index.IndexField.SearchConfig.SearchTextIndexSpec.Builder setMatchTypeValue(int value)

Required. How to match the text field value.

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

Parameter
Name Description
value int

The enum numeric value on the wire for matchType to set.

Returns
Type Description
Index.IndexField.SearchConfig.SearchTextIndexSpec.Builder

This builder for chaining.