- 0.49.0 (latest)
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public interface FieldConfigOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAdvancedSiteSearchDataSources(int index)
public abstract 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;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
FieldConfig.AdvancedSiteSearchDataSource |
The advancedSiteSearchDataSources at the given index. |
getAdvancedSiteSearchDataSourcesCount()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
int |
The count of advancedSiteSearchDataSources. |
getAdvancedSiteSearchDataSourcesList()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
List<AdvancedSiteSearchDataSource> |
A list containing the advancedSiteSearchDataSources. |
getAdvancedSiteSearchDataSourcesValue(int index)
public abstract 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;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire of advancedSiteSearchDataSources at the given index. |
getAdvancedSiteSearchDataSourcesValueList()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
List<Integer> |
A list containing the enum numeric values on the wire for advancedSiteSearchDataSources. |
getCompletableOption()
public abstract FieldConfig.CompletableOption 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.
.google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption completable_option = 8;
| Returns | |
|---|---|
| Type | Description |
FieldConfig.CompletableOption |
The completableOption. |
getCompletableOptionValue()
public abstract int getCompletableOptionValue()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.
.google.cloud.discoveryengine.v1alpha.FieldConfig.CompletableOption completable_option = 8;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for completableOption. |
getDynamicFacetableOption()
public abstract FieldConfig.DynamicFacetableOption 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.
.google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption dynamic_facetable_option = 4;
| Returns | |
|---|---|
| Type | Description |
FieldConfig.DynamicFacetableOption |
The dynamicFacetableOption. |
getDynamicFacetableOptionValue()
public abstract int getDynamicFacetableOptionValue() 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.
.google.cloud.discoveryengine.v1alpha.FieldConfig.DynamicFacetableOption dynamic_facetable_option = 4;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for dynamicFacetableOption. |
getFieldPath()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
String |
The fieldPath. |
getFieldPathBytes()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for fieldPath. |
getFieldType()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
FieldConfig.FieldType |
The fieldType. |
getFieldTypeValue()
public abstract int getFieldTypeValue()Output only. Raw type of the field.
.google.cloud.discoveryengine.v1alpha.FieldConfig.FieldType field_type = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for fieldType. |
getIndexableOption()
public abstract FieldConfig.IndexableOption 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.
.google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption indexable_option = 3;
| Returns | |
|---|---|
| Type | Description |
FieldConfig.IndexableOption |
The indexableOption. |
getIndexableOptionValue()
public abstract int getIndexableOptionValue()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.
.google.cloud.discoveryengine.v1alpha.FieldConfig.IndexableOption indexable_option = 3;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for indexableOption. |
getKeyPropertyType()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
String |
The keyPropertyType. |
getKeyPropertyTypeBytes()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for keyPropertyType. |
getRecsFilterableOption()
public abstract FieldConfig.FilterableOption 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.
.google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption recs_filterable_option = 9;
| Returns | |
|---|---|
| Type | Description |
FieldConfig.FilterableOption |
The recsFilterableOption. |
getRecsFilterableOptionValue()
public abstract int getRecsFilterableOptionValue()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.
.google.cloud.discoveryengine.v1alpha.FieldConfig.FilterableOption recs_filterable_option = 9;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for recsFilterableOption. |
getRetrievableOption()
public abstract FieldConfig.RetrievableOption 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.
.google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption retrievable_option = 6;
| Returns | |
|---|---|
| Type | Description |
FieldConfig.RetrievableOption |
The retrievableOption. |
getRetrievableOptionValue()
public abstract int getRetrievableOptionValue()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.
.google.cloud.discoveryengine.v1alpha.FieldConfig.RetrievableOption retrievable_option = 6;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for retrievableOption. |
getSchemaOrgPaths(int index)
public abstract 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.
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;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The schemaOrgPaths at the given index. |
getSchemaOrgPathsBytes(int index)
public abstract 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.
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;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the schemaOrgPaths at the given index. |
getSchemaOrgPathsCount()
public abstract 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.
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 | |
|---|---|
| Type | Description |
int |
The count of schemaOrgPaths. |
getSchemaOrgPathsList()
public abstract List<String> 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.
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 | |
|---|---|
| Type | Description |
List<String> |
A list containing the schemaOrgPaths. |
getSearchableOption()
public abstract FieldConfig.SearchableOption 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.
.google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption searchable_option = 5;
| Returns | |
|---|---|
| Type | Description |
FieldConfig.SearchableOption |
The searchableOption. |
getSearchableOptionValue()
public abstract int getSearchableOptionValue()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.
.google.cloud.discoveryengine.v1alpha.FieldConfig.SearchableOption searchable_option = 5;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for searchableOption. |