com.google.api.services.discoveryengine.v1.model

Class GoogleCloudDiscoveryengineV1alphaFieldConfig

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.discoveryengine.v1.model.GoogleCloudDiscoveryengineV1alphaFieldConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleCloudDiscoveryengineV1alphaFieldConfig
extends com.google.api.client.json.GenericJson

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

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Discovery Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GoogleCloudDiscoveryengineV1alphaFieldConfig()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1alphaFieldConfig	clone()
List<String>	getAdvancedSiteSearchDataSources() If this field is set, only the corresponding source will be indexed for this field.
String	getCompletableOption() If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery.
String	getDynamicFacetableOption() If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet.
String	getFieldPath() Required.
String	getFieldType() Output only.
String	getIndexableOption() If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search.
String	getKeyPropertyType() Output only.
String	getMetatagName() Optional.
String	getRecsFilterableOption() If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend.
String	getRetrievableOption() If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results.
List<String>	getSchemaOrgPaths() Field paths for indexing custom attribute from schema.org data.
String	getSearchableFieldImportance() Optional.
String	getSearchableOption() If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search.
GoogleCloudDiscoveryengineV1alphaFieldConfig	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1alphaFieldConfig	setAdvancedSiteSearchDataSources(List<String> advancedSiteSearchDataSources) If this field is set, only the corresponding source will be indexed for this field.
GoogleCloudDiscoveryengineV1alphaFieldConfig	setCompletableOption(String completableOption) If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery.
GoogleCloudDiscoveryengineV1alphaFieldConfig	setDynamicFacetableOption(String dynamicFacetableOption) If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet.
GoogleCloudDiscoveryengineV1alphaFieldConfig	setFieldPath(String fieldPath) Required.
GoogleCloudDiscoveryengineV1alphaFieldConfig	setFieldType(String fieldType) Output only.
GoogleCloudDiscoveryengineV1alphaFieldConfig	setIndexableOption(String indexableOption) If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search.
GoogleCloudDiscoveryengineV1alphaFieldConfig	setKeyPropertyType(String keyPropertyType) Output only.
GoogleCloudDiscoveryengineV1alphaFieldConfig	setMetatagName(String metatagName) Optional.
GoogleCloudDiscoveryengineV1alphaFieldConfig	setRecsFilterableOption(String recsFilterableOption) If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend.
GoogleCloudDiscoveryengineV1alphaFieldConfig	setRetrievableOption(String retrievableOption) If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results.
GoogleCloudDiscoveryengineV1alphaFieldConfig	setSchemaOrgPaths(List<String> schemaOrgPaths) Field paths for indexing custom attribute from schema.org data.
GoogleCloudDiscoveryengineV1alphaFieldConfig	setSearchableFieldImportance(String searchableFieldImportance) Optional.
GoogleCloudDiscoveryengineV1alphaFieldConfig	setSearchableOption(String searchableOption) If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GoogleCloudDiscoveryengineV1alphaFieldConfig

public GoogleCloudDiscoveryengineV1alphaFieldConfig()

Method Detail

getAdvancedSiteSearchDataSources

public List<String> getAdvancedSiteSearchDataSources()

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 `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``.

Returns:

value or null for none

setAdvancedSiteSearchDataSources

public GoogleCloudDiscoveryengineV1alphaFieldConfig setAdvancedSiteSearchDataSources(List<String> advancedSiteSearchDataSources)

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 `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``.

Parameters:

advancedSiteSearchDataSources - advancedSiteSearchDataSources or null for none

getCompletableOption

public String getCompletableOption()

If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to 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 for those fields will throw `INVALID_ARGUMENT` error.

Returns:

value or null for none

setCompletableOption

public GoogleCloudDiscoveryengineV1alphaFieldConfig setCompletableOption(String completableOption)

If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to 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 for those fields will throw `INVALID_ARGUMENT` error.

Parameters:

completableOption - completableOption or null for none

getDynamicFacetableOption

public String getDynamicFacetableOption()

If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to 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 for those fields will throw `INVALID_ARGUMENT` error.

Returns:

value or null for none

setDynamicFacetableOption

public GoogleCloudDiscoveryengineV1alphaFieldConfig setDynamicFacetableOption(String dynamicFacetableOption)

If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to 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 for those fields will throw `INVALID_ARGUMENT` error.

Parameters:

dynamicFacetableOption - dynamicFacetableOption or null for none

getFieldPath

public String getFieldPath()

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

Returns:

value or null for none

setFieldPath

public GoogleCloudDiscoveryengineV1alphaFieldConfig setFieldPath(String fieldPath)

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

Parameters:

fieldPath - fieldPath or null for none

getFieldType

public String getFieldType()

Output only. Raw type of the field.

Returns:

value or null for none

setFieldType

public GoogleCloudDiscoveryengineV1alphaFieldConfig setFieldType(String fieldType)

Output only. Raw type of the field.

Parameters:

fieldType - fieldType or null for none

getIndexableOption

public String getIndexableOption()

If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to 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 setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error.

Returns:

value or null for none

setIndexableOption

public GoogleCloudDiscoveryengineV1alphaFieldConfig setIndexableOption(String indexableOption)

If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to 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 setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error.

Parameters:

indexableOption - indexableOption or null for none

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.

Returns:

value or null for none

setKeyPropertyType

public GoogleCloudDiscoveryengineV1alphaFieldConfig setKeyPropertyType(String keyPropertyType)

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.

Parameters:

keyPropertyType - keyPropertyType or null for none

getMetatagName

public String getMetatagName()

Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag.

Returns:

value or null for none

setMetatagName

public GoogleCloudDiscoveryengineV1alphaFieldConfig setMetatagName(String metatagName)

Optional. The metatag name found in the HTML page. If user defines this field, the value of this metatag name will be used to extract metatag. If the user does not define this field, the FieldConfig.field_path will be used to extract metatag.

Parameters:

metatagName - metatagName or null for none

getRecsFilterableOption

public String getRecsFilterableOption()

If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is 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.

Returns:

value or null for none

setRecsFilterableOption

public GoogleCloudDiscoveryengineV1alphaFieldConfig setRecsFilterableOption(String recsFilterableOption)

If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is 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.

Parameters:

recsFilterableOption - recsFilterableOption or null for none

getRetrievableOption

public String getRetrievableOption()

If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to 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 for those fields will throw `INVALID_ARGUMENT` error.

Returns:

value or null for none

setRetrievableOption

public GoogleCloudDiscoveryengineV1alphaFieldConfig setRetrievableOption(String retrievableOption)

If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to 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 for those fields will throw `INVALID_ARGUMENT` error.

Parameters:

retrievableOption - retrievableOption or null for none

getSchemaOrgPaths

public List<String> getSchemaOrgPaths()

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

Returns:

value or null for none

setSchemaOrgPaths

public GoogleCloudDiscoveryengineV1alphaFieldConfig setSchemaOrgPaths(List<String> schemaOrgPaths)

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

Parameters:

schemaOrgPaths - schemaOrgPaths or null for none

getSearchableFieldImportance

public String getSearchableFieldImportance()

Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.

Returns:

value or null for none

setSearchableFieldImportance

public GoogleCloudDiscoveryengineV1alphaFieldConfig setSearchableFieldImportance(String searchableFieldImportance)

Optional. Specifies the importance of the field when `searchable_option` is `SEARCHABLE_ENABLED`. If `searchable_option` is `SEARCHABLE_DISABLED`, this field is ignored. If `searchable_option` is `SEARCHABLE_ENABLED` and this is `SEARCHABLE_FIELD_IMPORTANCE_UNSPECIFIED`, it behaves as `DEFAULT_IMPORTANCE`.

Parameters:

searchableFieldImportance - searchableFieldImportance or null for none

getSearchableOption

public String getSearchableOption()

If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.

Returns:

value or null for none

setSearchableOption

public GoogleCloudDiscoveryengineV1alphaFieldConfig setSearchableOption(String searchableOption)

If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.

Parameters:

searchableOption - searchableOption or null for none

set

public GoogleCloudDiscoveryengineV1alphaFieldConfig set(String fieldName,
                                                        Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public GoogleCloudDiscoveryengineV1alphaFieldConfig clone()

Overrides:

clone in class com.google.api.client.json.GenericJson