com.google.cloud.discoveryengine.v1alpha

Class FieldConfig.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<FieldConfig.Builder>

com.google.cloud.discoveryengine.v1alpha.FieldConfig.Builder

All Implemented Interfaces:

FieldConfigOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

FieldConfig

public static final class FieldConfig.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<FieldConfig.Builder>
implements FieldConfigOrBuilder

 Configurations for fields of a schema. For example, configuring a field is
 indexable, or searchable.
 

Protobuf type google.cloud.discoveryengine.v1alpha.FieldConfig

Method Summary

Modifier and Type	Method and Description
FieldConfig.Builder	addAdvancedSiteSearchDataSources(FieldConfig.AdvancedSiteSearchDataSource value) If this field is set, only the corresponding source will be indexed for this field.
FieldConfig.Builder	addAdvancedSiteSearchDataSourcesValue(int value) If this field is set, only the corresponding source will be indexed for this field.
FieldConfig.Builder	addAllAdvancedSiteSearchDataSources(Iterable<? extends FieldConfig.AdvancedSiteSearchDataSource> values) If this field is set, only the corresponding source will be indexed for this field.
FieldConfig.Builder	addAllAdvancedSiteSearchDataSourcesValue(Iterable<Integer> values) If this field is set, only the corresponding source will be indexed for this field.
FieldConfig.Builder	addAllSchemaOrgPaths(Iterable<String> values) Field paths for indexing custom attribute from schema.org data.
FieldConfig.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
FieldConfig.Builder	addSchemaOrgPaths(String value) Field paths for indexing custom attribute from schema.org data.
FieldConfig.Builder	addSchemaOrgPathsBytes(com.google.protobuf.ByteString value) Field paths for indexing custom attribute from schema.org data.
FieldConfig	build()
FieldConfig	buildPartial()
FieldConfig.Builder	clear()
FieldConfig.Builder	clearAdvancedSiteSearchDataSources() If this field is set, only the corresponding source will be indexed for this field.
FieldConfig.Builder	clearCompletableOption() If [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option] is [COMPLETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.COMPLETABLE_ENABLED], field values are directly used and returned as suggestions for Autocomplete in [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery].
FieldConfig.Builder	clearDynamicFacetableOption() If [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option] is [DYNAMIC_FACETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_ENABLED], field values are available for dynamic facet.
FieldConfig.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
FieldConfig.Builder	clearFieldPath() Required.
FieldConfig.Builder	clearFieldType() Output only.
FieldConfig.Builder	clearIndexableOption() If [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option] is [INDEXABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_ENABLED], field values are indexed so that it can be filtered or faceted in [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search].
FieldConfig.Builder	clearKeyPropertyType() Output only.
FieldConfig.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
FieldConfig.Builder	clearRecsFilterableOption() If [recs_filterable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.recs_filterable_option] is [FILTERABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_ENABLED], field values are filterable by filter expression in [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend].
FieldConfig.Builder	clearRetrievableOption() If [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option] is [RETRIEVABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.RETRIEVABLE_ENABLED], field values are included in the search results.
FieldConfig.Builder	clearSchemaOrgPaths() Field paths for indexing custom attribute from schema.org data.
FieldConfig.Builder	clearSearchableOption() If [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option] is [SEARCHABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_ENABLED], field values are searchable by text queries in [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search].
FieldConfig.Builder	clone()
FieldConfig.AdvancedSiteSearchDataSource	getAdvancedSiteSearchDataSources(int index) If this field is set, only the corresponding source will be indexed for this field.
int	getAdvancedSiteSearchDataSourcesCount() If this field is set, only the corresponding source will be indexed for this field.
List<FieldConfig.AdvancedSiteSearchDataSource>	getAdvancedSiteSearchDataSourcesList() If this field is set, only the corresponding source will be indexed for this field.
int	getAdvancedSiteSearchDataSourcesValue(int index) If this field is set, only the corresponding source will be indexed for this field.
List<Integer>	getAdvancedSiteSearchDataSourcesValueList() If this field is set, only the corresponding source will be indexed for this field.
FieldConfig.CompletableOption	getCompletableOption() If [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option] is [COMPLETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.COMPLETABLE_ENABLED], field values are directly used and returned as suggestions for Autocomplete in [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery].
int	getCompletableOptionValue() If [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option] is [COMPLETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.COMPLETABLE_ENABLED], field values are directly used and returned as suggestions for Autocomplete in [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery].
FieldConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
FieldConfig.DynamicFacetableOption	getDynamicFacetableOption() If [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option] is [DYNAMIC_FACETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_ENABLED], field values are available for dynamic facet.
int	getDynamicFacetableOptionValue() If [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option] is [DYNAMIC_FACETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_ENABLED], field values are available for dynamic facet.
String	getFieldPath() Required.
com.google.protobuf.ByteString	getFieldPathBytes() Required.
FieldConfig.FieldType	getFieldType() Output only.
int	getFieldTypeValue() Output only.
FieldConfig.IndexableOption	getIndexableOption() If [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option] is [INDEXABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_ENABLED], field values are indexed so that it can be filtered or faceted in [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search].
int	getIndexableOptionValue() If [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option] is [INDEXABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_ENABLED], field values are indexed so that it can be filtered or faceted in [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search].
String	getKeyPropertyType() Output only.
com.google.protobuf.ByteString	getKeyPropertyTypeBytes() Output only.
FieldConfig.FilterableOption	getRecsFilterableOption() If [recs_filterable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.recs_filterable_option] is [FILTERABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_ENABLED], field values are filterable by filter expression in [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend].
int	getRecsFilterableOptionValue() If [recs_filterable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.recs_filterable_option] is [FILTERABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_ENABLED], field values are filterable by filter expression in [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend].
FieldConfig.RetrievableOption	getRetrievableOption() If [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option] is [RETRIEVABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.RETRIEVABLE_ENABLED], field values are included in the search results.
int	getRetrievableOptionValue() If [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option] is [RETRIEVABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.RETRIEVABLE_ENABLED], field values are included in the search results.
String	getSchemaOrgPaths(int index) Field paths for indexing custom attribute from schema.org data.
com.google.protobuf.ByteString	getSchemaOrgPathsBytes(int index) Field paths for indexing custom attribute from schema.org data.
int	getSchemaOrgPathsCount() Field paths for indexing custom attribute from schema.org data.
com.google.protobuf.ProtocolStringList	getSchemaOrgPathsList() Field paths for indexing custom attribute from schema.org data.
FieldConfig.SearchableOption	getSearchableOption() If [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option] is [SEARCHABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_ENABLED], field values are searchable by text queries in [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search].
int	getSearchableOptionValue() If [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option] is [SEARCHABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_ENABLED], field values are searchable by text queries in [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search].
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
FieldConfig.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
FieldConfig.Builder	mergeFrom(FieldConfig other)
FieldConfig.Builder	mergeFrom(com.google.protobuf.Message other)
FieldConfig.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
FieldConfig.Builder	setAdvancedSiteSearchDataSources(int index, FieldConfig.AdvancedSiteSearchDataSource value) If this field is set, only the corresponding source will be indexed for this field.
FieldConfig.Builder	setAdvancedSiteSearchDataSourcesValue(int index, int value) If this field is set, only the corresponding source will be indexed for this field.
FieldConfig.Builder	setCompletableOption(FieldConfig.CompletableOption value) If [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option] is [COMPLETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.COMPLETABLE_ENABLED], field values are directly used and returned as suggestions for Autocomplete in [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery].
FieldConfig.Builder	setCompletableOptionValue(int value) If [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option] is [COMPLETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.COMPLETABLE_ENABLED], field values are directly used and returned as suggestions for Autocomplete in [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery].
FieldConfig.Builder	setDynamicFacetableOption(FieldConfig.DynamicFacetableOption value) If [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option] is [DYNAMIC_FACETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_ENABLED], field values are available for dynamic facet.
FieldConfig.Builder	setDynamicFacetableOptionValue(int value) If [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option] is [DYNAMIC_FACETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_ENABLED], field values are available for dynamic facet.
FieldConfig.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
FieldConfig.Builder	setFieldPath(String value) Required.
FieldConfig.Builder	setFieldPathBytes(com.google.protobuf.ByteString value) Required.
FieldConfig.Builder	setFieldType(FieldConfig.FieldType value) Output only.
FieldConfig.Builder	setFieldTypeValue(int value) Output only.
FieldConfig.Builder	setIndexableOption(FieldConfig.IndexableOption value) If [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option] is [INDEXABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_ENABLED], field values are indexed so that it can be filtered or faceted in [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search].
FieldConfig.Builder	setIndexableOptionValue(int value) If [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option] is [INDEXABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_ENABLED], field values are indexed so that it can be filtered or faceted in [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search].
FieldConfig.Builder	setKeyPropertyType(String value) Output only.
FieldConfig.Builder	setKeyPropertyTypeBytes(com.google.protobuf.ByteString value) Output only.
FieldConfig.Builder	setRecsFilterableOption(FieldConfig.FilterableOption value) If [recs_filterable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.recs_filterable_option] is [FILTERABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_ENABLED], field values are filterable by filter expression in [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend].
FieldConfig.Builder	setRecsFilterableOptionValue(int value) If [recs_filterable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.recs_filterable_option] is [FILTERABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_ENABLED], field values are filterable by filter expression in [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend].
FieldConfig.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
FieldConfig.Builder	setRetrievableOption(FieldConfig.RetrievableOption value) If [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option] is [RETRIEVABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.RETRIEVABLE_ENABLED], field values are included in the search results.
FieldConfig.Builder	setRetrievableOptionValue(int value) If [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option] is [RETRIEVABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.RETRIEVABLE_ENABLED], field values are included in the search results.
FieldConfig.Builder	setSchemaOrgPaths(int index, String value) Field paths for indexing custom attribute from schema.org data.
FieldConfig.Builder	setSearchableOption(FieldConfig.SearchableOption value) If [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option] is [SEARCHABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_ENABLED], field values are searchable by text queries in [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search].
FieldConfig.Builder	setSearchableOptionValue(int value) If [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option] is [SEARCHABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_ENABLED], field values are searchable by text queries in [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search].
FieldConfig.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<FieldConfig.Builder>

clear

public FieldConfig.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<FieldConfig.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<FieldConfig.Builder>

getDefaultInstanceForType

public FieldConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public FieldConfig build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public FieldConfig buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public FieldConfig.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<FieldConfig.Builder>

setField

public FieldConfig.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                    Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<FieldConfig.Builder>

clearField

public FieldConfig.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<FieldConfig.Builder>

clearOneof

public FieldConfig.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<FieldConfig.Builder>

setRepeatedField

public FieldConfig.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            int index,
                                            Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<FieldConfig.Builder>

addRepeatedField

public FieldConfig.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<FieldConfig.Builder>

mergeFrom

public FieldConfig.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FieldConfig.Builder>

mergeFrom

public FieldConfig.Builder mergeFrom(FieldConfig other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<FieldConfig.Builder>

mergeFrom

public FieldConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<FieldConfig.Builder>

Throws:

IOException

getFieldPath

public String getFieldPath()

 Required. Field path of the schema field.
 For example: `title`, `description`, `release_info.release_year`.
 

string field_path = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getFieldPath in interface FieldConfigOrBuilder

Returns:

The fieldPath.

getFieldPathBytes

public com.google.protobuf.ByteString getFieldPathBytes()

 Required. Field path of the schema field.
 For example: `title`, `description`, `release_info.release_year`.
 

string field_path = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getFieldPathBytes in interface FieldConfigOrBuilder

Returns:

The bytes for fieldPath.

setFieldPath

public FieldConfig.Builder setFieldPath(String value)

 Required. Field path of the schema field.
 For example: `title`, `description`, `release_info.release_year`.
 

string field_path = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters:

value - The fieldPath to set.

Returns:

This builder for chaining.

clearFieldPath

public FieldConfig.Builder clearFieldPath()

 Required. Field path of the schema field.
 For example: `title`, `description`, `release_info.release_year`.
 

string field_path = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

This builder for chaining.

setFieldPathBytes

public FieldConfig.Builder setFieldPathBytes(com.google.protobuf.ByteString value)

 Required. Field path of the schema field.
 For example: `title`, `description`, `release_info.release_year`.
 

string field_path = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters:

value - The bytes for fieldPath to set.

Returns:

This builder for chaining.

getFieldTypeValue

public int getFieldTypeValue()

 Output only. Raw type of the field.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.FieldType field_type = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getFieldTypeValue in interface FieldConfigOrBuilder

Returns:

The enum numeric value on the wire for fieldType.

setFieldTypeValue

public FieldConfig.Builder setFieldTypeValue(int value)

 Output only. Raw type of the field.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.FieldType field_type = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters:

value - The enum numeric value on the wire for fieldType to set.

Returns:

This builder for chaining.

getFieldType

public FieldConfig.FieldType getFieldType()

 Output only. Raw type of the field.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.FieldType field_type = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getFieldType in interface FieldConfigOrBuilder

Returns:

The fieldType.

setFieldType

public FieldConfig.Builder setFieldType(FieldConfig.FieldType value)

 Output only. Raw type of the field.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.FieldType field_type = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters:

value - The fieldType to set.

Returns:

This builder for chaining.

clearFieldType

public FieldConfig.Builder clearFieldType()

 Output only. Raw type of the field.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.FieldType field_type = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

This builder for chaining.

getIndexableOptionValue

public int getIndexableOptionValue()

 If
 [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
 is
 [INDEXABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_ENABLED],
 field values are indexed so that it can be filtered or faceted in
 [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search].

 If
 [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
 is unset, the server behavior defaults to
 [INDEXABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_DISABLED]
 for fields that support setting indexable options. For those fields that do
 not support setting indexable options, such as `object` and `boolean` and
 key properties, the server will skip
 [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
 setting, and setting
 [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
 for those fields will throw `INVALID_ARGUMENT` error.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption indexable_option = 3;

Specified by:

getIndexableOptionValue in interface FieldConfigOrBuilder

Returns:

The enum numeric value on the wire for indexableOption.

setIndexableOptionValue

public FieldConfig.Builder setIndexableOptionValue(int value)

 If
 [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
 is
 [INDEXABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_ENABLED],
 field values are indexed so that it can be filtered or faceted in
 [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search].

 If
 [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
 is unset, the server behavior defaults to
 [INDEXABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_DISABLED]
 for fields that support setting indexable options. For those fields that do
 not support setting indexable options, such as `object` and `boolean` and
 key properties, the server will skip
 [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
 setting, and setting
 [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
 for those fields will throw `INVALID_ARGUMENT` error.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption indexable_option = 3;

Parameters:

value - The enum numeric value on the wire for indexableOption to set.

Returns:

This builder for chaining.

getIndexableOption

public FieldConfig.IndexableOption getIndexableOption()

 If
 [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
 is
 [INDEXABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_ENABLED],
 field values are indexed so that it can be filtered or faceted in
 [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search].

 If
 [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
 is unset, the server behavior defaults to
 [INDEXABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_DISABLED]
 for fields that support setting indexable options. For those fields that do
 not support setting indexable options, such as `object` and `boolean` and
 key properties, the server will skip
 [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
 setting, and setting
 [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
 for those fields will throw `INVALID_ARGUMENT` error.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption indexable_option = 3;

Specified by:

getIndexableOption in interface FieldConfigOrBuilder

Returns:

The indexableOption.

setIndexableOption

public FieldConfig.Builder setIndexableOption(FieldConfig.IndexableOption value)

 If
 [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
 is
 [INDEXABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_ENABLED],
 field values are indexed so that it can be filtered or faceted in
 [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search].

 If
 [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
 is unset, the server behavior defaults to
 [INDEXABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_DISABLED]
 for fields that support setting indexable options. For those fields that do
 not support setting indexable options, such as `object` and `boolean` and
 key properties, the server will skip
 [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
 setting, and setting
 [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
 for those fields will throw `INVALID_ARGUMENT` error.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption indexable_option = 3;

Parameters:

value - The indexableOption to set.

Returns:

This builder for chaining.

clearIndexableOption

public FieldConfig.Builder clearIndexableOption()

 If
 [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
 is
 [INDEXABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_ENABLED],
 field values are indexed so that it can be filtered or faceted in
 [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search].

 If
 [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
 is unset, the server behavior defaults to
 [INDEXABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_DISABLED]
 for fields that support setting indexable options. For those fields that do
 not support setting indexable options, such as `object` and `boolean` and
 key properties, the server will skip
 [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
 setting, and setting
 [indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
 for those fields will throw `INVALID_ARGUMENT` error.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption indexable_option = 3;

Returns:

This builder for chaining.

getDynamicFacetableOptionValue

public int getDynamicFacetableOptionValue()

 If
 [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option]
 is
 [DYNAMIC_FACETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_ENABLED],
 field values are available for dynamic facet. Could only be
 [DYNAMIC_FACETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_DISABLED]
 if
 [FieldConfig.indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
 is
 [INDEXABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_DISABLED].
 Otherwise, an `INVALID_ARGUMENT` error will be returned.

 If
 [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option]
 is unset, the server behavior defaults to
 [DYNAMIC_FACETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_DISABLED]
 for fields that support setting dynamic facetable options. For those fields
 that do not support setting dynamic facetable options, such as `object` and
 `boolean`, the server will skip dynamic facetable option setting, and
 setting
 [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option]
 for those fields will throw `INVALID_ARGUMENT` error.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption dynamic_facetable_option = 4;

Specified by:

getDynamicFacetableOptionValue in interface FieldConfigOrBuilder

Returns:

The enum numeric value on the wire for dynamicFacetableOption.

setDynamicFacetableOptionValue

public FieldConfig.Builder setDynamicFacetableOptionValue(int value)

 If
 [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option]
 is
 [DYNAMIC_FACETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_ENABLED],
 field values are available for dynamic facet. Could only be
 [DYNAMIC_FACETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_DISABLED]
 if
 [FieldConfig.indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
 is
 [INDEXABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_DISABLED].
 Otherwise, an `INVALID_ARGUMENT` error will be returned.

 If
 [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option]
 is unset, the server behavior defaults to
 [DYNAMIC_FACETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_DISABLED]
 for fields that support setting dynamic facetable options. For those fields
 that do not support setting dynamic facetable options, such as `object` and
 `boolean`, the server will skip dynamic facetable option setting, and
 setting
 [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option]
 for those fields will throw `INVALID_ARGUMENT` error.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption dynamic_facetable_option = 4;

Parameters:

value - The enum numeric value on the wire for dynamicFacetableOption to set.

Returns:

This builder for chaining.

getDynamicFacetableOption

public FieldConfig.DynamicFacetableOption getDynamicFacetableOption()

 If
 [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option]
 is
 [DYNAMIC_FACETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_ENABLED],
 field values are available for dynamic facet. Could only be
 [DYNAMIC_FACETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_DISABLED]
 if
 [FieldConfig.indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
 is
 [INDEXABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_DISABLED].
 Otherwise, an `INVALID_ARGUMENT` error will be returned.

 If
 [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option]
 is unset, the server behavior defaults to
 [DYNAMIC_FACETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_DISABLED]
 for fields that support setting dynamic facetable options. For those fields
 that do not support setting dynamic facetable options, such as `object` and
 `boolean`, the server will skip dynamic facetable option setting, and
 setting
 [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option]
 for those fields will throw `INVALID_ARGUMENT` error.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption dynamic_facetable_option = 4;

Specified by:

getDynamicFacetableOption in interface FieldConfigOrBuilder

Returns:

The dynamicFacetableOption.

setDynamicFacetableOption

public FieldConfig.Builder setDynamicFacetableOption(FieldConfig.DynamicFacetableOption value)

 If
 [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option]
 is
 [DYNAMIC_FACETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_ENABLED],
 field values are available for dynamic facet. Could only be
 [DYNAMIC_FACETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_DISABLED]
 if
 [FieldConfig.indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
 is
 [INDEXABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_DISABLED].
 Otherwise, an `INVALID_ARGUMENT` error will be returned.

 If
 [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option]
 is unset, the server behavior defaults to
 [DYNAMIC_FACETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_DISABLED]
 for fields that support setting dynamic facetable options. For those fields
 that do not support setting dynamic facetable options, such as `object` and
 `boolean`, the server will skip dynamic facetable option setting, and
 setting
 [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option]
 for those fields will throw `INVALID_ARGUMENT` error.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption dynamic_facetable_option = 4;

Parameters:

value - The dynamicFacetableOption to set.

Returns:

This builder for chaining.

clearDynamicFacetableOption

public FieldConfig.Builder clearDynamicFacetableOption()

 If
 [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option]
 is
 [DYNAMIC_FACETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_ENABLED],
 field values are available for dynamic facet. Could only be
 [DYNAMIC_FACETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_DISABLED]
 if
 [FieldConfig.indexable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.indexable_option]
 is
 [INDEXABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption.INDEXABLE_DISABLED].
 Otherwise, an `INVALID_ARGUMENT` error will be returned.

 If
 [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option]
 is unset, the server behavior defaults to
 [DYNAMIC_FACETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption.DYNAMIC_FACETABLE_DISABLED]
 for fields that support setting dynamic facetable options. For those fields
 that do not support setting dynamic facetable options, such as `object` and
 `boolean`, the server will skip dynamic facetable option setting, and
 setting
 [dynamic_facetable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.dynamic_facetable_option]
 for those fields will throw `INVALID_ARGUMENT` error.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption dynamic_facetable_option = 4;

Returns:

This builder for chaining.

getSearchableOptionValue

public int getSearchableOptionValue()

 If
 [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option]
 is
 [SEARCHABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_ENABLED],
 field values are searchable by text queries in
 [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search].

 If
 [SEARCHABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_ENABLED]
 but field type is numerical, field values will not be searchable by text
 queries in
 [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search],
 as there are no text values associated to numerical fields.

 If
 [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option]
 is unset, the server behavior defaults to
 [SEARCHABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_DISABLED]
 for fields that support setting searchable options. Only `string` fields
 that have no key property mapping support setting
 [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option].

 For those fields that do not support setting searchable options, the server
 will skip searchable option setting, and setting
 [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option]
 for those fields will throw `INVALID_ARGUMENT` error.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption searchable_option = 5;

Specified by:

getSearchableOptionValue in interface FieldConfigOrBuilder

Returns:

The enum numeric value on the wire for searchableOption.

setSearchableOptionValue

public FieldConfig.Builder setSearchableOptionValue(int value)

 If
 [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option]
 is
 [SEARCHABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_ENABLED],
 field values are searchable by text queries in
 [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search].

 If
 [SEARCHABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_ENABLED]
 but field type is numerical, field values will not be searchable by text
 queries in
 [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search],
 as there are no text values associated to numerical fields.

 If
 [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option]
 is unset, the server behavior defaults to
 [SEARCHABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_DISABLED]
 for fields that support setting searchable options. Only `string` fields
 that have no key property mapping support setting
 [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option].

 For those fields that do not support setting searchable options, the server
 will skip searchable option setting, and setting
 [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option]
 for those fields will throw `INVALID_ARGUMENT` error.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption searchable_option = 5;

Parameters:

value - The enum numeric value on the wire for searchableOption to set.

Returns:

This builder for chaining.

getSearchableOption

public FieldConfig.SearchableOption getSearchableOption()

 If
 [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option]
 is
 [SEARCHABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_ENABLED],
 field values are searchable by text queries in
 [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search].

 If
 [SEARCHABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_ENABLED]
 but field type is numerical, field values will not be searchable by text
 queries in
 [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search],
 as there are no text values associated to numerical fields.

 If
 [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option]
 is unset, the server behavior defaults to
 [SEARCHABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_DISABLED]
 for fields that support setting searchable options. Only `string` fields
 that have no key property mapping support setting
 [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option].

 For those fields that do not support setting searchable options, the server
 will skip searchable option setting, and setting
 [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option]
 for those fields will throw `INVALID_ARGUMENT` error.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption searchable_option = 5;

Specified by:

getSearchableOption in interface FieldConfigOrBuilder

Returns:

The searchableOption.

setSearchableOption

public FieldConfig.Builder setSearchableOption(FieldConfig.SearchableOption value)

 If
 [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option]
 is
 [SEARCHABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_ENABLED],
 field values are searchable by text queries in
 [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search].

 If
 [SEARCHABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_ENABLED]
 but field type is numerical, field values will not be searchable by text
 queries in
 [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search],
 as there are no text values associated to numerical fields.

 If
 [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option]
 is unset, the server behavior defaults to
 [SEARCHABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_DISABLED]
 for fields that support setting searchable options. Only `string` fields
 that have no key property mapping support setting
 [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option].

 For those fields that do not support setting searchable options, the server
 will skip searchable option setting, and setting
 [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option]
 for those fields will throw `INVALID_ARGUMENT` error.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption searchable_option = 5;

Parameters:

value - The searchableOption to set.

Returns:

This builder for chaining.

clearSearchableOption

public FieldConfig.Builder clearSearchableOption()

 If
 [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option]
 is
 [SEARCHABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_ENABLED],
 field values are searchable by text queries in
 [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search].

 If
 [SEARCHABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_ENABLED]
 but field type is numerical, field values will not be searchable by text
 queries in
 [SearchService.Search][google.cloud.discoveryengine.v1alpha.SearchService.Search],
 as there are no text values associated to numerical fields.

 If
 [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option]
 is unset, the server behavior defaults to
 [SEARCHABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption.SEARCHABLE_DISABLED]
 for fields that support setting searchable options. Only `string` fields
 that have no key property mapping support setting
 [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option].

 For those fields that do not support setting searchable options, the server
 will skip searchable option setting, and setting
 [searchable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.searchable_option]
 for those fields will throw `INVALID_ARGUMENT` error.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption searchable_option = 5;

Returns:

This builder for chaining.

getRetrievableOptionValue

public int getRetrievableOptionValue()

 If
 [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option]
 is
 [RETRIEVABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.RETRIEVABLE_ENABLED],
 field values are included in the search results.

 If
 [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option]
 is unset, the server behavior defaults to
 [RETRIEVABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.RETRIEVABLE_DISABLED]
 for fields that support setting retrievable options. For those fields
 that do not support setting retrievable options, such as `object` and
 `boolean`, the server will skip retrievable option setting, and setting
 [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option]
 for those fields will throw `INVALID_ARGUMENT` error.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption retrievable_option = 6;

Specified by:

getRetrievableOptionValue in interface FieldConfigOrBuilder

Returns:

The enum numeric value on the wire for retrievableOption.

setRetrievableOptionValue

public FieldConfig.Builder setRetrievableOptionValue(int value)

 If
 [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option]
 is
 [RETRIEVABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.RETRIEVABLE_ENABLED],
 field values are included in the search results.

 If
 [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option]
 is unset, the server behavior defaults to
 [RETRIEVABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.RETRIEVABLE_DISABLED]
 for fields that support setting retrievable options. For those fields
 that do not support setting retrievable options, such as `object` and
 `boolean`, the server will skip retrievable option setting, and setting
 [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option]
 for those fields will throw `INVALID_ARGUMENT` error.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption retrievable_option = 6;

Parameters:

value - The enum numeric value on the wire for retrievableOption to set.

Returns:

This builder for chaining.

getRetrievableOption

public FieldConfig.RetrievableOption getRetrievableOption()

 If
 [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option]
 is
 [RETRIEVABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.RETRIEVABLE_ENABLED],
 field values are included in the search results.

 If
 [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option]
 is unset, the server behavior defaults to
 [RETRIEVABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.RETRIEVABLE_DISABLED]
 for fields that support setting retrievable options. For those fields
 that do not support setting retrievable options, such as `object` and
 `boolean`, the server will skip retrievable option setting, and setting
 [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option]
 for those fields will throw `INVALID_ARGUMENT` error.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption retrievable_option = 6;

Specified by:

getRetrievableOption in interface FieldConfigOrBuilder

Returns:

The retrievableOption.

setRetrievableOption

public FieldConfig.Builder setRetrievableOption(FieldConfig.RetrievableOption value)

 If
 [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option]
 is
 [RETRIEVABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.RETRIEVABLE_ENABLED],
 field values are included in the search results.

 If
 [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option]
 is unset, the server behavior defaults to
 [RETRIEVABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.RETRIEVABLE_DISABLED]
 for fields that support setting retrievable options. For those fields
 that do not support setting retrievable options, such as `object` and
 `boolean`, the server will skip retrievable option setting, and setting
 [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option]
 for those fields will throw `INVALID_ARGUMENT` error.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption retrievable_option = 6;

Parameters:

value - The retrievableOption to set.

Returns:

This builder for chaining.

clearRetrievableOption

public FieldConfig.Builder clearRetrievableOption()

 If
 [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option]
 is
 [RETRIEVABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.RETRIEVABLE_ENABLED],
 field values are included in the search results.

 If
 [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option]
 is unset, the server behavior defaults to
 [RETRIEVABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption.RETRIEVABLE_DISABLED]
 for fields that support setting retrievable options. For those fields
 that do not support setting retrievable options, such as `object` and
 `boolean`, the server will skip retrievable option setting, and setting
 [retrievable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.retrievable_option]
 for those fields will throw `INVALID_ARGUMENT` error.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption retrievable_option = 6;

Returns:

This builder for chaining.

getCompletableOptionValue

public int getCompletableOptionValue()

 If
 [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option]
 is
 [COMPLETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.COMPLETABLE_ENABLED],
 field values are directly used and returned as suggestions for Autocomplete
 in
 [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery].

 If
 [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option]
 is unset, the server behavior defaults to
 [COMPLETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.COMPLETABLE_DISABLED]
 for fields that support setting completable options, which are just
 `string` fields. For those fields that do not support setting completable
 options, the server will skip completable option setting, and setting
 [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option]
 for those fields will throw `INVALID_ARGUMENT` error.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption completable_option = 8;

Specified by:

getCompletableOptionValue in interface FieldConfigOrBuilder

Returns:

The enum numeric value on the wire for completableOption.

setCompletableOptionValue

public FieldConfig.Builder setCompletableOptionValue(int value)

 If
 [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option]
 is
 [COMPLETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.COMPLETABLE_ENABLED],
 field values are directly used and returned as suggestions for Autocomplete
 in
 [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery].

 If
 [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option]
 is unset, the server behavior defaults to
 [COMPLETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.COMPLETABLE_DISABLED]
 for fields that support setting completable options, which are just
 `string` fields. For those fields that do not support setting completable
 options, the server will skip completable option setting, and setting
 [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option]
 for those fields will throw `INVALID_ARGUMENT` error.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption completable_option = 8;

Parameters:

value - The enum numeric value on the wire for completableOption to set.

Returns:

This builder for chaining.

getCompletableOption

public FieldConfig.CompletableOption getCompletableOption()

 If
 [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option]
 is
 [COMPLETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.COMPLETABLE_ENABLED],
 field values are directly used and returned as suggestions for Autocomplete
 in
 [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery].

 If
 [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option]
 is unset, the server behavior defaults to
 [COMPLETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.COMPLETABLE_DISABLED]
 for fields that support setting completable options, which are just
 `string` fields. For those fields that do not support setting completable
 options, the server will skip completable option setting, and setting
 [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option]
 for those fields will throw `INVALID_ARGUMENT` error.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption completable_option = 8;

Specified by:

getCompletableOption in interface FieldConfigOrBuilder

Returns:

The completableOption.

setCompletableOption

public FieldConfig.Builder setCompletableOption(FieldConfig.CompletableOption value)

 If
 [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option]
 is
 [COMPLETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.COMPLETABLE_ENABLED],
 field values are directly used and returned as suggestions for Autocomplete
 in
 [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery].

 If
 [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option]
 is unset, the server behavior defaults to
 [COMPLETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.COMPLETABLE_DISABLED]
 for fields that support setting completable options, which are just
 `string` fields. For those fields that do not support setting completable
 options, the server will skip completable option setting, and setting
 [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option]
 for those fields will throw `INVALID_ARGUMENT` error.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption completable_option = 8;

Parameters:

value - The completableOption to set.

Returns:

This builder for chaining.

clearCompletableOption

public FieldConfig.Builder clearCompletableOption()

 If
 [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option]
 is
 [COMPLETABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.COMPLETABLE_ENABLED],
 field values are directly used and returned as suggestions for Autocomplete
 in
 [CompletionService.CompleteQuery][google.cloud.discoveryengine.v1alpha.CompletionService.CompleteQuery].

 If
 [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option]
 is unset, the server behavior defaults to
 [COMPLETABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption.COMPLETABLE_DISABLED]
 for fields that support setting completable options, which are just
 `string` fields. For those fields that do not support setting completable
 options, the server will skip completable option setting, and setting
 [completable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.completable_option]
 for those fields will throw `INVALID_ARGUMENT` error.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption completable_option = 8;

Returns:

This builder for chaining.

getRecsFilterableOptionValue

public int getRecsFilterableOptionValue()

 If
 [recs_filterable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.recs_filterable_option]
 is
 [FILTERABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_ENABLED],
 field values are filterable by filter expression in
 [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend].

 If
 [FILTERABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_ENABLED]
 but the field type is numerical, field values are not filterable by text
 queries in
 [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend].
 Only textual fields are supported.

 If
 [recs_filterable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.recs_filterable_option]
 is unset, the default setting is
 [FILTERABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_DISABLED]
 for fields that support setting filterable options.

 When a field set to [FILTERABLE_DISABLED] is filtered, a warning is
 generated and an empty result is returned.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption recs_filterable_option = 9;

Specified by:

getRecsFilterableOptionValue in interface FieldConfigOrBuilder

Returns:

The enum numeric value on the wire for recsFilterableOption.

setRecsFilterableOptionValue

public FieldConfig.Builder setRecsFilterableOptionValue(int value)

 If
 [recs_filterable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.recs_filterable_option]
 is
 [FILTERABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_ENABLED],
 field values are filterable by filter expression in
 [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend].

 If
 [FILTERABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_ENABLED]
 but the field type is numerical, field values are not filterable by text
 queries in
 [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend].
 Only textual fields are supported.

 If
 [recs_filterable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.recs_filterable_option]
 is unset, the default setting is
 [FILTERABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_DISABLED]
 for fields that support setting filterable options.

 When a field set to [FILTERABLE_DISABLED] is filtered, a warning is
 generated and an empty result is returned.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption recs_filterable_option = 9;

Parameters:

value - The enum numeric value on the wire for recsFilterableOption to set.

Returns:

This builder for chaining.

getRecsFilterableOption

public FieldConfig.FilterableOption getRecsFilterableOption()

 If
 [recs_filterable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.recs_filterable_option]
 is
 [FILTERABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_ENABLED],
 field values are filterable by filter expression in
 [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend].

 If
 [FILTERABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_ENABLED]
 but the field type is numerical, field values are not filterable by text
 queries in
 [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend].
 Only textual fields are supported.

 If
 [recs_filterable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.recs_filterable_option]
 is unset, the default setting is
 [FILTERABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_DISABLED]
 for fields that support setting filterable options.

 When a field set to [FILTERABLE_DISABLED] is filtered, a warning is
 generated and an empty result is returned.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption recs_filterable_option = 9;

Specified by:

getRecsFilterableOption in interface FieldConfigOrBuilder

Returns:

The recsFilterableOption.

setRecsFilterableOption

public FieldConfig.Builder setRecsFilterableOption(FieldConfig.FilterableOption value)

 If
 [recs_filterable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.recs_filterable_option]
 is
 [FILTERABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_ENABLED],
 field values are filterable by filter expression in
 [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend].

 If
 [FILTERABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_ENABLED]
 but the field type is numerical, field values are not filterable by text
 queries in
 [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend].
 Only textual fields are supported.

 If
 [recs_filterable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.recs_filterable_option]
 is unset, the default setting is
 [FILTERABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_DISABLED]
 for fields that support setting filterable options.

 When a field set to [FILTERABLE_DISABLED] is filtered, a warning is
 generated and an empty result is returned.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption recs_filterable_option = 9;

Parameters:

value - The recsFilterableOption to set.

Returns:

This builder for chaining.

clearRecsFilterableOption

public FieldConfig.Builder clearRecsFilterableOption()

 If
 [recs_filterable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.recs_filterable_option]
 is
 [FILTERABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_ENABLED],
 field values are filterable by filter expression in
 [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend].

 If
 [FILTERABLE_ENABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_ENABLED]
 but the field type is numerical, field values are not filterable by text
 queries in
 [RecommendationService.Recommend][google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend].
 Only textual fields are supported.

 If
 [recs_filterable_option][google.cloud.discoveryengine.v1alpha.FieldConfig.recs_filterable_option]
 is unset, the default setting is
 [FILTERABLE_DISABLED][google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption.FILTERABLE_DISABLED]
 for fields that support setting filterable options.

 When a field set to [FILTERABLE_DISABLED] is filtered, a warning is
 generated and an empty result is returned.
 

.google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption recs_filterable_option = 9;

Returns:

This builder for chaining.

getKeyPropertyType

public String getKeyPropertyType()

 Output only. Type of the key property that this field is mapped to. Empty
 string if this is not annotated as mapped to a key property.

 Example types are `title`, `description`. Full list is defined
 by `keyPropertyMapping` in the schema field annotation.

 If the schema field has a `KeyPropertyMapping` annotation,
 `indexable_option` and `searchable_option` of this field cannot be
 modified.
 

string key_property_type = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getKeyPropertyType in interface FieldConfigOrBuilder

Returns:

The keyPropertyType.

getKeyPropertyTypeBytes

public com.google.protobuf.ByteString getKeyPropertyTypeBytes()

 Output only. Type of the key property that this field is mapped to. Empty
 string if this is not annotated as mapped to a key property.

 Example types are `title`, `description`. Full list is defined
 by `keyPropertyMapping` in the schema field annotation.

 If the schema field has a `KeyPropertyMapping` annotation,
 `indexable_option` and `searchable_option` of this field cannot be
 modified.
 

string key_property_type = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:

getKeyPropertyTypeBytes in interface FieldConfigOrBuilder

Returns:

The bytes for keyPropertyType.

setKeyPropertyType

public FieldConfig.Builder setKeyPropertyType(String value)

 Output only. Type of the key property that this field is mapped to. Empty
 string if this is not annotated as mapped to a key property.

 Example types are `title`, `description`. Full list is defined
 by `keyPropertyMapping` in the schema field annotation.

 If the schema field has a `KeyPropertyMapping` annotation,
 `indexable_option` and `searchable_option` of this field cannot be
 modified.
 

string key_property_type = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters:

value - The keyPropertyType to set.

Returns:

This builder for chaining.

clearKeyPropertyType

public FieldConfig.Builder clearKeyPropertyType()

 Output only. Type of the key property that this field is mapped to. Empty
 string if this is not annotated as mapped to a key property.

 Example types are `title`, `description`. Full list is defined
 by `keyPropertyMapping` in the schema field annotation.

 If the schema field has a `KeyPropertyMapping` annotation,
 `indexable_option` and `searchable_option` of this field cannot be
 modified.
 

string key_property_type = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

This builder for chaining.

setKeyPropertyTypeBytes

public FieldConfig.Builder setKeyPropertyTypeBytes(com.google.protobuf.ByteString value)

 Output only. Type of the key property that this field is mapped to. Empty
 string if this is not annotated as mapped to a key property.

 Example types are `title`, `description`. Full list is defined
 by `keyPropertyMapping` in the schema field annotation.

 If the schema field has a `KeyPropertyMapping` annotation,
 `indexable_option` and `searchable_option` of this field cannot be
 modified.
 

string key_property_type = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters:

value - The bytes for keyPropertyType to set.

Returns:

This builder for chaining.

getAdvancedSiteSearchDataSourcesList

public List<FieldConfig.AdvancedSiteSearchDataSource> getAdvancedSiteSearchDataSourcesList()

 If this field is set, only the corresponding source will be indexed for
 this field. Otherwise, the values from different sources are merged.

 Assuming a page with `<author, a>` in meta tag, and `<author, b>` in page
 map:
  if this enum is set to METATAGS, we will only index `<author, a>`;
  if this enum is not set, we will merge them and index `<author, [a, b]>`.
 

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig.AdvancedSiteSearchDataSource advanced_site_search_data_sources = 10;

Specified by:

getAdvancedSiteSearchDataSourcesList in interface FieldConfigOrBuilder

Returns:

A list containing the advancedSiteSearchDataSources.

getAdvancedSiteSearchDataSourcesCount

public int getAdvancedSiteSearchDataSourcesCount()

 If this field is set, only the corresponding source will be indexed for
 this field. Otherwise, the values from different sources are merged.

 Assuming a page with `<author, a>` in meta tag, and `<author, b>` in page
 map:
  if this enum is set to METATAGS, we will only index `<author, a>`;
  if this enum is not set, we will merge them and index `<author, [a, b]>`.
 

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig.AdvancedSiteSearchDataSource advanced_site_search_data_sources = 10;

Specified by:

getAdvancedSiteSearchDataSourcesCount in interface FieldConfigOrBuilder

Returns:

The count of advancedSiteSearchDataSources.

getAdvancedSiteSearchDataSources

public FieldConfig.AdvancedSiteSearchDataSource getAdvancedSiteSearchDataSources(int index)

 If this field is set, only the corresponding source will be indexed for
 this field. Otherwise, the values from different sources are merged.

 Assuming a page with `<author, a>` in meta tag, and `<author, b>` in page
 map:
  if this enum is set to METATAGS, we will only index `<author, a>`;
  if this enum is not set, we will merge them and index `<author, [a, b]>`.
 

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig.AdvancedSiteSearchDataSource advanced_site_search_data_sources = 10;

Specified by:

getAdvancedSiteSearchDataSources in interface FieldConfigOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The advancedSiteSearchDataSources at the given index.

setAdvancedSiteSearchDataSources

public FieldConfig.Builder setAdvancedSiteSearchDataSources(int index,
                                                            FieldConfig.AdvancedSiteSearchDataSource value)

 If this field is set, only the corresponding source will be indexed for
 this field. Otherwise, the values from different sources are merged.

 Assuming a page with `<author, a>` in meta tag, and `<author, b>` in page
 map:
  if this enum is set to METATAGS, we will only index `<author, a>`;
  if this enum is not set, we will merge them and index `<author, [a, b]>`.
 

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig.AdvancedSiteSearchDataSource advanced_site_search_data_sources = 10;

Parameters:

index - The index to set the value at.

value - The advancedSiteSearchDataSources to set.

Returns:

This builder for chaining.

addAdvancedSiteSearchDataSources

public FieldConfig.Builder addAdvancedSiteSearchDataSources(FieldConfig.AdvancedSiteSearchDataSource value)

 If this field is set, only the corresponding source will be indexed for
 this field. Otherwise, the values from different sources are merged.

 Assuming a page with `<author, a>` in meta tag, and `<author, b>` in page
 map:
  if this enum is set to METATAGS, we will only index `<author, a>`;
  if this enum is not set, we will merge them and index `<author, [a, b]>`.
 

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig.AdvancedSiteSearchDataSource advanced_site_search_data_sources = 10;

Parameters:

value - The advancedSiteSearchDataSources to add.

Returns:

This builder for chaining.

addAllAdvancedSiteSearchDataSources

public FieldConfig.Builder addAllAdvancedSiteSearchDataSources(Iterable<? extends FieldConfig.AdvancedSiteSearchDataSource> values)

 If this field is set, only the corresponding source will be indexed for
 this field. Otherwise, the values from different sources are merged.

 Assuming a page with `<author, a>` in meta tag, and `<author, b>` in page
 map:
  if this enum is set to METATAGS, we will only index `<author, a>`;
  if this enum is not set, we will merge them and index `<author, [a, b]>`.
 

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig.AdvancedSiteSearchDataSource advanced_site_search_data_sources = 10;

Parameters:

values - The advancedSiteSearchDataSources to add.

Returns:

This builder for chaining.

clearAdvancedSiteSearchDataSources

public FieldConfig.Builder clearAdvancedSiteSearchDataSources()

 If this field is set, only the corresponding source will be indexed for
 this field. Otherwise, the values from different sources are merged.

 Assuming a page with `<author, a>` in meta tag, and `<author, b>` in page
 map:
  if this enum is set to METATAGS, we will only index `<author, a>`;
  if this enum is not set, we will merge them and index `<author, [a, b]>`.
 

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig.AdvancedSiteSearchDataSource advanced_site_search_data_sources = 10;

Returns:

This builder for chaining.

getAdvancedSiteSearchDataSourcesValueList

public List<Integer> getAdvancedSiteSearchDataSourcesValueList()

 If this field is set, only the corresponding source will be indexed for
 this field. Otherwise, the values from different sources are merged.

 Assuming a page with `<author, a>` in meta tag, and `<author, b>` in page
 map:
  if this enum is set to METATAGS, we will only index `<author, a>`;
  if this enum is not set, we will merge them and index `<author, [a, b]>`.
 

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig.AdvancedSiteSearchDataSource advanced_site_search_data_sources = 10;

Specified by:

getAdvancedSiteSearchDataSourcesValueList in interface FieldConfigOrBuilder

Returns:

A list containing the enum numeric values on the wire for advancedSiteSearchDataSources.

getAdvancedSiteSearchDataSourcesValue

public int getAdvancedSiteSearchDataSourcesValue(int index)

 If this field is set, only the corresponding source will be indexed for
 this field. Otherwise, the values from different sources are merged.

 Assuming a page with `<author, a>` in meta tag, and `<author, b>` in page
 map:
  if this enum is set to METATAGS, we will only index `<author, a>`;
  if this enum is not set, we will merge them and index `<author, [a, b]>`.
 

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig.AdvancedSiteSearchDataSource advanced_site_search_data_sources = 10;

Specified by:

getAdvancedSiteSearchDataSourcesValue in interface FieldConfigOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The enum numeric value on the wire of advancedSiteSearchDataSources at the given index.

setAdvancedSiteSearchDataSourcesValue

public FieldConfig.Builder setAdvancedSiteSearchDataSourcesValue(int index,
                                                                 int value)

 If this field is set, only the corresponding source will be indexed for
 this field. Otherwise, the values from different sources are merged.

 Assuming a page with `<author, a>` in meta tag, and `<author, b>` in page
 map:
  if this enum is set to METATAGS, we will only index `<author, a>`;
  if this enum is not set, we will merge them and index `<author, [a, b]>`.
 

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig.AdvancedSiteSearchDataSource advanced_site_search_data_sources = 10;

Parameters:

index - The index to set the value at.

value - The enum numeric value on the wire for advancedSiteSearchDataSources to set.

Returns:

This builder for chaining.

addAdvancedSiteSearchDataSourcesValue

public FieldConfig.Builder addAdvancedSiteSearchDataSourcesValue(int value)

 If this field is set, only the corresponding source will be indexed for
 this field. Otherwise, the values from different sources are merged.

 Assuming a page with `<author, a>` in meta tag, and `<author, b>` in page
 map:
  if this enum is set to METATAGS, we will only index `<author, a>`;
  if this enum is not set, we will merge them and index `<author, [a, b]>`.
 

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig.AdvancedSiteSearchDataSource advanced_site_search_data_sources = 10;

Parameters:

value - The enum numeric value on the wire for advancedSiteSearchDataSources to add.

Returns:

This builder for chaining.

addAllAdvancedSiteSearchDataSourcesValue

public FieldConfig.Builder addAllAdvancedSiteSearchDataSourcesValue(Iterable<Integer> values)

 If this field is set, only the corresponding source will be indexed for
 this field. Otherwise, the values from different sources are merged.

 Assuming a page with `<author, a>` in meta tag, and `<author, b>` in page
 map:
  if this enum is set to METATAGS, we will only index `<author, a>`;
  if this enum is not set, we will merge them and index `<author, [a, b]>`.
 

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig.AdvancedSiteSearchDataSource advanced_site_search_data_sources = 10;

Parameters:

values - The enum numeric values on the wire for advancedSiteSearchDataSources to add.

Returns:

This builder for chaining.

getSchemaOrgPathsList

public com.google.protobuf.ProtocolStringList getSchemaOrgPathsList()

 Field paths for indexing custom attribute from schema.org data. More
 details of schema.org and its defined types can be found at
 [schema.org](https://schema.org).

 It is only used on advanced site search schema.

 Currently only support full path from root. The full path to a field is
 constructed by concatenating field names, starting from `_root`, with
 a period `.` as the delimiter. Examples:

 * Publish date of the root: _root.datePublished
 * Publish date of the reviews: _root.review.datePublished
 

repeated string schema_org_paths = 11;

Specified by:

getSchemaOrgPathsList in interface FieldConfigOrBuilder

Returns:

A list containing the schemaOrgPaths.

getSchemaOrgPathsCount

public int getSchemaOrgPathsCount()

 Field paths for indexing custom attribute from schema.org data. More
 details of schema.org and its defined types can be found at
 [schema.org](https://schema.org).

 It is only used on advanced site search schema.

 Currently only support full path from root. The full path to a field is
 constructed by concatenating field names, starting from `_root`, with
 a period `.` as the delimiter. Examples:

 * Publish date of the root: _root.datePublished
 * Publish date of the reviews: _root.review.datePublished
 

repeated string schema_org_paths = 11;

Specified by:

getSchemaOrgPathsCount in interface FieldConfigOrBuilder

Returns:

The count of schemaOrgPaths.

getSchemaOrgPaths

public String getSchemaOrgPaths(int index)

 Field paths for indexing custom attribute from schema.org data. More
 details of schema.org and its defined types can be found at
 [schema.org](https://schema.org).

 It is only used on advanced site search schema.

 Currently only support full path from root. The full path to a field is
 constructed by concatenating field names, starting from `_root`, with
 a period `.` as the delimiter. Examples:

 * Publish date of the root: _root.datePublished
 * Publish date of the reviews: _root.review.datePublished
 

repeated string schema_org_paths = 11;

Specified by:

getSchemaOrgPaths in interface FieldConfigOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The schemaOrgPaths at the given index.

getSchemaOrgPathsBytes

public com.google.protobuf.ByteString getSchemaOrgPathsBytes(int index)

 Field paths for indexing custom attribute from schema.org data. More
 details of schema.org and its defined types can be found at
 [schema.org](https://schema.org).

 It is only used on advanced site search schema.

 Currently only support full path from root. The full path to a field is
 constructed by concatenating field names, starting from `_root`, with
 a period `.` as the delimiter. Examples:

 * Publish date of the root: _root.datePublished
 * Publish date of the reviews: _root.review.datePublished
 

repeated string schema_org_paths = 11;

Specified by:

getSchemaOrgPathsBytes in interface FieldConfigOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the schemaOrgPaths at the given index.

setSchemaOrgPaths

public FieldConfig.Builder setSchemaOrgPaths(int index,
                                             String value)

 Field paths for indexing custom attribute from schema.org data. More
 details of schema.org and its defined types can be found at
 [schema.org](https://schema.org).

 It is only used on advanced site search schema.

 Currently only support full path from root. The full path to a field is
 constructed by concatenating field names, starting from `_root`, with
 a period `.` as the delimiter. Examples:

 * Publish date of the root: _root.datePublished
 * Publish date of the reviews: _root.review.datePublished
 

repeated string schema_org_paths = 11;

Parameters:

index - The index to set the value at.

value - The schemaOrgPaths to set.

Returns:

This builder for chaining.

addSchemaOrgPaths

public FieldConfig.Builder addSchemaOrgPaths(String value)

 Field paths for indexing custom attribute from schema.org data. More
 details of schema.org and its defined types can be found at
 [schema.org](https://schema.org).

 It is only used on advanced site search schema.

 Currently only support full path from root. The full path to a field is
 constructed by concatenating field names, starting from `_root`, with
 a period `.` as the delimiter. Examples:

 * Publish date of the root: _root.datePublished
 * Publish date of the reviews: _root.review.datePublished
 

repeated string schema_org_paths = 11;

Parameters:

value - The schemaOrgPaths to add.

Returns:

This builder for chaining.

addAllSchemaOrgPaths

public FieldConfig.Builder addAllSchemaOrgPaths(Iterable<String> values)

 Field paths for indexing custom attribute from schema.org data. More
 details of schema.org and its defined types can be found at
 [schema.org](https://schema.org).

 It is only used on advanced site search schema.

 Currently only support full path from root. The full path to a field is
 constructed by concatenating field names, starting from `_root`, with
 a period `.` as the delimiter. Examples:

 * Publish date of the root: _root.datePublished
 * Publish date of the reviews: _root.review.datePublished
 

repeated string schema_org_paths = 11;

Parameters:

values - The schemaOrgPaths to add.

Returns:

This builder for chaining.

clearSchemaOrgPaths

public FieldConfig.Builder clearSchemaOrgPaths()

 Field paths for indexing custom attribute from schema.org data. More
 details of schema.org and its defined types can be found at
 [schema.org](https://schema.org).

 It is only used on advanced site search schema.

 Currently only support full path from root. The full path to a field is
 constructed by concatenating field names, starting from `_root`, with
 a period `.` as the delimiter. Examples:

 * Publish date of the root: _root.datePublished
 * Publish date of the reviews: _root.review.datePublished
 

repeated string schema_org_paths = 11;

Returns:

This builder for chaining.

addSchemaOrgPathsBytes

public FieldConfig.Builder addSchemaOrgPathsBytes(com.google.protobuf.ByteString value)

 Field paths for indexing custom attribute from schema.org data. More
 details of schema.org and its defined types can be found at
 [schema.org](https://schema.org).

 It is only used on advanced site search schema.

 Currently only support full path from root. The full path to a field is
 constructed by concatenating field names, starting from `_root`, with
 a period `.` as the delimiter. Examples:

 * Publish date of the root: _root.datePublished
 * Publish date of the reviews: _root.review.datePublished
 

repeated string schema_org_paths = 11;

Parameters:

value - The bytes of the schemaOrgPaths to add.

Returns:

This builder for chaining.

setUnknownFields

public final FieldConfig.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FieldConfig.Builder>

mergeUnknownFields

public final FieldConfig.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FieldConfig.Builder>