Package com.google.cloud.discoveryengine.v1alpha

Interface FieldConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
FieldConfig, FieldConfig.Builder
@Generated public interface FieldConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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.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.
    List<String>
    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].

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getFieldPath

      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:
      The fieldPath.

    • getFieldPathBytes

      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];
      Returns:
      The bytes for fieldPath.

    • getFieldTypeValue

      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:
      The enum numeric value on the wire for fieldType.

    • getFieldType

      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:
      The fieldType.

    • getIndexableOptionValue

      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;
      Returns:
      The enum numeric value on the wire for indexableOption.

    • getIndexableOption

      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;
      Returns:
      The indexableOption.

    • getDynamicFacetableOptionValue

      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;
      Returns:
      The enum numeric value on the wire for dynamicFacetableOption.

    • getDynamicFacetableOption

      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;
      Returns:
      The dynamicFacetableOption.

    • getSearchableOptionValue

      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;
      Returns:
      The enum numeric value on the wire for searchableOption.

    • getSearchableOption

      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;
      Returns:
      The searchableOption.

    • getRetrievableOptionValue

      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;
      Returns:
      The enum numeric value on the wire for retrievableOption.

    • getRetrievableOption

      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;
      Returns:
      The retrievableOption.

    • getCompletableOptionValue

      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;
      Returns:
      The enum numeric value on the wire for completableOption.

    • getCompletableOption

      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;
      Returns:
      The completableOption.

    • getRecsFilterableOptionValue

      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;
      Returns:
      The enum numeric value on the wire for recsFilterableOption.

    • getRecsFilterableOption

      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;
      Returns:
      The recsFilterableOption.

    • getKeyPropertyType

      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:
      The keyPropertyType.

    • getKeyPropertyTypeBytes

      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];
      Returns:
      The bytes for keyPropertyType.

    • getAdvancedSiteSearchDataSourcesList

      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:
      A list containing the advancedSiteSearchDataSources.

    • getAdvancedSiteSearchDataSourcesCount

      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:
      The count of advancedSiteSearchDataSources.

    • getAdvancedSiteSearchDataSources

      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;
      Parameters:
      index - The index of the element to return.
      Returns:
      The advancedSiteSearchDataSources at the given index.

    • getAdvancedSiteSearchDataSourcesValueList

      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:
      A list containing the enum numeric values on the wire for advancedSiteSearchDataSources.

    • getAdvancedSiteSearchDataSourcesValue

      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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The enum numeric value on the wire of advancedSiteSearchDataSources at the given index.

    • getSchemaOrgPathsList

      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](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:
      A list containing the schemaOrgPaths.

    • getSchemaOrgPathsCount

      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;
      Returns:
      The count of schemaOrgPaths.

    • getSchemaOrgPaths

      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;
      Parameters:
      index - The index of the element to return.
      Returns:
      The schemaOrgPaths at the given index.

    • getSchemaOrgPathsBytes

      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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the schemaOrgPaths at the given index.