Package com.google.cloud.retail.v2alpha

Class ConversationalSearchRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ConversationalSearchRequest.Builder>
com.google.cloud.retail.v2alpha.ConversationalSearchRequest.Builder
All Implemented Interfaces:
ConversationalSearchRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
ConversationalSearchRequest
public static final class ConversationalSearchRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<ConversationalSearchRequest.Builder> implements ConversationalSearchRequestOrBuilder
 Request message for
 [ConversationalSearchService.ConversationalSearch][google.cloud.retail.v2alpha.ConversationalSearchService.ConversationalSearch]
 method.
Protobuf type google.cloud.retail.v2alpha.ConversationalSearchRequest

  • Method Details

    • getDescriptor

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

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<ConversationalSearchRequest.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<ConversationalSearchRequest.Builder>

    • internalGetFieldAccessorTable

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

    • clear

      public ConversationalSearchRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<ConversationalSearchRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ConversationalSearchRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public ConversationalSearchRequest.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<ConversationalSearchRequest.Builder>

    • mergeFrom

      public ConversationalSearchRequest.Builder mergeFrom(ConversationalSearchRequest other)

    • isInitialized

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

    • mergeFrom

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

    • getPlacement

      public String getPlacement()
       Required. The resource name of the search engine placement, such as
 `projects/*/locations/global/catalogs/default_catalog/placements/default_search`
 or
 `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config`
 This field is used to identify the serving config name and the set
 of models that will be used to make the search.
      string placement = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPlacement in interface ConversationalSearchRequestOrBuilder
      Returns:
      The placement.

    • getPlacementBytes

      public com.google.protobuf.ByteString getPlacementBytes()
       Required. The resource name of the search engine placement, such as
 `projects/*/locations/global/catalogs/default_catalog/placements/default_search`
 or
 `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config`
 This field is used to identify the serving config name and the set
 of models that will be used to make the search.
      string placement = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getPlacementBytes in interface ConversationalSearchRequestOrBuilder
      Returns:
      The bytes for placement.

    • setPlacement

      public ConversationalSearchRequest.Builder setPlacement(String value)
       Required. The resource name of the search engine placement, such as
 `projects/*/locations/global/catalogs/default_catalog/placements/default_search`
 or
 `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config`
 This field is used to identify the serving config name and the set
 of models that will be used to make the search.
      string placement = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The placement to set.
      Returns:
      This builder for chaining.

    • clearPlacement

      public ConversationalSearchRequest.Builder clearPlacement()
       Required. The resource name of the search engine placement, such as
 `projects/*/locations/global/catalogs/default_catalog/placements/default_search`
 or
 `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config`
 This field is used to identify the serving config name and the set
 of models that will be used to make the search.
      string placement = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setPlacementBytes

      public ConversationalSearchRequest.Builder setPlacementBytes(com.google.protobuf.ByteString value)
       Required. The resource name of the search engine placement, such as
 `projects/*/locations/global/catalogs/default_catalog/placements/default_search`
 or
 `projects/*/locations/global/catalogs/default_catalog/servingConfigs/default_serving_config`
 This field is used to identify the serving config name and the set
 of models that will be used to make the search.
      string placement = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for placement to set.
      Returns:
      This builder for chaining.

    • getBranch

      public String getBranch()
       Required. The branch resource name, such as
 `projects/*/locations/global/catalogs/default_catalog/branches/0`.

 Use "default_branch" as the branch ID or leave this field empty, to search
 products under the default branch.
      string branch = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getBranch in interface ConversationalSearchRequestOrBuilder
      Returns:
      The branch.

    • getBranchBytes

      public com.google.protobuf.ByteString getBranchBytes()
       Required. The branch resource name, such as
 `projects/*/locations/global/catalogs/default_catalog/branches/0`.

 Use "default_branch" as the branch ID or leave this field empty, to search
 products under the default branch.
      string branch = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getBranchBytes in interface ConversationalSearchRequestOrBuilder
      Returns:
      The bytes for branch.

    • setBranch

      public ConversationalSearchRequest.Builder setBranch(String value)
       Required. The branch resource name, such as
 `projects/*/locations/global/catalogs/default_catalog/branches/0`.

 Use "default_branch" as the branch ID or leave this field empty, to search
 products under the default branch.
      string branch = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The branch to set.
      Returns:
      This builder for chaining.

    • clearBranch

      public ConversationalSearchRequest.Builder clearBranch()
       Required. The branch resource name, such as
 `projects/*/locations/global/catalogs/default_catalog/branches/0`.

 Use "default_branch" as the branch ID or leave this field empty, to search
 products under the default branch.
      string branch = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setBranchBytes

      public ConversationalSearchRequest.Builder setBranchBytes(com.google.protobuf.ByteString value)
       Required. The branch resource name, such as
 `projects/*/locations/global/catalogs/default_catalog/branches/0`.

 Use "default_branch" as the branch ID or leave this field empty, to search
 products under the default branch.
      string branch = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for branch to set.
      Returns:
      This builder for chaining.

    • getQuery

      public String getQuery()
       Optional. Raw search query to be searched for.

 If this field is empty, the request is considered a category browsing
 request.
      string query = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getQuery in interface ConversationalSearchRequestOrBuilder
      Returns:
      The query.

    • getQueryBytes

      public com.google.protobuf.ByteString getQueryBytes()
       Optional. Raw search query to be searched for.

 If this field is empty, the request is considered a category browsing
 request.
      string query = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getQueryBytes in interface ConversationalSearchRequestOrBuilder
      Returns:
      The bytes for query.

    • setQuery

      public ConversationalSearchRequest.Builder setQuery(String value)
       Optional. Raw search query to be searched for.

 If this field is empty, the request is considered a category browsing
 request.
      string query = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The query to set.
      Returns:
      This builder for chaining.

    • clearQuery

      public ConversationalSearchRequest.Builder clearQuery()
       Optional. Raw search query to be searched for.

 If this field is empty, the request is considered a category browsing
 request.
      string query = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setQueryBytes

      public ConversationalSearchRequest.Builder setQueryBytes(com.google.protobuf.ByteString value)
       Optional. Raw search query to be searched for.

 If this field is empty, the request is considered a category browsing
 request.
      string query = 3 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for query to set.
      Returns:
      This builder for chaining.

    • getPageCategoriesList

      public com.google.protobuf.ProtocolStringList getPageCategoriesList()
       Optional. The categories associated with a category page. Must be set for
 category navigation queries to achieve good search quality. The format
 should be the same as
 [UserEvent.page_categories][google.cloud.retail.v2alpha.UserEvent.page_categories];

 To represent full path of category, use '>' sign to separate different
 hierarchies. If '>' is part of the category name, replace it with
 other character(s).

 Category pages include special pages such as sales or promotions. For
 instance, a special sale page may have the category hierarchy:
 "pageCategories" : ["Sales > 2017 Black Friday Deals"].
      repeated string page_categories = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageCategoriesList in interface ConversationalSearchRequestOrBuilder
      Returns:
      A list containing the pageCategories.

    • getPageCategoriesCount

      public int getPageCategoriesCount()
       Optional. The categories associated with a category page. Must be set for
 category navigation queries to achieve good search quality. The format
 should be the same as
 [UserEvent.page_categories][google.cloud.retail.v2alpha.UserEvent.page_categories];

 To represent full path of category, use '>' sign to separate different
 hierarchies. If '>' is part of the category name, replace it with
 other character(s).

 Category pages include special pages such as sales or promotions. For
 instance, a special sale page may have the category hierarchy:
 "pageCategories" : ["Sales > 2017 Black Friday Deals"].
      repeated string page_categories = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageCategoriesCount in interface ConversationalSearchRequestOrBuilder
      Returns:
      The count of pageCategories.

    • getPageCategories

      public String getPageCategories(int index)
       Optional. The categories associated with a category page. Must be set for
 category navigation queries to achieve good search quality. The format
 should be the same as
 [UserEvent.page_categories][google.cloud.retail.v2alpha.UserEvent.page_categories];

 To represent full path of category, use '>' sign to separate different
 hierarchies. If '>' is part of the category name, replace it with
 other character(s).

 Category pages include special pages such as sales or promotions. For
 instance, a special sale page may have the category hierarchy:
 "pageCategories" : ["Sales > 2017 Black Friday Deals"].
      repeated string page_categories = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageCategories in interface ConversationalSearchRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The pageCategories at the given index.

    • getPageCategoriesBytes

      public com.google.protobuf.ByteString getPageCategoriesBytes(int index)
       Optional. The categories associated with a category page. Must be set for
 category navigation queries to achieve good search quality. The format
 should be the same as
 [UserEvent.page_categories][google.cloud.retail.v2alpha.UserEvent.page_categories];

 To represent full path of category, use '>' sign to separate different
 hierarchies. If '>' is part of the category name, replace it with
 other character(s).

 Category pages include special pages such as sales or promotions. For
 instance, a special sale page may have the category hierarchy:
 "pageCategories" : ["Sales > 2017 Black Friday Deals"].
      repeated string page_categories = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPageCategoriesBytes in interface ConversationalSearchRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the pageCategories at the given index.

    • setPageCategories

      public ConversationalSearchRequest.Builder setPageCategories(int index, String value)
       Optional. The categories associated with a category page. Must be set for
 category navigation queries to achieve good search quality. The format
 should be the same as
 [UserEvent.page_categories][google.cloud.retail.v2alpha.UserEvent.page_categories];

 To represent full path of category, use '>' sign to separate different
 hierarchies. If '>' is part of the category name, replace it with
 other character(s).

 Category pages include special pages such as sales or promotions. For
 instance, a special sale page may have the category hierarchy:
 "pageCategories" : ["Sales > 2017 Black Friday Deals"].
      repeated string page_categories = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      index - The index to set the value at.
      value - The pageCategories to set.
      Returns:
      This builder for chaining.

    • addPageCategories

      public ConversationalSearchRequest.Builder addPageCategories(String value)
       Optional. The categories associated with a category page. Must be set for
 category navigation queries to achieve good search quality. The format
 should be the same as
 [UserEvent.page_categories][google.cloud.retail.v2alpha.UserEvent.page_categories];

 To represent full path of category, use '>' sign to separate different
 hierarchies. If '>' is part of the category name, replace it with
 other character(s).

 Category pages include special pages such as sales or promotions. For
 instance, a special sale page may have the category hierarchy:
 "pageCategories" : ["Sales > 2017 Black Friday Deals"].
      repeated string page_categories = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The pageCategories to add.
      Returns:
      This builder for chaining.

    • addAllPageCategories

      public ConversationalSearchRequest.Builder addAllPageCategories(Iterable<String> values)
       Optional. The categories associated with a category page. Must be set for
 category navigation queries to achieve good search quality. The format
 should be the same as
 [UserEvent.page_categories][google.cloud.retail.v2alpha.UserEvent.page_categories];

 To represent full path of category, use '>' sign to separate different
 hierarchies. If '>' is part of the category name, replace it with
 other character(s).

 Category pages include special pages such as sales or promotions. For
 instance, a special sale page may have the category hierarchy:
 "pageCategories" : ["Sales > 2017 Black Friday Deals"].
      repeated string page_categories = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      values - The pageCategories to add.
      Returns:
      This builder for chaining.

    • clearPageCategories

      public ConversationalSearchRequest.Builder clearPageCategories()
       Optional. The categories associated with a category page. Must be set for
 category navigation queries to achieve good search quality. The format
 should be the same as
 [UserEvent.page_categories][google.cloud.retail.v2alpha.UserEvent.page_categories];

 To represent full path of category, use '>' sign to separate different
 hierarchies. If '>' is part of the category name, replace it with
 other character(s).

 Category pages include special pages such as sales or promotions. For
 instance, a special sale page may have the category hierarchy:
 "pageCategories" : ["Sales > 2017 Black Friday Deals"].
      repeated string page_categories = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • addPageCategoriesBytes

      public ConversationalSearchRequest.Builder addPageCategoriesBytes(com.google.protobuf.ByteString value)
       Optional. The categories associated with a category page. Must be set for
 category navigation queries to achieve good search quality. The format
 should be the same as
 [UserEvent.page_categories][google.cloud.retail.v2alpha.UserEvent.page_categories];

 To represent full path of category, use '>' sign to separate different
 hierarchies. If '>' is part of the category name, replace it with
 other character(s).

 Category pages include special pages such as sales or promotions. For
 instance, a special sale page may have the category hierarchy:
 "pageCategories" : ["Sales > 2017 Black Friday Deals"].
      repeated string page_categories = 4 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes of the pageCategories to add.
      Returns:
      This builder for chaining.

    • getConversationId

      public String getConversationId()
       Optional. This field specifies the conversation id, which maintains the
 state of the conversation between client side and server side. Use the
 value from the previous
 [ConversationalSearchResponse.conversation_id][google.cloud.retail.v2alpha.ConversationalSearchResponse.conversation_id].
 For the initial request, this should be empty.
      string conversation_id = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getConversationId in interface ConversationalSearchRequestOrBuilder
      Returns:
      The conversationId.

    • getConversationIdBytes

      public com.google.protobuf.ByteString getConversationIdBytes()
       Optional. This field specifies the conversation id, which maintains the
 state of the conversation between client side and server side. Use the
 value from the previous
 [ConversationalSearchResponse.conversation_id][google.cloud.retail.v2alpha.ConversationalSearchResponse.conversation_id].
 For the initial request, this should be empty.
      string conversation_id = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getConversationIdBytes in interface ConversationalSearchRequestOrBuilder
      Returns:
      The bytes for conversationId.

    • setConversationId

      public ConversationalSearchRequest.Builder setConversationId(String value)
       Optional. This field specifies the conversation id, which maintains the
 state of the conversation between client side and server side. Use the
 value from the previous
 [ConversationalSearchResponse.conversation_id][google.cloud.retail.v2alpha.ConversationalSearchResponse.conversation_id].
 For the initial request, this should be empty.
      string conversation_id = 5 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The conversationId to set.
      Returns:
      This builder for chaining.

    • clearConversationId

      public ConversationalSearchRequest.Builder clearConversationId()
       Optional. This field specifies the conversation id, which maintains the
 state of the conversation between client side and server side. Use the
 value from the previous
 [ConversationalSearchResponse.conversation_id][google.cloud.retail.v2alpha.ConversationalSearchResponse.conversation_id].
 For the initial request, this should be empty.
      string conversation_id = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setConversationIdBytes

      public ConversationalSearchRequest.Builder setConversationIdBytes(com.google.protobuf.ByteString value)
       Optional. This field specifies the conversation id, which maintains the
 state of the conversation between client side and server side. Use the
 value from the previous
 [ConversationalSearchResponse.conversation_id][google.cloud.retail.v2alpha.ConversationalSearchResponse.conversation_id].
 For the initial request, this should be empty.
      string conversation_id = 5 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for conversationId to set.
      Returns:
      This builder for chaining.

    • hasSearchParams

      public boolean hasSearchParams()
       Optional. Search parameters.
      .google.cloud.retail.v2alpha.ConversationalSearchRequest.SearchParams search_params = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasSearchParams in interface ConversationalSearchRequestOrBuilder
      Returns:
      Whether the searchParams field is set.

    • getSearchParams

      public ConversationalSearchRequest.SearchParams getSearchParams()
       Optional. Search parameters.
      .google.cloud.retail.v2alpha.ConversationalSearchRequest.SearchParams search_params = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSearchParams in interface ConversationalSearchRequestOrBuilder
      Returns:
      The searchParams.

    • setSearchParams

      public ConversationalSearchRequest.Builder setSearchParams(ConversationalSearchRequest.SearchParams value)
       Optional. Search parameters.
      .google.cloud.retail.v2alpha.ConversationalSearchRequest.SearchParams search_params = 6 [(.google.api.field_behavior) = OPTIONAL];

    • setSearchParams

      public ConversationalSearchRequest.Builder setSearchParams(ConversationalSearchRequest.SearchParams.Builder builderForValue)
       Optional. Search parameters.
      .google.cloud.retail.v2alpha.ConversationalSearchRequest.SearchParams search_params = 6 [(.google.api.field_behavior) = OPTIONAL];

    • mergeSearchParams

      public ConversationalSearchRequest.Builder mergeSearchParams(ConversationalSearchRequest.SearchParams value)
       Optional. Search parameters.
      .google.cloud.retail.v2alpha.ConversationalSearchRequest.SearchParams search_params = 6 [(.google.api.field_behavior) = OPTIONAL];

    • clearSearchParams

      public ConversationalSearchRequest.Builder clearSearchParams()
       Optional. Search parameters.
      .google.cloud.retail.v2alpha.ConversationalSearchRequest.SearchParams search_params = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getSearchParamsBuilder

      public ConversationalSearchRequest.SearchParams.Builder getSearchParamsBuilder()
       Optional. Search parameters.
      .google.cloud.retail.v2alpha.ConversationalSearchRequest.SearchParams search_params = 6 [(.google.api.field_behavior) = OPTIONAL];

    • getSearchParamsOrBuilder

      public ConversationalSearchRequest.SearchParamsOrBuilder getSearchParamsOrBuilder()
       Optional. Search parameters.
      .google.cloud.retail.v2alpha.ConversationalSearchRequest.SearchParams search_params = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSearchParamsOrBuilder in interface ConversationalSearchRequestOrBuilder

    • getVisitorId

      public String getVisitorId()
       Required. 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 should be the same identifier as
 [UserEvent.visitor_id][google.cloud.retail.v2alpha.UserEvent.visitor_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 visitor_id = 9 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getVisitorId in interface ConversationalSearchRequestOrBuilder
      Returns:
      The visitorId.

    • getVisitorIdBytes

      public com.google.protobuf.ByteString getVisitorIdBytes()
       Required. 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 should be the same identifier as
 [UserEvent.visitor_id][google.cloud.retail.v2alpha.UserEvent.visitor_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 visitor_id = 9 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getVisitorIdBytes in interface ConversationalSearchRequestOrBuilder
      Returns:
      The bytes for visitorId.

    • setVisitorId

      public ConversationalSearchRequest.Builder setVisitorId(String value)
       Required. 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 should be the same identifier as
 [UserEvent.visitor_id][google.cloud.retail.v2alpha.UserEvent.visitor_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 visitor_id = 9 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The visitorId to set.
      Returns:
      This builder for chaining.

    • clearVisitorId

      public ConversationalSearchRequest.Builder clearVisitorId()
       Required. 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 should be the same identifier as
 [UserEvent.visitor_id][google.cloud.retail.v2alpha.UserEvent.visitor_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 visitor_id = 9 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setVisitorIdBytes

      public ConversationalSearchRequest.Builder setVisitorIdBytes(com.google.protobuf.ByteString value)
       Required. 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 should be the same identifier as
 [UserEvent.visitor_id][google.cloud.retail.v2alpha.UserEvent.visitor_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 visitor_id = 9 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for visitorId to set.
      Returns:
      This builder for chaining.

    • hasUserInfo

      public boolean hasUserInfo()
       Optional. User information.
      .google.cloud.retail.v2alpha.UserInfo user_info = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasUserInfo in interface ConversationalSearchRequestOrBuilder
      Returns:
      Whether the userInfo field is set.

    • getUserInfo

      public UserInfo getUserInfo()
       Optional. User information.
      .google.cloud.retail.v2alpha.UserInfo user_info = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getUserInfo in interface ConversationalSearchRequestOrBuilder
      Returns:
      The userInfo.

    • setUserInfo

      public ConversationalSearchRequest.Builder setUserInfo(UserInfo value)
       Optional. User information.
      .google.cloud.retail.v2alpha.UserInfo user_info = 7 [(.google.api.field_behavior) = OPTIONAL];

    • setUserInfo

      public ConversationalSearchRequest.Builder setUserInfo(UserInfo.Builder builderForValue)
       Optional. User information.
      .google.cloud.retail.v2alpha.UserInfo user_info = 7 [(.google.api.field_behavior) = OPTIONAL];

    • mergeUserInfo

      public ConversationalSearchRequest.Builder mergeUserInfo(UserInfo value)
       Optional. User information.
      .google.cloud.retail.v2alpha.UserInfo user_info = 7 [(.google.api.field_behavior) = OPTIONAL];

    • clearUserInfo

      public ConversationalSearchRequest.Builder clearUserInfo()
       Optional. User information.
      .google.cloud.retail.v2alpha.UserInfo user_info = 7 [(.google.api.field_behavior) = OPTIONAL];

    • getUserInfoBuilder

      public UserInfo.Builder getUserInfoBuilder()
       Optional. User information.
      .google.cloud.retail.v2alpha.UserInfo user_info = 7 [(.google.api.field_behavior) = OPTIONAL];

    • getUserInfoOrBuilder

      public UserInfoOrBuilder getUserInfoOrBuilder()
       Optional. User information.
      .google.cloud.retail.v2alpha.UserInfo user_info = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getUserInfoOrBuilder in interface ConversationalSearchRequestOrBuilder

    • hasConversationalFilteringSpec

      public boolean hasConversationalFilteringSpec()
       Optional. This field specifies all conversational filtering related
 parameters.
      .google.cloud.retail.v2alpha.ConversationalSearchRequest.ConversationalFilteringSpec conversational_filtering_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasConversationalFilteringSpec in interface ConversationalSearchRequestOrBuilder
      Returns:
      Whether the conversationalFilteringSpec field is set.

    • getConversationalFilteringSpec

      public ConversationalSearchRequest.ConversationalFilteringSpec getConversationalFilteringSpec()
       Optional. This field specifies all conversational filtering related
 parameters.
      .google.cloud.retail.v2alpha.ConversationalSearchRequest.ConversationalFilteringSpec conversational_filtering_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getConversationalFilteringSpec in interface ConversationalSearchRequestOrBuilder
      Returns:
      The conversationalFilteringSpec.

    • setConversationalFilteringSpec

      public ConversationalSearchRequest.Builder setConversationalFilteringSpec(ConversationalSearchRequest.ConversationalFilteringSpec value)
       Optional. This field specifies all conversational filtering related
 parameters.
      .google.cloud.retail.v2alpha.ConversationalSearchRequest.ConversationalFilteringSpec conversational_filtering_spec = 8 [(.google.api.field_behavior) = OPTIONAL];

    • setConversationalFilteringSpec

      public ConversationalSearchRequest.Builder setConversationalFilteringSpec(ConversationalSearchRequest.ConversationalFilteringSpec.Builder builderForValue)
       Optional. This field specifies all conversational filtering related
 parameters.
      .google.cloud.retail.v2alpha.ConversationalSearchRequest.ConversationalFilteringSpec conversational_filtering_spec = 8 [(.google.api.field_behavior) = OPTIONAL];

    • mergeConversationalFilteringSpec

      public ConversationalSearchRequest.Builder mergeConversationalFilteringSpec(ConversationalSearchRequest.ConversationalFilteringSpec value)
       Optional. This field specifies all conversational filtering related
 parameters.
      .google.cloud.retail.v2alpha.ConversationalSearchRequest.ConversationalFilteringSpec conversational_filtering_spec = 8 [(.google.api.field_behavior) = OPTIONAL];

    • clearConversationalFilteringSpec

      public ConversationalSearchRequest.Builder clearConversationalFilteringSpec()
       Optional. This field specifies all conversational filtering related
 parameters.
      .google.cloud.retail.v2alpha.ConversationalSearchRequest.ConversationalFilteringSpec conversational_filtering_spec = 8 [(.google.api.field_behavior) = OPTIONAL];

    • getConversationalFilteringSpecBuilder

      public ConversationalSearchRequest.ConversationalFilteringSpec.Builder getConversationalFilteringSpecBuilder()
       Optional. This field specifies all conversational filtering related
 parameters.
      .google.cloud.retail.v2alpha.ConversationalSearchRequest.ConversationalFilteringSpec conversational_filtering_spec = 8 [(.google.api.field_behavior) = OPTIONAL];

    • getConversationalFilteringSpecOrBuilder

      public ConversationalSearchRequest.ConversationalFilteringSpecOrBuilder getConversationalFilteringSpecOrBuilder()
       Optional. This field specifies all conversational filtering related
 parameters.
      .google.cloud.retail.v2alpha.ConversationalSearchRequest.ConversationalFilteringSpec conversational_filtering_spec = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getConversationalFilteringSpecOrBuilder in interface ConversationalSearchRequestOrBuilder

    • getUserLabelsCount

      public int getUserLabelsCount()
      Description copied from interface: ConversationalSearchRequestOrBuilder
       Optional. 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 = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getUserLabelsCount in interface ConversationalSearchRequestOrBuilder

    • containsUserLabels

      public boolean containsUserLabels(String key)
       Optional. 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 = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsUserLabels in interface ConversationalSearchRequestOrBuilder

    • getUserLabels

      @Deprecated public Map<String,String> getUserLabels()
      Deprecated.
      Use getUserLabelsMap() instead.
      Specified by:
      getUserLabels in interface ConversationalSearchRequestOrBuilder

    • getUserLabelsMap

      public Map<String,String> getUserLabelsMap()
       Optional. 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 = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getUserLabelsMap in interface ConversationalSearchRequestOrBuilder

    • getUserLabelsOrDefault

      public String getUserLabelsOrDefault(String key, String defaultValue)
       Optional. 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 = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getUserLabelsOrDefault in interface ConversationalSearchRequestOrBuilder

    • getUserLabelsOrThrow

      public String getUserLabelsOrThrow(String key)
       Optional. 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 = 12 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getUserLabelsOrThrow in interface ConversationalSearchRequestOrBuilder

    • clearUserLabels

      public ConversationalSearchRequest.Builder clearUserLabels()

    • removeUserLabels

      public ConversationalSearchRequest.Builder removeUserLabels(String key)
       Optional. 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 = 12 [(.google.api.field_behavior) = OPTIONAL];

    • getMutableUserLabels

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

    • putUserLabels

      public ConversationalSearchRequest.Builder putUserLabels(String key, String value)
       Optional. 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 = 12 [(.google.api.field_behavior) = OPTIONAL];

    • putAllUserLabels

      public ConversationalSearchRequest.Builder putAllUserLabels(Map<String,String> values)
       Optional. 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 = 12 [(.google.api.field_behavior) = OPTIONAL];

    • getSafetySettingsList

      public List<SafetySetting> getSafetySettingsList()
       Optional. The safety settings to be applied to the generated content.
      repeated .google.cloud.retail.v2alpha.SafetySetting safety_settings = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSafetySettingsList in interface ConversationalSearchRequestOrBuilder

    • getSafetySettingsCount

      public int getSafetySettingsCount()
       Optional. The safety settings to be applied to the generated content.
      repeated .google.cloud.retail.v2alpha.SafetySetting safety_settings = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSafetySettingsCount in interface ConversationalSearchRequestOrBuilder

    • getSafetySettings

      public SafetySetting getSafetySettings(int index)
       Optional. The safety settings to be applied to the generated content.
      repeated .google.cloud.retail.v2alpha.SafetySetting safety_settings = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSafetySettings in interface ConversationalSearchRequestOrBuilder

    • setSafetySettings

      public ConversationalSearchRequest.Builder setSafetySettings(int index, SafetySetting value)
       Optional. The safety settings to be applied to the generated content.
      repeated .google.cloud.retail.v2alpha.SafetySetting safety_settings = 14 [(.google.api.field_behavior) = OPTIONAL];

    • setSafetySettings

      public ConversationalSearchRequest.Builder setSafetySettings(int index, SafetySetting.Builder builderForValue)
       Optional. The safety settings to be applied to the generated content.
      repeated .google.cloud.retail.v2alpha.SafetySetting safety_settings = 14 [(.google.api.field_behavior) = OPTIONAL];

    • addSafetySettings

      public ConversationalSearchRequest.Builder addSafetySettings(SafetySetting value)
       Optional. The safety settings to be applied to the generated content.
      repeated .google.cloud.retail.v2alpha.SafetySetting safety_settings = 14 [(.google.api.field_behavior) = OPTIONAL];

    • addSafetySettings

      public ConversationalSearchRequest.Builder addSafetySettings(int index, SafetySetting value)
       Optional. The safety settings to be applied to the generated content.
      repeated .google.cloud.retail.v2alpha.SafetySetting safety_settings = 14 [(.google.api.field_behavior) = OPTIONAL];

    • addSafetySettings

      public ConversationalSearchRequest.Builder addSafetySettings(SafetySetting.Builder builderForValue)
       Optional. The safety settings to be applied to the generated content.
      repeated .google.cloud.retail.v2alpha.SafetySetting safety_settings = 14 [(.google.api.field_behavior) = OPTIONAL];

    • addSafetySettings

      public ConversationalSearchRequest.Builder addSafetySettings(int index, SafetySetting.Builder builderForValue)
       Optional. The safety settings to be applied to the generated content.
      repeated .google.cloud.retail.v2alpha.SafetySetting safety_settings = 14 [(.google.api.field_behavior) = OPTIONAL];

    • addAllSafetySettings

      public ConversationalSearchRequest.Builder addAllSafetySettings(Iterable<? extends SafetySetting> values)
       Optional. The safety settings to be applied to the generated content.
      repeated .google.cloud.retail.v2alpha.SafetySetting safety_settings = 14 [(.google.api.field_behavior) = OPTIONAL];

    • clearSafetySettings

      public ConversationalSearchRequest.Builder clearSafetySettings()
       Optional. The safety settings to be applied to the generated content.
      repeated .google.cloud.retail.v2alpha.SafetySetting safety_settings = 14 [(.google.api.field_behavior) = OPTIONAL];

    • removeSafetySettings

      public ConversationalSearchRequest.Builder removeSafetySettings(int index)
       Optional. The safety settings to be applied to the generated content.
      repeated .google.cloud.retail.v2alpha.SafetySetting safety_settings = 14 [(.google.api.field_behavior) = OPTIONAL];

    • getSafetySettingsBuilder

      public SafetySetting.Builder getSafetySettingsBuilder(int index)
       Optional. The safety settings to be applied to the generated content.
      repeated .google.cloud.retail.v2alpha.SafetySetting safety_settings = 14 [(.google.api.field_behavior) = OPTIONAL];

    • getSafetySettingsOrBuilder

      public SafetySettingOrBuilder getSafetySettingsOrBuilder(int index)
       Optional. The safety settings to be applied to the generated content.
      repeated .google.cloud.retail.v2alpha.SafetySetting safety_settings = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSafetySettingsOrBuilder in interface ConversationalSearchRequestOrBuilder

    • getSafetySettingsOrBuilderList

      public List<? extends SafetySettingOrBuilder> getSafetySettingsOrBuilderList()
       Optional. The safety settings to be applied to the generated content.
      repeated .google.cloud.retail.v2alpha.SafetySetting safety_settings = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSafetySettingsOrBuilderList in interface ConversationalSearchRequestOrBuilder

    • addSafetySettingsBuilder

      public SafetySetting.Builder addSafetySettingsBuilder()
       Optional. The safety settings to be applied to the generated content.
      repeated .google.cloud.retail.v2alpha.SafetySetting safety_settings = 14 [(.google.api.field_behavior) = OPTIONAL];

    • addSafetySettingsBuilder

      public SafetySetting.Builder addSafetySettingsBuilder(int index)
       Optional. The safety settings to be applied to the generated content.
      repeated .google.cloud.retail.v2alpha.SafetySetting safety_settings = 14 [(.google.api.field_behavior) = OPTIONAL];

    • getSafetySettingsBuilderList

      public List<SafetySetting.Builder> getSafetySettingsBuilderList()
       Optional. The safety settings to be applied to the generated content.
      repeated .google.cloud.retail.v2alpha.SafetySetting safety_settings = 14 [(.google.api.field_behavior) = OPTIONAL];