Package com.google.cloud.discoveryengine.v1

Class SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder>
com.google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder
All Implemented Interfaces:
SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
SearchRequest.NaturalLanguageQueryUnderstandingSpec
public static final class SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder extends com.google.protobuf.GeneratedMessage.Builder<SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder> implements SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder
 Specification to enable natural language understanding capabilities for
 search requests.
Protobuf type google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder>

    • clear

      public SearchRequest.NaturalLanguageQueryUnderstandingSpec.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.GeneratedMessage.Builder<SearchRequest.NaturalLanguageQueryUnderstandingSpec.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.GeneratedMessage.Builder<SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder>

    • getDefaultInstanceForType

      public SearchRequest.NaturalLanguageQueryUnderstandingSpec getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public SearchRequest.NaturalLanguageQueryUnderstandingSpec build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public SearchRequest.NaturalLanguageQueryUnderstandingSpec buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public SearchRequest.NaturalLanguageQueryUnderstandingSpec.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<SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder>

    • mergeFrom

      public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder mergeFrom(SearchRequest.NaturalLanguageQueryUnderstandingSpec other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder>

    • mergeFrom

      public SearchRequest.NaturalLanguageQueryUnderstandingSpec.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<SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder>
      Throws:
      IOException

    • getFilterExtractionConditionValue

      public int getFilterExtractionConditionValue()
       The condition under which filter extraction should occur.
 Server behavior defaults to `DISABLED`.
      .google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition filter_extraction_condition = 1;
      Specified by:
      getFilterExtractionConditionValue in interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder
      Returns:
      The enum numeric value on the wire for filterExtractionCondition.

    • setFilterExtractionConditionValue

      public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder setFilterExtractionConditionValue(int value)
       The condition under which filter extraction should occur.
 Server behavior defaults to `DISABLED`.
      .google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition filter_extraction_condition = 1;
      Parameters:
      value - The enum numeric value on the wire for filterExtractionCondition to set.
      Returns:
      This builder for chaining.

    • getFilterExtractionCondition

      public SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition getFilterExtractionCondition()
       The condition under which filter extraction should occur.
 Server behavior defaults to `DISABLED`.
      .google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition filter_extraction_condition = 1;
      Specified by:
      getFilterExtractionCondition in interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder
      Returns:
      The filterExtractionCondition.

    • setFilterExtractionCondition

      public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder setFilterExtractionCondition(SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition value)
       The condition under which filter extraction should occur.
 Server behavior defaults to `DISABLED`.
      .google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition filter_extraction_condition = 1;
      Parameters:
      value - The filterExtractionCondition to set.
      Returns:
      This builder for chaining.

    • clearFilterExtractionCondition

      public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder clearFilterExtractionCondition()
       The condition under which filter extraction should occur.
 Server behavior defaults to `DISABLED`.
      .google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition filter_extraction_condition = 1;
      Returns:
      This builder for chaining.

    • getGeoSearchQueryDetectionFieldNamesList

      public com.google.protobuf.ProtocolStringList getGeoSearchQueryDetectionFieldNamesList()
       Field names used for location-based filtering, where geolocation filters
 are detected in natural language search queries.
 Only valid when the FilterExtractionCondition is set to `ENABLED`.

 If this field is set, it overrides the field names set in
 [ServingConfig.geo_search_query_detection_field_names][google.cloud.discoveryengine.v1.ServingConfig.geo_search_query_detection_field_names].
      repeated string geo_search_query_detection_field_names = 2;
      Specified by:
      getGeoSearchQueryDetectionFieldNamesList in interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder
      Returns:
      A list containing the geoSearchQueryDetectionFieldNames.

    • getGeoSearchQueryDetectionFieldNamesCount

      public int getGeoSearchQueryDetectionFieldNamesCount()
       Field names used for location-based filtering, where geolocation filters
 are detected in natural language search queries.
 Only valid when the FilterExtractionCondition is set to `ENABLED`.

 If this field is set, it overrides the field names set in
 [ServingConfig.geo_search_query_detection_field_names][google.cloud.discoveryengine.v1.ServingConfig.geo_search_query_detection_field_names].
      repeated string geo_search_query_detection_field_names = 2;
      Specified by:
      getGeoSearchQueryDetectionFieldNamesCount in interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder
      Returns:
      The count of geoSearchQueryDetectionFieldNames.

    • getGeoSearchQueryDetectionFieldNames

      public String getGeoSearchQueryDetectionFieldNames(int index)
       Field names used for location-based filtering, where geolocation filters
 are detected in natural language search queries.
 Only valid when the FilterExtractionCondition is set to `ENABLED`.

 If this field is set, it overrides the field names set in
 [ServingConfig.geo_search_query_detection_field_names][google.cloud.discoveryengine.v1.ServingConfig.geo_search_query_detection_field_names].
      repeated string geo_search_query_detection_field_names = 2;
      Specified by:
      getGeoSearchQueryDetectionFieldNames in interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The geoSearchQueryDetectionFieldNames at the given index.

    • getGeoSearchQueryDetectionFieldNamesBytes

      public com.google.protobuf.ByteString getGeoSearchQueryDetectionFieldNamesBytes(int index)
       Field names used for location-based filtering, where geolocation filters
 are detected in natural language search queries.
 Only valid when the FilterExtractionCondition is set to `ENABLED`.

 If this field is set, it overrides the field names set in
 [ServingConfig.geo_search_query_detection_field_names][google.cloud.discoveryengine.v1.ServingConfig.geo_search_query_detection_field_names].
      repeated string geo_search_query_detection_field_names = 2;
      Specified by:
      getGeoSearchQueryDetectionFieldNamesBytes in interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the geoSearchQueryDetectionFieldNames at the given index.

    • setGeoSearchQueryDetectionFieldNames

      public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder setGeoSearchQueryDetectionFieldNames(int index, String value)
       Field names used for location-based filtering, where geolocation filters
 are detected in natural language search queries.
 Only valid when the FilterExtractionCondition is set to `ENABLED`.

 If this field is set, it overrides the field names set in
 [ServingConfig.geo_search_query_detection_field_names][google.cloud.discoveryengine.v1.ServingConfig.geo_search_query_detection_field_names].
      repeated string geo_search_query_detection_field_names = 2;
      Parameters:
      index - The index to set the value at.
      value - The geoSearchQueryDetectionFieldNames to set.
      Returns:
      This builder for chaining.

    • addGeoSearchQueryDetectionFieldNames

      public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder addGeoSearchQueryDetectionFieldNames(String value)
       Field names used for location-based filtering, where geolocation filters
 are detected in natural language search queries.
 Only valid when the FilterExtractionCondition is set to `ENABLED`.

 If this field is set, it overrides the field names set in
 [ServingConfig.geo_search_query_detection_field_names][google.cloud.discoveryengine.v1.ServingConfig.geo_search_query_detection_field_names].
      repeated string geo_search_query_detection_field_names = 2;
      Parameters:
      value - The geoSearchQueryDetectionFieldNames to add.
      Returns:
      This builder for chaining.

    • addAllGeoSearchQueryDetectionFieldNames

      public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder addAllGeoSearchQueryDetectionFieldNames(Iterable<String> values)
       Field names used for location-based filtering, where geolocation filters
 are detected in natural language search queries.
 Only valid when the FilterExtractionCondition is set to `ENABLED`.

 If this field is set, it overrides the field names set in
 [ServingConfig.geo_search_query_detection_field_names][google.cloud.discoveryengine.v1.ServingConfig.geo_search_query_detection_field_names].
      repeated string geo_search_query_detection_field_names = 2;
      Parameters:
      values - The geoSearchQueryDetectionFieldNames to add.
      Returns:
      This builder for chaining.

    • clearGeoSearchQueryDetectionFieldNames

      public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder clearGeoSearchQueryDetectionFieldNames()
       Field names used for location-based filtering, where geolocation filters
 are detected in natural language search queries.
 Only valid when the FilterExtractionCondition is set to `ENABLED`.

 If this field is set, it overrides the field names set in
 [ServingConfig.geo_search_query_detection_field_names][google.cloud.discoveryengine.v1.ServingConfig.geo_search_query_detection_field_names].
      repeated string geo_search_query_detection_field_names = 2;
      Returns:
      This builder for chaining.

    • addGeoSearchQueryDetectionFieldNamesBytes

      public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder addGeoSearchQueryDetectionFieldNamesBytes(com.google.protobuf.ByteString value)
       Field names used for location-based filtering, where geolocation filters
 are detected in natural language search queries.
 Only valid when the FilterExtractionCondition is set to `ENABLED`.

 If this field is set, it overrides the field names set in
 [ServingConfig.geo_search_query_detection_field_names][google.cloud.discoveryengine.v1.ServingConfig.geo_search_query_detection_field_names].
      repeated string geo_search_query_detection_field_names = 2;
      Parameters:
      value - The bytes of the geoSearchQueryDetectionFieldNames to add.
      Returns:
      This builder for chaining.

    • getExtractedFilterBehaviorValue

      public int getExtractedFilterBehaviorValue()
       Optional. Controls behavior of how extracted filters are applied to the
 search. The default behavior depends on the request. For single datastore
 structured search, the default is `HARD_FILTER`. For multi-datastore
 search, the default behavior is `SOFT_BOOST`.
 Location-based filters are always applied as hard filters, and the
 `SOFT_BOOST` setting will not affect them.
 This field is only used if
 [SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition][google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition]
 is set to
 [FilterExtractionCondition.ENABLED][google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition.ENABLED].
      .google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior extracted_filter_behavior = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExtractedFilterBehaviorValue in interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder
      Returns:
      The enum numeric value on the wire for extractedFilterBehavior.

    • setExtractedFilterBehaviorValue

      public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder setExtractedFilterBehaviorValue(int value)
       Optional. Controls behavior of how extracted filters are applied to the
 search. The default behavior depends on the request. For single datastore
 structured search, the default is `HARD_FILTER`. For multi-datastore
 search, the default behavior is `SOFT_BOOST`.
 Location-based filters are always applied as hard filters, and the
 `SOFT_BOOST` setting will not affect them.
 This field is only used if
 [SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition][google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition]
 is set to
 [FilterExtractionCondition.ENABLED][google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition.ENABLED].
      .google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior extracted_filter_behavior = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The enum numeric value on the wire for extractedFilterBehavior to set.
      Returns:
      This builder for chaining.

    • getExtractedFilterBehavior

      public SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior getExtractedFilterBehavior()
       Optional. Controls behavior of how extracted filters are applied to the
 search. The default behavior depends on the request. For single datastore
 structured search, the default is `HARD_FILTER`. For multi-datastore
 search, the default behavior is `SOFT_BOOST`.
 Location-based filters are always applied as hard filters, and the
 `SOFT_BOOST` setting will not affect them.
 This field is only used if
 [SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition][google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition]
 is set to
 [FilterExtractionCondition.ENABLED][google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition.ENABLED].
      .google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior extracted_filter_behavior = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExtractedFilterBehavior in interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder
      Returns:
      The extractedFilterBehavior.

    • setExtractedFilterBehavior

      public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder setExtractedFilterBehavior(SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior value)
       Optional. Controls behavior of how extracted filters are applied to the
 search. The default behavior depends on the request. For single datastore
 structured search, the default is `HARD_FILTER`. For multi-datastore
 search, the default behavior is `SOFT_BOOST`.
 Location-based filters are always applied as hard filters, and the
 `SOFT_BOOST` setting will not affect them.
 This field is only used if
 [SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition][google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition]
 is set to
 [FilterExtractionCondition.ENABLED][google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition.ENABLED].
      .google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior extracted_filter_behavior = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The extractedFilterBehavior to set.
      Returns:
      This builder for chaining.

    • clearExtractedFilterBehavior

      public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder clearExtractedFilterBehavior()
       Optional. Controls behavior of how extracted filters are applied to the
 search. The default behavior depends on the request. For single datastore
 structured search, the default is `HARD_FILTER`. For multi-datastore
 search, the default behavior is `SOFT_BOOST`.
 Location-based filters are always applied as hard filters, and the
 `SOFT_BOOST` setting will not affect them.
 This field is only used if
 [SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition][google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition]
 is set to
 [FilterExtractionCondition.ENABLED][google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.FilterExtractionCondition.ENABLED].
      .google.cloud.discoveryengine.v1.SearchRequest.NaturalLanguageQueryUnderstandingSpec.ExtractedFilterBehavior extracted_filter_behavior = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • getAllowedFieldNamesList

      public com.google.protobuf.ProtocolStringList getAllowedFieldNamesList()
       Optional. Allowlist of fields that can be used for natural language
 filter extraction. By default, if this is unspecified, all indexable
 fields are eligible for natural language filter extraction (but are not
 guaranteed to be used). If any fields are specified in
 allowed_field_names, only the fields that are both marked as indexable in
 the schema and specified in the allowlist will be eligible for natural
 language filter extraction. Note: for multi-datastore search, this is not
 yet supported, and will be ignored.
      repeated string allowed_field_names = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAllowedFieldNamesList in interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder
      Returns:
      A list containing the allowedFieldNames.

    • getAllowedFieldNamesCount

      public int getAllowedFieldNamesCount()
       Optional. Allowlist of fields that can be used for natural language
 filter extraction. By default, if this is unspecified, all indexable
 fields are eligible for natural language filter extraction (but are not
 guaranteed to be used). If any fields are specified in
 allowed_field_names, only the fields that are both marked as indexable in
 the schema and specified in the allowlist will be eligible for natural
 language filter extraction. Note: for multi-datastore search, this is not
 yet supported, and will be ignored.
      repeated string allowed_field_names = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAllowedFieldNamesCount in interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder
      Returns:
      The count of allowedFieldNames.

    • getAllowedFieldNames

      public String getAllowedFieldNames(int index)
       Optional. Allowlist of fields that can be used for natural language
 filter extraction. By default, if this is unspecified, all indexable
 fields are eligible for natural language filter extraction (but are not
 guaranteed to be used). If any fields are specified in
 allowed_field_names, only the fields that are both marked as indexable in
 the schema and specified in the allowlist will be eligible for natural
 language filter extraction. Note: for multi-datastore search, this is not
 yet supported, and will be ignored.
      repeated string allowed_field_names = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAllowedFieldNames in interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The allowedFieldNames at the given index.

    • getAllowedFieldNamesBytes

      public com.google.protobuf.ByteString getAllowedFieldNamesBytes(int index)
       Optional. Allowlist of fields that can be used for natural language
 filter extraction. By default, if this is unspecified, all indexable
 fields are eligible for natural language filter extraction (but are not
 guaranteed to be used). If any fields are specified in
 allowed_field_names, only the fields that are both marked as indexable in
 the schema and specified in the allowlist will be eligible for natural
 language filter extraction. Note: for multi-datastore search, this is not
 yet supported, and will be ignored.
      repeated string allowed_field_names = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAllowedFieldNamesBytes in interface SearchRequest.NaturalLanguageQueryUnderstandingSpecOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the allowedFieldNames at the given index.

    • setAllowedFieldNames

      public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder setAllowedFieldNames(int index, String value)
       Optional. Allowlist of fields that can be used for natural language
 filter extraction. By default, if this is unspecified, all indexable
 fields are eligible for natural language filter extraction (but are not
 guaranteed to be used). If any fields are specified in
 allowed_field_names, only the fields that are both marked as indexable in
 the schema and specified in the allowlist will be eligible for natural
 language filter extraction. Note: for multi-datastore search, this is not
 yet supported, and will be ignored.
      repeated string allowed_field_names = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index to set the value at.
      value - The allowedFieldNames to set.
      Returns:
      This builder for chaining.

    • addAllowedFieldNames

      public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder addAllowedFieldNames(String value)
       Optional. Allowlist of fields that can be used for natural language
 filter extraction. By default, if this is unspecified, all indexable
 fields are eligible for natural language filter extraction (but are not
 guaranteed to be used). If any fields are specified in
 allowed_field_names, only the fields that are both marked as indexable in
 the schema and specified in the allowlist will be eligible for natural
 language filter extraction. Note: for multi-datastore search, this is not
 yet supported, and will be ignored.
      repeated string allowed_field_names = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The allowedFieldNames to add.
      Returns:
      This builder for chaining.

    • addAllAllowedFieldNames

      public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder addAllAllowedFieldNames(Iterable<String> values)
       Optional. Allowlist of fields that can be used for natural language
 filter extraction. By default, if this is unspecified, all indexable
 fields are eligible for natural language filter extraction (but are not
 guaranteed to be used). If any fields are specified in
 allowed_field_names, only the fields that are both marked as indexable in
 the schema and specified in the allowlist will be eligible for natural
 language filter extraction. Note: for multi-datastore search, this is not
 yet supported, and will be ignored.
      repeated string allowed_field_names = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      values - The allowedFieldNames to add.
      Returns:
      This builder for chaining.

    • clearAllowedFieldNames

      public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder clearAllowedFieldNames()
       Optional. Allowlist of fields that can be used for natural language
 filter extraction. By default, if this is unspecified, all indexable
 fields are eligible for natural language filter extraction (but are not
 guaranteed to be used). If any fields are specified in
 allowed_field_names, only the fields that are both marked as indexable in
 the schema and specified in the allowlist will be eligible for natural
 language filter extraction. Note: for multi-datastore search, this is not
 yet supported, and will be ignored.
      repeated string allowed_field_names = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • addAllowedFieldNamesBytes

      public SearchRequest.NaturalLanguageQueryUnderstandingSpec.Builder addAllowedFieldNamesBytes(com.google.protobuf.ByteString value)
       Optional. Allowlist of fields that can be used for natural language
 filter extraction. By default, if this is unspecified, all indexable
 fields are eligible for natural language filter extraction (but are not
 guaranteed to be used). If any fields are specified in
 allowed_field_names, only the fields that are both marked as indexable in
 the schema and specified in the allowlist will be eligible for natural
 language filter extraction. Note: for multi-datastore search, this is not
 yet supported, and will be ignored.
      repeated string allowed_field_names = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes of the allowedFieldNames to add.
      Returns:
      This builder for chaining.