Package com.google.cloud.discoveryengine.v1beta

Class SearchRequest

  • All Implemented Interfaces:
    SearchRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class SearchRequest
extends com.google.protobuf.GeneratedMessageV3
implements SearchRequestOrBuilder
     Request message for
 [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
 method.
    Protobuf type google.cloud.discoveryengine.v1beta.SearchRequest
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • 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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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.

      • 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.

      • getQueryBytes

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

      • hasImageQuery

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

      • getPageSize

        public int getPageSize()
         Maximum number of [Document][google.cloud.discoveryengine.v1beta.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.

      • getPageToken

        public String getPageToken()
         A page token received from a previous
 [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [SearchService.Search][google.cloud.discoveryengine.v1beta.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.v1beta.SearchService.Search]
 call. Provide this to retrieve the subsequent page.

 When paginating, all other parameters provided to
 [SearchService.Search][google.cloud.discoveryengine.v1beta.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.

      • getOffset

        public int getOffset()
         A 0-indexed integer that specifies the current offset (that is, starting
 result location, amongst the
 [Document][google.cloud.discoveryengine.v1beta.Document]s deemed by the API
 as relevant) in search results. This field is only considered if
 [page_token][google.cloud.discoveryengine.v1beta.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.

      • 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.

      • getOrderBy

        public String getOrderBy()
         The order in which documents are returned. Documents can be ordered by
 a field in an [Document][google.cloud.discoveryengine.v1beta.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.v1beta.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.

      • hasUserInfo

        public boolean hasUserInfo()
         Information about the end user.
 Highly recommended for analytics.
 [UserInfo.user_agent][google.cloud.discoveryengine.v1beta.UserInfo.user_agent]
 is used to deduce `device_type` for analytics.
        .google.cloud.discoveryengine.v1beta.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.v1beta.UserInfo.user_agent]
 is used to deduce `device_type` for analytics.
        .google.cloud.discoveryengine.v1beta.UserInfo user_info = 21;
        Specified by:
        getUserInfo in interface SearchRequestOrBuilder
        Returns:
        The userInfo.

      • getUserInfoOrBuilder

        public UserInfoOrBuilder getUserInfoOrBuilder()
         Information about the end user.
 Highly recommended for analytics.
 [UserInfo.user_agent][google.cloud.discoveryengine.v1beta.UserInfo.user_agent]
 is used to deduce `device_type` for analytics.
        .google.cloud.discoveryengine.v1beta.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.v1beta.SearchRequest.FacetSpec facet_specs = 9;
        Specified by:
        getFacetSpecsList 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.v1beta.SearchRequest.FacetSpec facet_specs = 9;
        Specified by:
        getFacetSpecsOrBuilderList 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.v1beta.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.v1beta.SearchRequest.FacetSpec facet_specs = 9;
        Specified by:
        getFacetSpecs in interface SearchRequestOrBuilder

      • 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.v1beta.SearchRequest.FacetSpec facet_specs = 9;
        Specified by:
        getFacetSpecsOrBuilder in interface SearchRequestOrBuilder

      • hasBoostSpec

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

      • 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

      • hasQueryExpansionSpec

        public boolean hasQueryExpansionSpec()
         The query expansion specification that specifies the conditions under which
 query expansion occurs.
        .google.cloud.discoveryengine.v1beta.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.v1beta.SearchRequest.QueryExpansionSpec query_expansion_spec = 13;
        Specified by:
        getQueryExpansionSpec in interface SearchRequestOrBuilder
        Returns:
        The queryExpansionSpec.

      • hasSpellCorrectionSpec

        public boolean hasSpellCorrectionSpec()
         The spell correction specification that specifies the mode under
 which spell correction takes effect.
        .google.cloud.discoveryengine.v1beta.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.v1beta.SearchRequest.SpellCorrectionSpec spell_correction_spec = 14;
        Specified by:
        getSpellCorrectionSpec in interface SearchRequestOrBuilder
        Returns:
        The spellCorrectionSpec.

      • 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.v1beta.UserEvent.user_pseudo_id]
 and
 [CompleteQueryRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.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.v1beta.UserEvent.user_pseudo_id]
 and
 [CompleteQueryRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.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.

      • hasContentSearchSpec

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

      • hasEmbeddingSpec

        public boolean hasEmbeddingSpec()
         Uses the provided embedding to do additional semantic document retrieval.
 The retrieval is based on the dot product of
 [SearchRequest.embedding_spec.embedding_vectors.vector][] and the document
 embedding that is provided in
 [SearchRequest.embedding_spec.embedding_vectors.field_path][].

 If [SearchRequest.embedding_spec.embedding_vectors.field_path][] is not
 provided, it will use [ServingConfig.embedding_config.field_paths][].
        .google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec embedding_spec = 23;
        Specified by:
        hasEmbeddingSpec in interface SearchRequestOrBuilder
        Returns:
        Whether the embeddingSpec field is set.

      • getEmbeddingSpec

        public SearchRequest.EmbeddingSpec getEmbeddingSpec()
         Uses the provided embedding to do additional semantic document retrieval.
 The retrieval is based on the dot product of
 [SearchRequest.embedding_spec.embedding_vectors.vector][] and the document
 embedding that is provided in
 [SearchRequest.embedding_spec.embedding_vectors.field_path][].

 If [SearchRequest.embedding_spec.embedding_vectors.field_path][] is not
 provided, it will use [ServingConfig.embedding_config.field_paths][].
        .google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec embedding_spec = 23;
        Specified by:
        getEmbeddingSpec in interface SearchRequestOrBuilder
        Returns:
        The embeddingSpec.

      • getEmbeddingSpecOrBuilder

        public SearchRequest.EmbeddingSpecOrBuilder getEmbeddingSpecOrBuilder()
         Uses the provided embedding to do additional semantic document retrieval.
 The retrieval is based on the dot product of
 [SearchRequest.embedding_spec.embedding_vectors.vector][] and the document
 embedding that is provided in
 [SearchRequest.embedding_spec.embedding_vectors.field_path][].

 If [SearchRequest.embedding_spec.embedding_vectors.field_path][] is not
 provided, it will use [ServingConfig.embedding_config.field_paths][].
        .google.cloud.discoveryengine.v1beta.SearchRequest.EmbeddingSpec embedding_spec = 23;
        Specified by:
        getEmbeddingSpecOrBuilder in interface SearchRequestOrBuilder

      • getRankingExpression

        public String getRankingExpression()
         The ranking expression controls the customized ranking on retrieval
 documents. This overrides [ServingConfig.ranking_expression][].
 The ranking expression is a single function or multiple functions that are
 joint by "+".
   * ranking_expression = function, { " + ", function };
 Supported functions:
   * double * relevance_score
   * double * dotProduct(embedding_field_path)
 Function variables:
   `relevance_score`: pre-defined keywords, used for measure relevance
   between query and document.
   `embedding_field_path`: the document embedding field
   used with query embedding vector.
   `dotProduct`: embedding function between embedding_field_path and query
   embedding vector.

  Example ranking expression:
    If document has an embedding field doc_embedding, the ranking expression
    could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
        string ranking_expression = 26;
        Specified by:
        getRankingExpression in interface SearchRequestOrBuilder
        Returns:
        The rankingExpression.

      • getRankingExpressionBytes

        public com.google.protobuf.ByteString getRankingExpressionBytes()
         The ranking expression controls the customized ranking on retrieval
 documents. This overrides [ServingConfig.ranking_expression][].
 The ranking expression is a single function or multiple functions that are
 joint by "+".
   * ranking_expression = function, { " + ", function };
 Supported functions:
   * double * relevance_score
   * double * dotProduct(embedding_field_path)
 Function variables:
   `relevance_score`: pre-defined keywords, used for measure relevance
   between query and document.
   `embedding_field_path`: the document embedding field
   used with query embedding vector.
   `dotProduct`: embedding function between embedding_field_path and query
   embedding vector.

  Example ranking expression:
    If document has an embedding field doc_embedding, the ranking expression
    could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.
        string ranking_expression = 26;
        Specified by:
        getRankingExpressionBytes in interface SearchRequestOrBuilder
        Returns:
        The bytes for rankingExpression.

      • 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.

      • 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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static SearchRequest parseFrom​(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SearchRequest parseFrom​(ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SearchRequest parseFrom​(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SearchRequest parseFrom​(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SearchRequest parseFrom​(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SearchRequest parseFrom​(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static SearchRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException
        Throws:
        IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected SearchRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static SearchRequest getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<SearchRequest> parser()

      • getParserForType

        public com.google.protobuf.Parser<SearchRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

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