Class Index.IndexField.SearchConfig.Builder (3.43.1)

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

The configuration for how to index a field for search.

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

Static Methods

getDescriptor()

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

Methods

build()

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

buildPartial()

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

clear()

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

clearGeoSpec()

public Index.IndexField.SearchConfig.Builder clearGeoSpec()

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

clearTextSpec()

public Index.IndexField.SearchConfig.Builder clearTextSpec()

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

getDefaultInstanceForType()

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

getDescriptorForType()

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

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.

getGeoSpecBuilder()

public Index.IndexField.SearchConfig.SearchGeoSpec.Builder getGeoSpecBuilder()

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

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

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.

getTextSpecBuilder()

public Index.IndexField.SearchConfig.SearchTextSpec.Builder getTextSpecBuilder()

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

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Index.IndexField.SearchConfig other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeGeoSpec(Index.IndexField.SearchConfig.SearchGeoSpec value)

public Index.IndexField.SearchConfig.Builder mergeGeoSpec(Index.IndexField.SearchConfig.SearchGeoSpec value)

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

Parameter
Name Description
value Index.IndexField.SearchConfig.SearchGeoSpec
Returns
Type Description
Index.IndexField.SearchConfig.Builder

mergeTextSpec(Index.IndexField.SearchConfig.SearchTextSpec value)

public Index.IndexField.SearchConfig.Builder mergeTextSpec(Index.IndexField.SearchConfig.SearchTextSpec value)

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

Parameter
Name Description
value Index.IndexField.SearchConfig.SearchTextSpec
Returns
Type Description
Index.IndexField.SearchConfig.Builder

setGeoSpec(Index.IndexField.SearchConfig.SearchGeoSpec value)

public Index.IndexField.SearchConfig.Builder setGeoSpec(Index.IndexField.SearchConfig.SearchGeoSpec value)

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

Parameter
Name Description
value Index.IndexField.SearchConfig.SearchGeoSpec
Returns
Type Description
Index.IndexField.SearchConfig.Builder

setGeoSpec(Index.IndexField.SearchConfig.SearchGeoSpec.Builder builderForValue)

public Index.IndexField.SearchConfig.Builder setGeoSpec(Index.IndexField.SearchConfig.SearchGeoSpec.Builder builderForValue)

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

Parameter
Name Description
builderForValue Index.IndexField.SearchConfig.SearchGeoSpec.Builder
Returns
Type Description
Index.IndexField.SearchConfig.Builder

setTextSpec(Index.IndexField.SearchConfig.SearchTextSpec value)

public Index.IndexField.SearchConfig.Builder setTextSpec(Index.IndexField.SearchConfig.SearchTextSpec value)

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

Parameter
Name Description
value Index.IndexField.SearchConfig.SearchTextSpec
Returns
Type Description
Index.IndexField.SearchConfig.Builder

setTextSpec(Index.IndexField.SearchConfig.SearchTextSpec.Builder builderForValue)

public Index.IndexField.SearchConfig.Builder setTextSpec(Index.IndexField.SearchConfig.SearchTextSpec.Builder builderForValue)

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

Parameter
Name Description
builderForValue Index.IndexField.SearchConfig.SearchTextSpec.Builder
Returns
Type Description
Index.IndexField.SearchConfig.Builder