Class SearchRequest.Builder

  • All Implemented Interfaces:
    SearchRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    SearchRequest

    public static final class SearchRequest.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>
    implements SearchRequestOrBuilder
     Request message for
     [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
     method.
     
    Protobuf type google.cloud.discoveryengine.v1.SearchRequest
    • Method Detail

      • getDescriptor

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

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>
      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>
      • clear

        public SearchRequest.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.GeneratedMessageV3.Builder<SearchRequest.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.GeneratedMessageV3.Builder<SearchRequest.Builder>
      • getDefaultInstanceForType

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

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

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

        public SearchRequest.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>
      • setField

        public SearchRequest.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>
      • clearField

        public SearchRequest.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>
      • clearOneof

        public SearchRequest.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>
      • setRepeatedField

        public SearchRequest.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      int index,
                                                      Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>
      • addRepeatedField

        public SearchRequest.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>
      • mergeFrom

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

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

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

        public String getServingConfig()
         Required. The resource name of the Search serving config, such as
         `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
         This field is used to identify the serving configuration name, set
         of models used to make the search.
         
        string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getServingConfig in interface SearchRequestOrBuilder
        Returns:
        The servingConfig.
      • getServingConfigBytes

        public com.google.protobuf.ByteString getServingConfigBytes()
         Required. The resource name of the Search serving config, such as
         `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
         This field is used to identify the serving configuration name, set
         of models used to make the search.
         
        string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getServingConfigBytes in interface SearchRequestOrBuilder
        Returns:
        The bytes for servingConfig.
      • setServingConfig

        public SearchRequest.Builder setServingConfig​(String value)
         Required. The resource name of the Search serving config, such as
         `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
         This field is used to identify the serving configuration name, set
         of models used to make the search.
         
        string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The servingConfig to set.
        Returns:
        This builder for chaining.
      • clearServingConfig

        public SearchRequest.Builder clearServingConfig()
         Required. The resource name of the Search serving config, such as
         `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
         This field is used to identify the serving configuration name, set
         of models used to make the search.
         
        string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.
      • setServingConfigBytes

        public SearchRequest.Builder setServingConfigBytes​(com.google.protobuf.ByteString value)
         Required. The resource name of the Search serving config, such as
         `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
         This field is used to identify the serving configuration name, set
         of models used to make the search.
         
        string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for servingConfig to set.
        Returns:
        This builder for chaining.
      • getBranch

        public String getBranch()
         The branch resource name, such as
         `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
        
         Use `default_branch` as the branch ID or leave this field empty, to search
         documents under the default branch.
         
        string branch = 2 [(.google.api.resource_reference) = { ... }
        Specified by:
        getBranch in interface SearchRequestOrBuilder
        Returns:
        The branch.
      • getBranchBytes

        public com.google.protobuf.ByteString getBranchBytes()
         The branch resource name, such as
         `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
        
         Use `default_branch` as the branch ID or leave this field empty, to search
         documents under the default branch.
         
        string branch = 2 [(.google.api.resource_reference) = { ... }
        Specified by:
        getBranchBytes in interface SearchRequestOrBuilder
        Returns:
        The bytes for branch.
      • setBranch

        public SearchRequest.Builder setBranch​(String value)
         The branch resource name, such as
         `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
        
         Use `default_branch` as the branch ID or leave this field empty, to search
         documents under the default branch.
         
        string branch = 2 [(.google.api.resource_reference) = { ... }
        Parameters:
        value - The branch to set.
        Returns:
        This builder for chaining.
      • clearBranch

        public SearchRequest.Builder clearBranch()
         The branch resource name, such as
         `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
        
         Use `default_branch` as the branch ID or leave this field empty, to search
         documents under the default branch.
         
        string branch = 2 [(.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.
      • setBranchBytes

        public SearchRequest.Builder setBranchBytes​(com.google.protobuf.ByteString value)
         The branch resource name, such as
         `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`.
        
         Use `default_branch` as the branch ID or leave this field empty, to search
         documents under the default branch.
         
        string branch = 2 [(.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for branch to set.
        Returns:
        This builder for chaining.
      • getQueryBytes

        public com.google.protobuf.ByteString getQueryBytes()
         Raw search query.
         
        string query = 3;
        Specified by:
        getQueryBytes in interface SearchRequestOrBuilder
        Returns:
        The bytes for query.
      • setQuery

        public SearchRequest.Builder setQuery​(String value)
         Raw search query.
         
        string query = 3;
        Parameters:
        value - The query to set.
        Returns:
        This builder for chaining.
      • clearQuery

        public SearchRequest.Builder clearQuery()
         Raw search query.
         
        string query = 3;
        Returns:
        This builder for chaining.
      • setQueryBytes

        public SearchRequest.Builder setQueryBytes​(com.google.protobuf.ByteString value)
         Raw search query.
         
        string query = 3;
        Parameters:
        value - The bytes for query to set.
        Returns:
        This builder for chaining.
      • hasImageQuery

        public boolean hasImageQuery()
         Raw image query.
         
        .google.cloud.discoveryengine.v1.SearchRequest.ImageQuery image_query = 19;
        Specified by:
        hasImageQuery in interface SearchRequestOrBuilder
        Returns:
        Whether the imageQuery field is set.
      • clearImageQuery

        public SearchRequest.Builder clearImageQuery()
         Raw image query.
         
        .google.cloud.discoveryengine.v1.SearchRequest.ImageQuery image_query = 19;
      • getImageQueryBuilder

        public SearchRequest.ImageQuery.Builder getImageQueryBuilder()
         Raw image query.
         
        .google.cloud.discoveryengine.v1.SearchRequest.ImageQuery image_query = 19;
      • getPageSize

        public int getPageSize()
         Maximum number of [Document][google.cloud.discoveryengine.v1.Document]s to
         return. If unspecified, defaults to a reasonable value. The maximum allowed
         value is 100. Values above 100 are coerced to 100.
        
         If this field is negative, an  `INVALID_ARGUMENT`  is returned.
         
        int32 page_size = 4;
        Specified by:
        getPageSize in interface SearchRequestOrBuilder
        Returns:
        The pageSize.
      • setPageSize

        public SearchRequest.Builder setPageSize​(int value)
         Maximum number of [Document][google.cloud.discoveryengine.v1.Document]s to
         return. If unspecified, defaults to a reasonable value. The maximum allowed
         value is 100. Values above 100 are coerced to 100.
        
         If this field is negative, an  `INVALID_ARGUMENT`  is returned.
         
        int32 page_size = 4;
        Parameters:
        value - The pageSize to set.
        Returns:
        This builder for chaining.
      • clearPageSize

        public SearchRequest.Builder clearPageSize()
         Maximum number of [Document][google.cloud.discoveryengine.v1.Document]s to
         return. If unspecified, defaults to a reasonable value. The maximum allowed
         value is 100. Values above 100 are coerced to 100.
        
         If this field is negative, an  `INVALID_ARGUMENT`  is returned.
         
        int32 page_size = 4;
        Returns:
        This builder for chaining.
      • getPageToken

        public String getPageToken()
         A page token received from a previous
         [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
         call. Provide this to retrieve the subsequent page.
        
         When paginating, all other parameters provided to
         [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
         must match the call that provided the page token. Otherwise, an
          `INVALID_ARGUMENT`  error is returned.
         
        string page_token = 5;
        Specified by:
        getPageToken in interface SearchRequestOrBuilder
        Returns:
        The pageToken.
      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         A page token received from a previous
         [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
         call. Provide this to retrieve the subsequent page.
        
         When paginating, all other parameters provided to
         [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
         must match the call that provided the page token. Otherwise, an
          `INVALID_ARGUMENT`  error is returned.
         
        string page_token = 5;
        Specified by:
        getPageTokenBytes in interface SearchRequestOrBuilder
        Returns:
        The bytes for pageToken.
      • setPageToken

        public SearchRequest.Builder setPageToken​(String value)
         A page token received from a previous
         [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
         call. Provide this to retrieve the subsequent page.
        
         When paginating, all other parameters provided to
         [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
         must match the call that provided the page token. Otherwise, an
          `INVALID_ARGUMENT`  error is returned.
         
        string page_token = 5;
        Parameters:
        value - The pageToken to set.
        Returns:
        This builder for chaining.
      • clearPageToken

        public SearchRequest.Builder clearPageToken()
         A page token received from a previous
         [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
         call. Provide this to retrieve the subsequent page.
        
         When paginating, all other parameters provided to
         [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
         must match the call that provided the page token. Otherwise, an
          `INVALID_ARGUMENT`  error is returned.
         
        string page_token = 5;
        Returns:
        This builder for chaining.
      • setPageTokenBytes

        public SearchRequest.Builder setPageTokenBytes​(com.google.protobuf.ByteString value)
         A page token received from a previous
         [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
         call. Provide this to retrieve the subsequent page.
        
         When paginating, all other parameters provided to
         [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
         must match the call that provided the page token. Otherwise, an
          `INVALID_ARGUMENT`  error is returned.
         
        string page_token = 5;
        Parameters:
        value - The bytes for pageToken to set.
        Returns:
        This builder for chaining.
      • getOffset

        public int getOffset()
         A 0-indexed integer that specifies the current offset (that is, starting
         result location, amongst the
         [Document][google.cloud.discoveryengine.v1.Document]s deemed by the API as
         relevant) in search results. This field is only considered if
         [page_token][google.cloud.discoveryengine.v1.SearchRequest.page_token] is
         unset.
        
         If this field is negative, an  `INVALID_ARGUMENT`  is returned.
         
        int32 offset = 6;
        Specified by:
        getOffset in interface SearchRequestOrBuilder
        Returns:
        The offset.
      • setOffset

        public SearchRequest.Builder setOffset​(int value)
         A 0-indexed integer that specifies the current offset (that is, starting
         result location, amongst the
         [Document][google.cloud.discoveryengine.v1.Document]s deemed by the API as
         relevant) in search results. This field is only considered if
         [page_token][google.cloud.discoveryengine.v1.SearchRequest.page_token] is
         unset.
        
         If this field is negative, an  `INVALID_ARGUMENT`  is returned.
         
        int32 offset = 6;
        Parameters:
        value - The offset to set.
        Returns:
        This builder for chaining.
      • clearOffset

        public SearchRequest.Builder clearOffset()
         A 0-indexed integer that specifies the current offset (that is, starting
         result location, amongst the
         [Document][google.cloud.discoveryengine.v1.Document]s deemed by the API as
         relevant) in search results. This field is only considered if
         [page_token][google.cloud.discoveryengine.v1.SearchRequest.page_token] is
         unset.
        
         If this field is negative, an  `INVALID_ARGUMENT`  is returned.
         
        int32 offset = 6;
        Returns:
        This builder for chaining.
      • getFilter

        public String getFilter()
         The filter syntax consists of an expression language for constructing a
         predicate from one or more fields of the documents being filtered. Filter
         expression is case-sensitive.
        
         If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.
         
        string filter = 7;
        Specified by:
        getFilter in interface SearchRequestOrBuilder
        Returns:
        The filter.
      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         The filter syntax consists of an expression language for constructing a
         predicate from one or more fields of the documents being filtered. Filter
         expression is case-sensitive.
        
         If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.
         
        string filter = 7;
        Specified by:
        getFilterBytes in interface SearchRequestOrBuilder
        Returns:
        The bytes for filter.
      • setFilter

        public SearchRequest.Builder setFilter​(String value)
         The filter syntax consists of an expression language for constructing a
         predicate from one or more fields of the documents being filtered. Filter
         expression is case-sensitive.
        
         If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.
         
        string filter = 7;
        Parameters:
        value - The filter to set.
        Returns:
        This builder for chaining.
      • clearFilter

        public SearchRequest.Builder clearFilter()
         The filter syntax consists of an expression language for constructing a
         predicate from one or more fields of the documents being filtered. Filter
         expression is case-sensitive.
        
         If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.
         
        string filter = 7;
        Returns:
        This builder for chaining.
      • setFilterBytes

        public SearchRequest.Builder setFilterBytes​(com.google.protobuf.ByteString value)
         The filter syntax consists of an expression language for constructing a
         predicate from one or more fields of the documents being filtered. Filter
         expression is case-sensitive.
        
         If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.
         
        string filter = 7;
        Parameters:
        value - The bytes for filter to set.
        Returns:
        This builder for chaining.
      • getOrderBy

        public String getOrderBy()
         The order in which documents are returned. Documents can be ordered by
         a field in an [Document][google.cloud.discoveryengine.v1.Document] object.
         Leave it unset if ordered by relevance. `order_by` expression is
         case-sensitive.
        
         If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
         
        string order_by = 8;
        Specified by:
        getOrderBy in interface SearchRequestOrBuilder
        Returns:
        The orderBy.
      • getOrderByBytes

        public com.google.protobuf.ByteString getOrderByBytes()
         The order in which documents are returned. Documents can be ordered by
         a field in an [Document][google.cloud.discoveryengine.v1.Document] object.
         Leave it unset if ordered by relevance. `order_by` expression is
         case-sensitive.
        
         If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
         
        string order_by = 8;
        Specified by:
        getOrderByBytes in interface SearchRequestOrBuilder
        Returns:
        The bytes for orderBy.
      • setOrderBy

        public SearchRequest.Builder setOrderBy​(String value)
         The order in which documents are returned. Documents can be ordered by
         a field in an [Document][google.cloud.discoveryengine.v1.Document] object.
         Leave it unset if ordered by relevance. `order_by` expression is
         case-sensitive.
        
         If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
         
        string order_by = 8;
        Parameters:
        value - The orderBy to set.
        Returns:
        This builder for chaining.
      • clearOrderBy

        public SearchRequest.Builder clearOrderBy()
         The order in which documents are returned. Documents can be ordered by
         a field in an [Document][google.cloud.discoveryengine.v1.Document] object.
         Leave it unset if ordered by relevance. `order_by` expression is
         case-sensitive.
        
         If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
         
        string order_by = 8;
        Returns:
        This builder for chaining.
      • setOrderByBytes

        public SearchRequest.Builder setOrderByBytes​(com.google.protobuf.ByteString value)
         The order in which documents are returned. Documents can be ordered by
         a field in an [Document][google.cloud.discoveryengine.v1.Document] object.
         Leave it unset if ordered by relevance. `order_by` expression is
         case-sensitive.
        
         If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
         
        string order_by = 8;
        Parameters:
        value - The bytes for orderBy to set.
        Returns:
        This builder for chaining.
      • hasUserInfo

        public boolean hasUserInfo()
         Information about the end user.
         Highly recommended for analytics.
         [UserInfo.user_agent][google.cloud.discoveryengine.v1.UserInfo.user_agent]
         is used to deduce `device_type` for analytics.
         
        .google.cloud.discoveryengine.v1.UserInfo user_info = 21;
        Specified by:
        hasUserInfo in interface SearchRequestOrBuilder
        Returns:
        Whether the userInfo field is set.
      • getUserInfo

        public UserInfo getUserInfo()
         Information about the end user.
         Highly recommended for analytics.
         [UserInfo.user_agent][google.cloud.discoveryengine.v1.UserInfo.user_agent]
         is used to deduce `device_type` for analytics.
         
        .google.cloud.discoveryengine.v1.UserInfo user_info = 21;
        Specified by:
        getUserInfo in interface SearchRequestOrBuilder
        Returns:
        The userInfo.
      • setUserInfo

        public SearchRequest.Builder setUserInfo​(UserInfo value)
         Information about the end user.
         Highly recommended for analytics.
         [UserInfo.user_agent][google.cloud.discoveryengine.v1.UserInfo.user_agent]
         is used to deduce `device_type` for analytics.
         
        .google.cloud.discoveryengine.v1.UserInfo user_info = 21;
      • setUserInfo

        public SearchRequest.Builder setUserInfo​(UserInfo.Builder builderForValue)
         Information about the end user.
         Highly recommended for analytics.
         [UserInfo.user_agent][google.cloud.discoveryengine.v1.UserInfo.user_agent]
         is used to deduce `device_type` for analytics.
         
        .google.cloud.discoveryengine.v1.UserInfo user_info = 21;
      • mergeUserInfo

        public SearchRequest.Builder mergeUserInfo​(UserInfo value)
         Information about the end user.
         Highly recommended for analytics.
         [UserInfo.user_agent][google.cloud.discoveryengine.v1.UserInfo.user_agent]
         is used to deduce `device_type` for analytics.
         
        .google.cloud.discoveryengine.v1.UserInfo user_info = 21;
      • clearUserInfo

        public SearchRequest.Builder clearUserInfo()
         Information about the end user.
         Highly recommended for analytics.
         [UserInfo.user_agent][google.cloud.discoveryengine.v1.UserInfo.user_agent]
         is used to deduce `device_type` for analytics.
         
        .google.cloud.discoveryengine.v1.UserInfo user_info = 21;
      • getUserInfoBuilder

        public UserInfo.Builder getUserInfoBuilder()
         Information about the end user.
         Highly recommended for analytics.
         [UserInfo.user_agent][google.cloud.discoveryengine.v1.UserInfo.user_agent]
         is used to deduce `device_type` for analytics.
         
        .google.cloud.discoveryengine.v1.UserInfo user_info = 21;
      • getUserInfoOrBuilder

        public UserInfoOrBuilder getUserInfoOrBuilder()
         Information about the end user.
         Highly recommended for analytics.
         [UserInfo.user_agent][google.cloud.discoveryengine.v1.UserInfo.user_agent]
         is used to deduce `device_type` for analytics.
         
        .google.cloud.discoveryengine.v1.UserInfo user_info = 21;
        Specified by:
        getUserInfoOrBuilder in interface SearchRequestOrBuilder
      • getFacetSpecsList

        public List<SearchRequest.FacetSpec> getFacetSpecsList()
         Facet specifications for faceted search. If empty, no facets are returned.
        
         A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
         error is returned.
         
        repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;
        Specified by:
        getFacetSpecsList in interface SearchRequestOrBuilder
      • getFacetSpecsCount

        public int getFacetSpecsCount()
         Facet specifications for faceted search. If empty, no facets are returned.
        
         A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
         error is returned.
         
        repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;
        Specified by:
        getFacetSpecsCount in interface SearchRequestOrBuilder
      • getFacetSpecs

        public SearchRequest.FacetSpec getFacetSpecs​(int index)
         Facet specifications for faceted search. If empty, no facets are returned.
        
         A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
         error is returned.
         
        repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;
        Specified by:
        getFacetSpecs in interface SearchRequestOrBuilder
      • setFacetSpecs

        public SearchRequest.Builder setFacetSpecs​(int index,
                                                   SearchRequest.FacetSpec value)
         Facet specifications for faceted search. If empty, no facets are returned.
        
         A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
         error is returned.
         
        repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;
      • setFacetSpecs

        public SearchRequest.Builder setFacetSpecs​(int index,
                                                   SearchRequest.FacetSpec.Builder builderForValue)
         Facet specifications for faceted search. If empty, no facets are returned.
        
         A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
         error is returned.
         
        repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;
      • addFacetSpecs

        public SearchRequest.Builder addFacetSpecs​(SearchRequest.FacetSpec value)
         Facet specifications for faceted search. If empty, no facets are returned.
        
         A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
         error is returned.
         
        repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;
      • addFacetSpecs

        public SearchRequest.Builder addFacetSpecs​(int index,
                                                   SearchRequest.FacetSpec value)
         Facet specifications for faceted search. If empty, no facets are returned.
        
         A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
         error is returned.
         
        repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;
      • addFacetSpecs

        public SearchRequest.Builder addFacetSpecs​(SearchRequest.FacetSpec.Builder builderForValue)
         Facet specifications for faceted search. If empty, no facets are returned.
        
         A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
         error is returned.
         
        repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;
      • addFacetSpecs

        public SearchRequest.Builder addFacetSpecs​(int index,
                                                   SearchRequest.FacetSpec.Builder builderForValue)
         Facet specifications for faceted search. If empty, no facets are returned.
        
         A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
         error is returned.
         
        repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;
      • addAllFacetSpecs

        public SearchRequest.Builder addAllFacetSpecs​(Iterable<? extends SearchRequest.FacetSpec> values)
         Facet specifications for faceted search. If empty, no facets are returned.
        
         A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
         error is returned.
         
        repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;
      • clearFacetSpecs

        public SearchRequest.Builder clearFacetSpecs()
         Facet specifications for faceted search. If empty, no facets are returned.
        
         A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
         error is returned.
         
        repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;
      • removeFacetSpecs

        public SearchRequest.Builder removeFacetSpecs​(int index)
         Facet specifications for faceted search. If empty, no facets are returned.
        
         A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
         error is returned.
         
        repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;
      • getFacetSpecsBuilder

        public SearchRequest.FacetSpec.Builder getFacetSpecsBuilder​(int index)
         Facet specifications for faceted search. If empty, no facets are returned.
        
         A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
         error is returned.
         
        repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;
      • getFacetSpecsOrBuilder

        public SearchRequest.FacetSpecOrBuilder getFacetSpecsOrBuilder​(int index)
         Facet specifications for faceted search. If empty, no facets are returned.
        
         A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
         error is returned.
         
        repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;
        Specified by:
        getFacetSpecsOrBuilder in interface SearchRequestOrBuilder
      • getFacetSpecsOrBuilderList

        public List<? extends SearchRequest.FacetSpecOrBuilder> getFacetSpecsOrBuilderList()
         Facet specifications for faceted search. If empty, no facets are returned.
        
         A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
         error is returned.
         
        repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;
        Specified by:
        getFacetSpecsOrBuilderList in interface SearchRequestOrBuilder
      • addFacetSpecsBuilder

        public SearchRequest.FacetSpec.Builder addFacetSpecsBuilder()
         Facet specifications for faceted search. If empty, no facets are returned.
        
         A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
         error is returned.
         
        repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;
      • addFacetSpecsBuilder

        public SearchRequest.FacetSpec.Builder addFacetSpecsBuilder​(int index)
         Facet specifications for faceted search. If empty, no facets are returned.
        
         A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
         error is returned.
         
        repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;
      • getFacetSpecsBuilderList

        public List<SearchRequest.FacetSpec.Builder> getFacetSpecsBuilderList()
         Facet specifications for faceted search. If empty, no facets are returned.
        
         A maximum of 100 values are allowed. Otherwise, an  `INVALID_ARGUMENT`
         error is returned.
         
        repeated .google.cloud.discoveryengine.v1.SearchRequest.FacetSpec facet_specs = 9;
      • hasBoostSpec

        public boolean hasBoostSpec()
         Boost specification to boost certain documents.
         
        .google.cloud.discoveryengine.v1.SearchRequest.BoostSpec boost_spec = 10;
        Specified by:
        hasBoostSpec in interface SearchRequestOrBuilder
        Returns:
        Whether the boostSpec field is set.
      • clearBoostSpec

        public SearchRequest.Builder clearBoostSpec()
         Boost specification to boost certain documents.
         
        .google.cloud.discoveryengine.v1.SearchRequest.BoostSpec boost_spec = 10;
      • getBoostSpecBuilder

        public SearchRequest.BoostSpec.Builder getBoostSpecBuilder()
         Boost specification to boost certain documents.
         
        .google.cloud.discoveryengine.v1.SearchRequest.BoostSpec boost_spec = 10;
      • getParamsCount

        public int getParamsCount()
        Description copied from interface: SearchRequestOrBuilder
         Additional search parameters.
        
         For public website search only, supported values are:
        
         * `user_country_code`: string. Default empty. If set to non-empty, results
            are restricted or boosted based on the location provided.
         * `search_type`: double. Default empty. Enables non-webpage searching
           depending on the value. The only valid non-default value is 1,
           which enables image searching.
         
        map<string, .google.protobuf.Value> params = 11;
        Specified by:
        getParamsCount in interface SearchRequestOrBuilder
      • containsParams

        public boolean containsParams​(String key)
         Additional search parameters.
        
         For public website search only, supported values are:
        
         * `user_country_code`: string. Default empty. If set to non-empty, results
            are restricted or boosted based on the location provided.
         * `search_type`: double. Default empty. Enables non-webpage searching
           depending on the value. The only valid non-default value is 1,
           which enables image searching.
         
        map<string, .google.protobuf.Value> params = 11;
        Specified by:
        containsParams in interface SearchRequestOrBuilder
      • getParamsMap

        public Map<String,​com.google.protobuf.Value> getParamsMap()
         Additional search parameters.
        
         For public website search only, supported values are:
        
         * `user_country_code`: string. Default empty. If set to non-empty, results
            are restricted or boosted based on the location provided.
         * `search_type`: double. Default empty. Enables non-webpage searching
           depending on the value. The only valid non-default value is 1,
           which enables image searching.
         
        map<string, .google.protobuf.Value> params = 11;
        Specified by:
        getParamsMap in interface SearchRequestOrBuilder
      • getParamsOrDefault

        public com.google.protobuf.Value getParamsOrDefault​(String key,
                                                            com.google.protobuf.Value defaultValue)
         Additional search parameters.
        
         For public website search only, supported values are:
        
         * `user_country_code`: string. Default empty. If set to non-empty, results
            are restricted or boosted based on the location provided.
         * `search_type`: double. Default empty. Enables non-webpage searching
           depending on the value. The only valid non-default value is 1,
           which enables image searching.
         
        map<string, .google.protobuf.Value> params = 11;
        Specified by:
        getParamsOrDefault in interface SearchRequestOrBuilder
      • getParamsOrThrow

        public com.google.protobuf.Value getParamsOrThrow​(String key)
         Additional search parameters.
        
         For public website search only, supported values are:
        
         * `user_country_code`: string. Default empty. If set to non-empty, results
            are restricted or boosted based on the location provided.
         * `search_type`: double. Default empty. Enables non-webpage searching
           depending on the value. The only valid non-default value is 1,
           which enables image searching.
         
        map<string, .google.protobuf.Value> params = 11;
        Specified by:
        getParamsOrThrow in interface SearchRequestOrBuilder
      • removeParams

        public SearchRequest.Builder removeParams​(String key)
         Additional search parameters.
        
         For public website search only, supported values are:
        
         * `user_country_code`: string. Default empty. If set to non-empty, results
            are restricted or boosted based on the location provided.
         * `search_type`: double. Default empty. Enables non-webpage searching
           depending on the value. The only valid non-default value is 1,
           which enables image searching.
         
        map<string, .google.protobuf.Value> params = 11;
      • getMutableParams

        @Deprecated
        public Map<String,​com.google.protobuf.Value> getMutableParams()
        Deprecated.
        Use alternate mutation accessors instead.
      • putParams

        public SearchRequest.Builder putParams​(String key,
                                               com.google.protobuf.Value value)
         Additional search parameters.
        
         For public website search only, supported values are:
        
         * `user_country_code`: string. Default empty. If set to non-empty, results
            are restricted or boosted based on the location provided.
         * `search_type`: double. Default empty. Enables non-webpage searching
           depending on the value. The only valid non-default value is 1,
           which enables image searching.
         
        map<string, .google.protobuf.Value> params = 11;
      • putAllParams

        public SearchRequest.Builder putAllParams​(Map<String,​com.google.protobuf.Value> values)
         Additional search parameters.
        
         For public website search only, supported values are:
        
         * `user_country_code`: string. Default empty. If set to non-empty, results
            are restricted or boosted based on the location provided.
         * `search_type`: double. Default empty. Enables non-webpage searching
           depending on the value. The only valid non-default value is 1,
           which enables image searching.
         
        map<string, .google.protobuf.Value> params = 11;
      • hasQueryExpansionSpec

        public boolean hasQueryExpansionSpec()
         The query expansion specification that specifies the conditions under which
         query expansion occurs.
         
        .google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;
        Specified by:
        hasQueryExpansionSpec in interface SearchRequestOrBuilder
        Returns:
        Whether the queryExpansionSpec field is set.
      • getQueryExpansionSpec

        public SearchRequest.QueryExpansionSpec getQueryExpansionSpec()
         The query expansion specification that specifies the conditions under which
         query expansion occurs.
         
        .google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;
        Specified by:
        getQueryExpansionSpec in interface SearchRequestOrBuilder
        Returns:
        The queryExpansionSpec.
      • setQueryExpansionSpec

        public SearchRequest.Builder setQueryExpansionSpec​(SearchRequest.QueryExpansionSpec value)
         The query expansion specification that specifies the conditions under which
         query expansion occurs.
         
        .google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;
      • setQueryExpansionSpec

        public SearchRequest.Builder setQueryExpansionSpec​(SearchRequest.QueryExpansionSpec.Builder builderForValue)
         The query expansion specification that specifies the conditions under which
         query expansion occurs.
         
        .google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;
      • mergeQueryExpansionSpec

        public SearchRequest.Builder mergeQueryExpansionSpec​(SearchRequest.QueryExpansionSpec value)
         The query expansion specification that specifies the conditions under which
         query expansion occurs.
         
        .google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;
      • clearQueryExpansionSpec

        public SearchRequest.Builder clearQueryExpansionSpec()
         The query expansion specification that specifies the conditions under which
         query expansion occurs.
         
        .google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;
      • getQueryExpansionSpecBuilder

        public SearchRequest.QueryExpansionSpec.Builder getQueryExpansionSpecBuilder()
         The query expansion specification that specifies the conditions under which
         query expansion occurs.
         
        .google.cloud.discoveryengine.v1.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;
      • hasSpellCorrectionSpec

        public boolean hasSpellCorrectionSpec()
         The spell correction specification that specifies the mode under
         which spell correction takes effect.
         
        .google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;
        Specified by:
        hasSpellCorrectionSpec in interface SearchRequestOrBuilder
        Returns:
        Whether the spellCorrectionSpec field is set.
      • getSpellCorrectionSpec

        public SearchRequest.SpellCorrectionSpec getSpellCorrectionSpec()
         The spell correction specification that specifies the mode under
         which spell correction takes effect.
         
        .google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;
        Specified by:
        getSpellCorrectionSpec in interface SearchRequestOrBuilder
        Returns:
        The spellCorrectionSpec.
      • setSpellCorrectionSpec

        public SearchRequest.Builder setSpellCorrectionSpec​(SearchRequest.SpellCorrectionSpec value)
         The spell correction specification that specifies the mode under
         which spell correction takes effect.
         
        .google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;
      • setSpellCorrectionSpec

        public SearchRequest.Builder setSpellCorrectionSpec​(SearchRequest.SpellCorrectionSpec.Builder builderForValue)
         The spell correction specification that specifies the mode under
         which spell correction takes effect.
         
        .google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;
      • mergeSpellCorrectionSpec

        public SearchRequest.Builder mergeSpellCorrectionSpec​(SearchRequest.SpellCorrectionSpec value)
         The spell correction specification that specifies the mode under
         which spell correction takes effect.
         
        .google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;
      • clearSpellCorrectionSpec

        public SearchRequest.Builder clearSpellCorrectionSpec()
         The spell correction specification that specifies the mode under
         which spell correction takes effect.
         
        .google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;
      • getSpellCorrectionSpecBuilder

        public SearchRequest.SpellCorrectionSpec.Builder getSpellCorrectionSpecBuilder()
         The spell correction specification that specifies the mode under
         which spell correction takes effect.
         
        .google.cloud.discoveryengine.v1.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;
      • getUserPseudoId

        public String getUserPseudoId()
         A unique identifier for tracking visitors. For example, this could be
         implemented with an HTTP cookie, which should be able to uniquely identify
         a visitor on a single device. This unique identifier should not change if
         the visitor logs in or out of the website.
        
         This field should NOT have a fixed value such as `unknown_visitor`.
        
         This should be the same identifier as
         [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id]
         and
         [CompleteQueryRequest.user_pseudo_id][google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id]
        
         The field must be a UTF-8 encoded string with a length limit of 128
         characters. Otherwise, an  `INVALID_ARGUMENT`  error is returned.
         
        string user_pseudo_id = 15;
        Specified by:
        getUserPseudoId in interface SearchRequestOrBuilder
        Returns:
        The userPseudoId.
      • getUserPseudoIdBytes

        public com.google.protobuf.ByteString getUserPseudoIdBytes()
         A unique identifier for tracking visitors. For example, this could be
         implemented with an HTTP cookie, which should be able to uniquely identify
         a visitor on a single device. This unique identifier should not change if
         the visitor logs in or out of the website.
        
         This field should NOT have a fixed value such as `unknown_visitor`.
        
         This should be the same identifier as
         [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id]
         and
         [CompleteQueryRequest.user_pseudo_id][google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id]
        
         The field must be a UTF-8 encoded string with a length limit of 128
         characters. Otherwise, an  `INVALID_ARGUMENT`  error is returned.
         
        string user_pseudo_id = 15;
        Specified by:
        getUserPseudoIdBytes in interface SearchRequestOrBuilder
        Returns:
        The bytes for userPseudoId.
      • setUserPseudoId

        public SearchRequest.Builder setUserPseudoId​(String value)
         A unique identifier for tracking visitors. For example, this could be
         implemented with an HTTP cookie, which should be able to uniquely identify
         a visitor on a single device. This unique identifier should not change if
         the visitor logs in or out of the website.
        
         This field should NOT have a fixed value such as `unknown_visitor`.
        
         This should be the same identifier as
         [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id]
         and
         [CompleteQueryRequest.user_pseudo_id][google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id]
        
         The field must be a UTF-8 encoded string with a length limit of 128
         characters. Otherwise, an  `INVALID_ARGUMENT`  error is returned.
         
        string user_pseudo_id = 15;
        Parameters:
        value - The userPseudoId to set.
        Returns:
        This builder for chaining.
      • clearUserPseudoId

        public SearchRequest.Builder clearUserPseudoId()
         A unique identifier for tracking visitors. For example, this could be
         implemented with an HTTP cookie, which should be able to uniquely identify
         a visitor on a single device. This unique identifier should not change if
         the visitor logs in or out of the website.
        
         This field should NOT have a fixed value such as `unknown_visitor`.
        
         This should be the same identifier as
         [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id]
         and
         [CompleteQueryRequest.user_pseudo_id][google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id]
        
         The field must be a UTF-8 encoded string with a length limit of 128
         characters. Otherwise, an  `INVALID_ARGUMENT`  error is returned.
         
        string user_pseudo_id = 15;
        Returns:
        This builder for chaining.
      • setUserPseudoIdBytes

        public SearchRequest.Builder setUserPseudoIdBytes​(com.google.protobuf.ByteString value)
         A unique identifier for tracking visitors. For example, this could be
         implemented with an HTTP cookie, which should be able to uniquely identify
         a visitor on a single device. This unique identifier should not change if
         the visitor logs in or out of the website.
        
         This field should NOT have a fixed value such as `unknown_visitor`.
        
         This should be the same identifier as
         [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id]
         and
         [CompleteQueryRequest.user_pseudo_id][google.cloud.discoveryengine.v1.CompleteQueryRequest.user_pseudo_id]
        
         The field must be a UTF-8 encoded string with a length limit of 128
         characters. Otherwise, an  `INVALID_ARGUMENT`  error is returned.
         
        string user_pseudo_id = 15;
        Parameters:
        value - The bytes for userPseudoId to set.
        Returns:
        This builder for chaining.
      • hasContentSearchSpec

        public boolean hasContentSearchSpec()
         A specification for configuring the behavior of content search.
         
        .google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec content_search_spec = 24;
        Specified by:
        hasContentSearchSpec in interface SearchRequestOrBuilder
        Returns:
        Whether the contentSearchSpec field is set.
      • setContentSearchSpec

        public SearchRequest.Builder setContentSearchSpec​(SearchRequest.ContentSearchSpec value)
         A specification for configuring the behavior of content search.
         
        .google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec content_search_spec = 24;
      • mergeContentSearchSpec

        public SearchRequest.Builder mergeContentSearchSpec​(SearchRequest.ContentSearchSpec value)
         A specification for configuring the behavior of content search.
         
        .google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec content_search_spec = 24;
      • clearContentSearchSpec

        public SearchRequest.Builder clearContentSearchSpec()
         A specification for configuring the behavior of content search.
         
        .google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec content_search_spec = 24;
      • getContentSearchSpecBuilder

        public SearchRequest.ContentSearchSpec.Builder getContentSearchSpecBuilder()
         A specification for configuring the behavior of content search.
         
        .google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec content_search_spec = 24;
      • getSafeSearch

        public boolean getSafeSearch()
         Whether to turn on safe search. This is only supported for
         website search.
         
        bool safe_search = 20;
        Specified by:
        getSafeSearch in interface SearchRequestOrBuilder
        Returns:
        The safeSearch.
      • setSafeSearch

        public SearchRequest.Builder setSafeSearch​(boolean value)
         Whether to turn on safe search. This is only supported for
         website search.
         
        bool safe_search = 20;
        Parameters:
        value - The safeSearch to set.
        Returns:
        This builder for chaining.
      • clearSafeSearch

        public SearchRequest.Builder clearSafeSearch()
         Whether to turn on safe search. This is only supported for
         website search.
         
        bool safe_search = 20;
        Returns:
        This builder for chaining.
      • getUserLabelsCount

        public int getUserLabelsCount()
        Description copied from interface: SearchRequestOrBuilder
         The user labels applied to a resource must meet the following requirements:
        
         * Each resource can have multiple labels, up to a maximum of 64.
         * Each label must be a key-value pair.
         * Keys have a minimum length of 1 character and a maximum length of 63
           characters and cannot be empty. Values can be empty and have a maximum
           length of 63 characters.
         * Keys and values can contain only lowercase letters, numeric characters,
           underscores, and dashes. All characters must use UTF-8 encoding, and
           international characters are allowed.
         * The key portion of a label must be unique. However, you can use the same
           key with multiple resources.
         * Keys must start with a lowercase letter or international character.
        
         See [Google Cloud
         Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
         for more details.
         
        map<string, string> user_labels = 22;
        Specified by:
        getUserLabelsCount in interface SearchRequestOrBuilder
      • containsUserLabels

        public boolean containsUserLabels​(String key)
         The user labels applied to a resource must meet the following requirements:
        
         * Each resource can have multiple labels, up to a maximum of 64.
         * Each label must be a key-value pair.
         * Keys have a minimum length of 1 character and a maximum length of 63
           characters and cannot be empty. Values can be empty and have a maximum
           length of 63 characters.
         * Keys and values can contain only lowercase letters, numeric characters,
           underscores, and dashes. All characters must use UTF-8 encoding, and
           international characters are allowed.
         * The key portion of a label must be unique. However, you can use the same
           key with multiple resources.
         * Keys must start with a lowercase letter or international character.
        
         See [Google Cloud
         Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
         for more details.
         
        map<string, string> user_labels = 22;
        Specified by:
        containsUserLabels in interface SearchRequestOrBuilder
      • getUserLabelsMap

        public Map<String,​String> getUserLabelsMap()
         The user labels applied to a resource must meet the following requirements:
        
         * Each resource can have multiple labels, up to a maximum of 64.
         * Each label must be a key-value pair.
         * Keys have a minimum length of 1 character and a maximum length of 63
           characters and cannot be empty. Values can be empty and have a maximum
           length of 63 characters.
         * Keys and values can contain only lowercase letters, numeric characters,
           underscores, and dashes. All characters must use UTF-8 encoding, and
           international characters are allowed.
         * The key portion of a label must be unique. However, you can use the same
           key with multiple resources.
         * Keys must start with a lowercase letter or international character.
        
         See [Google Cloud
         Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
         for more details.
         
        map<string, string> user_labels = 22;
        Specified by:
        getUserLabelsMap in interface SearchRequestOrBuilder
      • getUserLabelsOrDefault

        public String getUserLabelsOrDefault​(String key,
                                             String defaultValue)
         The user labels applied to a resource must meet the following requirements:
        
         * Each resource can have multiple labels, up to a maximum of 64.
         * Each label must be a key-value pair.
         * Keys have a minimum length of 1 character and a maximum length of 63
           characters and cannot be empty. Values can be empty and have a maximum
           length of 63 characters.
         * Keys and values can contain only lowercase letters, numeric characters,
           underscores, and dashes. All characters must use UTF-8 encoding, and
           international characters are allowed.
         * The key portion of a label must be unique. However, you can use the same
           key with multiple resources.
         * Keys must start with a lowercase letter or international character.
        
         See [Google Cloud
         Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
         for more details.
         
        map<string, string> user_labels = 22;
        Specified by:
        getUserLabelsOrDefault in interface SearchRequestOrBuilder
      • getUserLabelsOrThrow

        public String getUserLabelsOrThrow​(String key)
         The user labels applied to a resource must meet the following requirements:
        
         * Each resource can have multiple labels, up to a maximum of 64.
         * Each label must be a key-value pair.
         * Keys have a minimum length of 1 character and a maximum length of 63
           characters and cannot be empty. Values can be empty and have a maximum
           length of 63 characters.
         * Keys and values can contain only lowercase letters, numeric characters,
           underscores, and dashes. All characters must use UTF-8 encoding, and
           international characters are allowed.
         * The key portion of a label must be unique. However, you can use the same
           key with multiple resources.
         * Keys must start with a lowercase letter or international character.
        
         See [Google Cloud
         Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
         for more details.
         
        map<string, string> user_labels = 22;
        Specified by:
        getUserLabelsOrThrow in interface SearchRequestOrBuilder
      • removeUserLabels

        public SearchRequest.Builder removeUserLabels​(String key)
         The user labels applied to a resource must meet the following requirements:
        
         * Each resource can have multiple labels, up to a maximum of 64.
         * Each label must be a key-value pair.
         * Keys have a minimum length of 1 character and a maximum length of 63
           characters and cannot be empty. Values can be empty and have a maximum
           length of 63 characters.
         * Keys and values can contain only lowercase letters, numeric characters,
           underscores, and dashes. All characters must use UTF-8 encoding, and
           international characters are allowed.
         * The key portion of a label must be unique. However, you can use the same
           key with multiple resources.
         * Keys must start with a lowercase letter or international character.
        
         See [Google Cloud
         Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
         for more details.
         
        map<string, string> user_labels = 22;
      • getMutableUserLabels

        @Deprecated
        public Map<String,​String> getMutableUserLabels()
        Deprecated.
        Use alternate mutation accessors instead.
      • putUserLabels

        public SearchRequest.Builder putUserLabels​(String key,
                                                   String value)
         The user labels applied to a resource must meet the following requirements:
        
         * Each resource can have multiple labels, up to a maximum of 64.
         * Each label must be a key-value pair.
         * Keys have a minimum length of 1 character and a maximum length of 63
           characters and cannot be empty. Values can be empty and have a maximum
           length of 63 characters.
         * Keys and values can contain only lowercase letters, numeric characters,
           underscores, and dashes. All characters must use UTF-8 encoding, and
           international characters are allowed.
         * The key portion of a label must be unique. However, you can use the same
           key with multiple resources.
         * Keys must start with a lowercase letter or international character.
        
         See [Google Cloud
         Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
         for more details.
         
        map<string, string> user_labels = 22;
      • putAllUserLabels

        public SearchRequest.Builder putAllUserLabels​(Map<String,​String> values)
         The user labels applied to a resource must meet the following requirements:
        
         * Each resource can have multiple labels, up to a maximum of 64.
         * Each label must be a key-value pair.
         * Keys have a minimum length of 1 character and a maximum length of 63
           characters and cannot be empty. Values can be empty and have a maximum
           length of 63 characters.
         * Keys and values can contain only lowercase letters, numeric characters,
           underscores, and dashes. All characters must use UTF-8 encoding, and
           international characters are allowed.
         * The key portion of a label must be unique. However, you can use the same
           key with multiple resources.
         * Keys must start with a lowercase letter or international character.
        
         See [Google Cloud
         Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
         for more details.
         
        map<string, string> user_labels = 22;
      • setUnknownFields

        public final SearchRequest.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>
      • mergeUnknownFields

        public final SearchRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>