Package com.google.cloud.discoveryengine.v1beta

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.v1beta.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.v1beta.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.
 Default to [Condition.DISABLED][].
      .google.cloud.discoveryengine.v1beta.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.
 Default to [Condition.DISABLED][].
      .google.cloud.discoveryengine.v1beta.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.
 Default to [Condition.DISABLED][].
      .google.cloud.discoveryengine.v1beta.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.
 Default to [Condition.DISABLED][].
      .google.cloud.discoveryengine.v1beta.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.
 Default to [Condition.DISABLED][].
      .google.cloud.discoveryengine.v1beta.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.v1beta.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.v1beta.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.v1beta.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.v1beta.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.v1beta.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.v1beta.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.v1beta.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.v1beta.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.v1beta.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.