Package com.google.cloud.discoveryengine.v1beta

Class RecommendRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<RecommendRequest.Builder>
com.google.cloud.discoveryengine.v1beta.RecommendRequest.Builder
All Implemented Interfaces:
RecommendRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
RecommendRequest
public static final class RecommendRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<RecommendRequest.Builder> implements RecommendRequestOrBuilder
 Request message for Recommend method.
Protobuf type google.cloud.discoveryengine.v1beta.RecommendRequest

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

    • internalGetMutableMapFieldReflection

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

    • internalGetFieldAccessorTable

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

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

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

    • mergeFrom

      public RecommendRequest.Builder mergeFrom(RecommendRequest other)

    • isInitialized

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

    • mergeFrom

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

    • getServingConfig

      public String getServingConfig()
       Required. Full resource name of a
 [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig]:
 `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or
 `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`

 One default serving config is created along with your recommendation engine
 creation. The engine ID is used as the ID of the default serving
 config. For example, for Engine
 `projects/*/locations/global/collections/*/engines/my-engine`, you can use
 `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine`
 for your
 [RecommendationService.Recommend][google.cloud.discoveryengine.v1beta.RecommendationService.Recommend]
 requests.
      string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getServingConfig in interface RecommendRequestOrBuilder
      Returns:
      The servingConfig.

    • getServingConfigBytes

      public com.google.protobuf.ByteString getServingConfigBytes()
       Required. Full resource name of a
 [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig]:
 `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or
 `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`

 One default serving config is created along with your recommendation engine
 creation. The engine ID is used as the ID of the default serving
 config. For example, for Engine
 `projects/*/locations/global/collections/*/engines/my-engine`, you can use
 `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine`
 for your
 [RecommendationService.Recommend][google.cloud.discoveryengine.v1beta.RecommendationService.Recommend]
 requests.
      string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getServingConfigBytes in interface RecommendRequestOrBuilder
      Returns:
      The bytes for servingConfig.

    • setServingConfig

      public RecommendRequest.Builder setServingConfig(String value)
       Required. Full resource name of a
 [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig]:
 `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or
 `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`

 One default serving config is created along with your recommendation engine
 creation. The engine ID is used as the ID of the default serving
 config. For example, for Engine
 `projects/*/locations/global/collections/*/engines/my-engine`, you can use
 `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine`
 for your
 [RecommendationService.Recommend][google.cloud.discoveryengine.v1beta.RecommendationService.Recommend]
 requests.
      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 RecommendRequest.Builder clearServingConfig()
       Required. Full resource name of a
 [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig]:
 `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or
 `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`

 One default serving config is created along with your recommendation engine
 creation. The engine ID is used as the ID of the default serving
 config. For example, for Engine
 `projects/*/locations/global/collections/*/engines/my-engine`, you can use
 `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine`
 for your
 [RecommendationService.Recommend][google.cloud.discoveryengine.v1beta.RecommendationService.Recommend]
 requests.
      string serving_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setServingConfigBytes

      public RecommendRequest.Builder setServingConfigBytes(com.google.protobuf.ByteString value)
       Required. Full resource name of a
 [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig]:
 `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or
 `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`

 One default serving config is created along with your recommendation engine
 creation. The engine ID is used as the ID of the default serving
 config. For example, for Engine
 `projects/*/locations/global/collections/*/engines/my-engine`, you can use
 `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine`
 for your
 [RecommendationService.Recommend][google.cloud.discoveryengine.v1beta.RecommendationService.Recommend]
 requests.
      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.

    • hasUserEvent

      public boolean hasUserEvent()
       Required. Context about the user, what they are looking at and what action
 they took to trigger the Recommend request. Note that this user event
 detail won't be ingested to userEvent logs. Thus, a separate userEvent
 write request is required for event logging.

 Don't set
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 or
 [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id]
 to the same fixed ID for different users. If you are trying to receive
 non-personalized recommendations (not recommended; this can negatively
 impact model performance), instead set
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 to a random unique ID and leave
 [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id]
 unset.
      .google.cloud.discoveryengine.v1beta.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasUserEvent in interface RecommendRequestOrBuilder
      Returns:
      Whether the userEvent field is set.

    • getUserEvent

      public UserEvent getUserEvent()
       Required. Context about the user, what they are looking at and what action
 they took to trigger the Recommend request. Note that this user event
 detail won't be ingested to userEvent logs. Thus, a separate userEvent
 write request is required for event logging.

 Don't set
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 or
 [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id]
 to the same fixed ID for different users. If you are trying to receive
 non-personalized recommendations (not recommended; this can negatively
 impact model performance), instead set
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 to a random unique ID and leave
 [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id]
 unset.
      .google.cloud.discoveryengine.v1beta.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getUserEvent in interface RecommendRequestOrBuilder
      Returns:
      The userEvent.

    • setUserEvent

      public RecommendRequest.Builder setUserEvent(UserEvent value)
       Required. Context about the user, what they are looking at and what action
 they took to trigger the Recommend request. Note that this user event
 detail won't be ingested to userEvent logs. Thus, a separate userEvent
 write request is required for event logging.

 Don't set
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 or
 [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id]
 to the same fixed ID for different users. If you are trying to receive
 non-personalized recommendations (not recommended; this can negatively
 impact model performance), instead set
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 to a random unique ID and leave
 [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id]
 unset.
      .google.cloud.discoveryengine.v1beta.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

    • setUserEvent

      public RecommendRequest.Builder setUserEvent(UserEvent.Builder builderForValue)
       Required. Context about the user, what they are looking at and what action
 they took to trigger the Recommend request. Note that this user event
 detail won't be ingested to userEvent logs. Thus, a separate userEvent
 write request is required for event logging.

 Don't set
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 or
 [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id]
 to the same fixed ID for different users. If you are trying to receive
 non-personalized recommendations (not recommended; this can negatively
 impact model performance), instead set
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 to a random unique ID and leave
 [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id]
 unset.
      .google.cloud.discoveryengine.v1beta.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

    • mergeUserEvent

      public RecommendRequest.Builder mergeUserEvent(UserEvent value)
       Required. Context about the user, what they are looking at and what action
 they took to trigger the Recommend request. Note that this user event
 detail won't be ingested to userEvent logs. Thus, a separate userEvent
 write request is required for event logging.

 Don't set
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 or
 [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id]
 to the same fixed ID for different users. If you are trying to receive
 non-personalized recommendations (not recommended; this can negatively
 impact model performance), instead set
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 to a random unique ID and leave
 [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id]
 unset.
      .google.cloud.discoveryengine.v1beta.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

    • clearUserEvent

      public RecommendRequest.Builder clearUserEvent()
       Required. Context about the user, what they are looking at and what action
 they took to trigger the Recommend request. Note that this user event
 detail won't be ingested to userEvent logs. Thus, a separate userEvent
 write request is required for event logging.

 Don't set
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 or
 [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id]
 to the same fixed ID for different users. If you are trying to receive
 non-personalized recommendations (not recommended; this can negatively
 impact model performance), instead set
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 to a random unique ID and leave
 [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id]
 unset.
      .google.cloud.discoveryengine.v1beta.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

    • getUserEventBuilder

      public UserEvent.Builder getUserEventBuilder()
       Required. Context about the user, what they are looking at and what action
 they took to trigger the Recommend request. Note that this user event
 detail won't be ingested to userEvent logs. Thus, a separate userEvent
 write request is required for event logging.

 Don't set
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 or
 [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id]
 to the same fixed ID for different users. If you are trying to receive
 non-personalized recommendations (not recommended; this can negatively
 impact model performance), instead set
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 to a random unique ID and leave
 [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id]
 unset.
      .google.cloud.discoveryengine.v1beta.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

    • getUserEventOrBuilder

      public UserEventOrBuilder getUserEventOrBuilder()
       Required. Context about the user, what they are looking at and what action
 they took to trigger the Recommend request. Note that this user event
 detail won't be ingested to userEvent logs. Thus, a separate userEvent
 write request is required for event logging.

 Don't set
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 or
 [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id]
 to the same fixed ID for different users. If you are trying to receive
 non-personalized recommendations (not recommended; this can negatively
 impact model performance), instead set
 [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id]
 to a random unique ID and leave
 [UserEvent.user_info.user_id][google.cloud.discoveryengine.v1beta.UserInfo.user_id]
 unset.
      .google.cloud.discoveryengine.v1beta.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getUserEventOrBuilder in interface RecommendRequestOrBuilder

    • getPageSize

      public int getPageSize()
       Maximum number of results to return. Set this property
 to the number of recommendation results needed. If zero, the service
 chooses a reasonable default. The maximum allowed value is 100. Values
 above 100 are set to 100.
      int32 page_size = 3;
      Specified by:
      getPageSize in interface RecommendRequestOrBuilder
      Returns:
      The pageSize.

    • setPageSize

      public RecommendRequest.Builder setPageSize(int value)
       Maximum number of results to return. Set this property
 to the number of recommendation results needed. If zero, the service
 chooses a reasonable default. The maximum allowed value is 100. Values
 above 100 are set to 100.
      int32 page_size = 3;
      Parameters:
      value - The pageSize to set.
      Returns:
      This builder for chaining.

    • clearPageSize

      public RecommendRequest.Builder clearPageSize()
       Maximum number of results to return. Set this property
 to the number of recommendation results needed. If zero, the service
 chooses a reasonable default. The maximum allowed value is 100. Values
 above 100 are set to 100.
      int32 page_size = 3;
      Returns:
      This builder for chaining.

    • getFilter

      public String getFilter()
       Filter for restricting recommendation results with a length limit of 5,000
 characters. Currently, only filter expressions on the `filter_tags`
 attribute is supported.


 Examples:

 * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))`
 * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))`

 If `attributeFilteringSyntax` is set to true under the `params` field, then
 attribute-based expressions are expected instead of the above described
 tag-based syntax. Examples:

 * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie"))
 * (available: true) AND
 (launguage: ANY("en", "es")) OR (categories: ANY("Movie"))

 If your filter blocks all results, the API returns generic
 (unfiltered) popular Documents. If you only want results strictly matching
 the filters, set `strictFiltering` to `true` in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params]
 to receive empty results instead.

 Note that the API never returns
 [Document][google.cloud.discoveryengine.v1beta.Document]s with
 `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.
      string filter = 4;
      Specified by:
      getFilter in interface RecommendRequestOrBuilder
      Returns:
      The filter.

    • getFilterBytes

      public com.google.protobuf.ByteString getFilterBytes()
       Filter for restricting recommendation results with a length limit of 5,000
 characters. Currently, only filter expressions on the `filter_tags`
 attribute is supported.


 Examples:

 * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))`
 * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))`

 If `attributeFilteringSyntax` is set to true under the `params` field, then
 attribute-based expressions are expected instead of the above described
 tag-based syntax. Examples:

 * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie"))
 * (available: true) AND
 (launguage: ANY("en", "es")) OR (categories: ANY("Movie"))

 If your filter blocks all results, the API returns generic
 (unfiltered) popular Documents. If you only want results strictly matching
 the filters, set `strictFiltering` to `true` in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params]
 to receive empty results instead.

 Note that the API never returns
 [Document][google.cloud.discoveryengine.v1beta.Document]s with
 `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.
      string filter = 4;
      Specified by:
      getFilterBytes in interface RecommendRequestOrBuilder
      Returns:
      The bytes for filter.

    • setFilter

      public RecommendRequest.Builder setFilter(String value)
       Filter for restricting recommendation results with a length limit of 5,000
 characters. Currently, only filter expressions on the `filter_tags`
 attribute is supported.


 Examples:

 * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))`
 * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))`

 If `attributeFilteringSyntax` is set to true under the `params` field, then
 attribute-based expressions are expected instead of the above described
 tag-based syntax. Examples:

 * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie"))
 * (available: true) AND
 (launguage: ANY("en", "es")) OR (categories: ANY("Movie"))

 If your filter blocks all results, the API returns generic
 (unfiltered) popular Documents. If you only want results strictly matching
 the filters, set `strictFiltering` to `true` in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params]
 to receive empty results instead.

 Note that the API never returns
 [Document][google.cloud.discoveryengine.v1beta.Document]s with
 `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.
      string filter = 4;
      Parameters:
      value - The filter to set.
      Returns:
      This builder for chaining.

    • clearFilter

      public RecommendRequest.Builder clearFilter()
       Filter for restricting recommendation results with a length limit of 5,000
 characters. Currently, only filter expressions on the `filter_tags`
 attribute is supported.


 Examples:

 * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))`
 * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))`

 If `attributeFilteringSyntax` is set to true under the `params` field, then
 attribute-based expressions are expected instead of the above described
 tag-based syntax. Examples:

 * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie"))
 * (available: true) AND
 (launguage: ANY("en", "es")) OR (categories: ANY("Movie"))

 If your filter blocks all results, the API returns generic
 (unfiltered) popular Documents. If you only want results strictly matching
 the filters, set `strictFiltering` to `true` in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params]
 to receive empty results instead.

 Note that the API never returns
 [Document][google.cloud.discoveryengine.v1beta.Document]s with
 `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.
      string filter = 4;
      Returns:
      This builder for chaining.

    • setFilterBytes

      public RecommendRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)
       Filter for restricting recommendation results with a length limit of 5,000
 characters. Currently, only filter expressions on the `filter_tags`
 attribute is supported.


 Examples:

 * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))`
 * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))`

 If `attributeFilteringSyntax` is set to true under the `params` field, then
 attribute-based expressions are expected instead of the above described
 tag-based syntax. Examples:

 * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie"))
 * (available: true) AND
 (launguage: ANY("en", "es")) OR (categories: ANY("Movie"))

 If your filter blocks all results, the API returns generic
 (unfiltered) popular Documents. If you only want results strictly matching
 the filters, set `strictFiltering` to `true` in
 [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params]
 to receive empty results instead.

 Note that the API never returns
 [Document][google.cloud.discoveryengine.v1beta.Document]s with
 `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.
      string filter = 4;
      Parameters:
      value - The bytes for filter to set.
      Returns:
      This builder for chaining.

    • getValidateOnly

      public boolean getValidateOnly()
       Use validate only mode for this recommendation query. If set to `true`, a
 fake model is used that returns arbitrary Document IDs.
 Note that the validate only mode should only be used for testing the API,
 or if the model is not ready.
      bool validate_only = 5;
      Specified by:
      getValidateOnly in interface RecommendRequestOrBuilder
      Returns:
      The validateOnly.

    • setValidateOnly

      public RecommendRequest.Builder setValidateOnly(boolean value)
       Use validate only mode for this recommendation query. If set to `true`, a
 fake model is used that returns arbitrary Document IDs.
 Note that the validate only mode should only be used for testing the API,
 or if the model is not ready.
      bool validate_only = 5;
      Parameters:
      value - The validateOnly to set.
      Returns:
      This builder for chaining.

    • clearValidateOnly

      public RecommendRequest.Builder clearValidateOnly()
       Use validate only mode for this recommendation query. If set to `true`, a
 fake model is used that returns arbitrary Document IDs.
 Note that the validate only mode should only be used for testing the API,
 or if the model is not ready.
      bool validate_only = 5;
      Returns:
      This builder for chaining.

    • getParamsCount

      public int getParamsCount()
      Description copied from interface: RecommendRequestOrBuilder
       Additional domain specific parameters for the recommendations.

 Allowed values:

 * `returnDocument`: Boolean. If set to `true`, the associated Document
 object is returned in
 [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document].
 * `returnScore`: Boolean. If set to true, the recommendation score
 corresponding to each returned Document is set in
 [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata].
 The given score indicates the probability of a Document conversion given
 the user's context and history.
 * `strictFiltering`: Boolean. True by default. If set to `false`, the
 service
 returns generic (unfiltered) popular Documents instead of empty if
 your filter blocks all recommendation results.
 * `diversityLevel`: String. Default empty. If set to be non-empty, then
 it needs to be one of:
 *  `no-diversity`
 *  `low-diversity`
 *  `medium-diversity`
 *  `high-diversity`
 *  `auto-diversity`
 This gives request-level control and adjusts recommendation results
 based on Document category.
 * `attributeFilteringSyntax`: Boolean. False by default. If set to true,
 the `filter` field is interpreted according to the new,
 attribute-based syntax.
      map<string, .google.protobuf.Value> params = 6;
      Specified by:
      getParamsCount in interface RecommendRequestOrBuilder

    • containsParams

      public boolean containsParams(String key)
       Additional domain specific parameters for the recommendations.

 Allowed values:

 * `returnDocument`: Boolean. If set to `true`, the associated Document
 object is returned in
 [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document].
 * `returnScore`: Boolean. If set to true, the recommendation score
 corresponding to each returned Document is set in
 [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata].
 The given score indicates the probability of a Document conversion given
 the user's context and history.
 * `strictFiltering`: Boolean. True by default. If set to `false`, the
 service
 returns generic (unfiltered) popular Documents instead of empty if
 your filter blocks all recommendation results.
 * `diversityLevel`: String. Default empty. If set to be non-empty, then
 it needs to be one of:
 *  `no-diversity`
 *  `low-diversity`
 *  `medium-diversity`
 *  `high-diversity`
 *  `auto-diversity`
 This gives request-level control and adjusts recommendation results
 based on Document category.
 * `attributeFilteringSyntax`: Boolean. False by default. If set to true,
 the `filter` field is interpreted according to the new,
 attribute-based syntax.
      map<string, .google.protobuf.Value> params = 6;
      Specified by:
      containsParams in interface RecommendRequestOrBuilder

    • getParams

      @Deprecated public Map<String,com.google.protobuf.Value> getParams()
      Deprecated.
      Use getParamsMap() instead.
      Specified by:
      getParams in interface RecommendRequestOrBuilder

    • getParamsMap

      public Map<String,com.google.protobuf.Value> getParamsMap()
       Additional domain specific parameters for the recommendations.

 Allowed values:

 * `returnDocument`: Boolean. If set to `true`, the associated Document
 object is returned in
 [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document].
 * `returnScore`: Boolean. If set to true, the recommendation score
 corresponding to each returned Document is set in
 [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata].
 The given score indicates the probability of a Document conversion given
 the user's context and history.
 * `strictFiltering`: Boolean. True by default. If set to `false`, the
 service
 returns generic (unfiltered) popular Documents instead of empty if
 your filter blocks all recommendation results.
 * `diversityLevel`: String. Default empty. If set to be non-empty, then
 it needs to be one of:
 *  `no-diversity`
 *  `low-diversity`
 *  `medium-diversity`
 *  `high-diversity`
 *  `auto-diversity`
 This gives request-level control and adjusts recommendation results
 based on Document category.
 * `attributeFilteringSyntax`: Boolean. False by default. If set to true,
 the `filter` field is interpreted according to the new,
 attribute-based syntax.
      map<string, .google.protobuf.Value> params = 6;
      Specified by:
      getParamsMap in interface RecommendRequestOrBuilder

    • getParamsOrDefault

      public com.google.protobuf.Value getParamsOrDefault(String key, com.google.protobuf.Value defaultValue)
       Additional domain specific parameters for the recommendations.

 Allowed values:

 * `returnDocument`: Boolean. If set to `true`, the associated Document
 object is returned in
 [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document].
 * `returnScore`: Boolean. If set to true, the recommendation score
 corresponding to each returned Document is set in
 [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata].
 The given score indicates the probability of a Document conversion given
 the user's context and history.
 * `strictFiltering`: Boolean. True by default. If set to `false`, the
 service
 returns generic (unfiltered) popular Documents instead of empty if
 your filter blocks all recommendation results.
 * `diversityLevel`: String. Default empty. If set to be non-empty, then
 it needs to be one of:
 *  `no-diversity`
 *  `low-diversity`
 *  `medium-diversity`
 *  `high-diversity`
 *  `auto-diversity`
 This gives request-level control and adjusts recommendation results
 based on Document category.
 * `attributeFilteringSyntax`: Boolean. False by default. If set to true,
 the `filter` field is interpreted according to the new,
 attribute-based syntax.
      map<string, .google.protobuf.Value> params = 6;
      Specified by:
      getParamsOrDefault in interface RecommendRequestOrBuilder

    • getParamsOrThrow

      public com.google.protobuf.Value getParamsOrThrow(String key)
       Additional domain specific parameters for the recommendations.

 Allowed values:

 * `returnDocument`: Boolean. If set to `true`, the associated Document
 object is returned in
 [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document].
 * `returnScore`: Boolean. If set to true, the recommendation score
 corresponding to each returned Document is set in
 [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata].
 The given score indicates the probability of a Document conversion given
 the user's context and history.
 * `strictFiltering`: Boolean. True by default. If set to `false`, the
 service
 returns generic (unfiltered) popular Documents instead of empty if
 your filter blocks all recommendation results.
 * `diversityLevel`: String. Default empty. If set to be non-empty, then
 it needs to be one of:
 *  `no-diversity`
 *  `low-diversity`
 *  `medium-diversity`
 *  `high-diversity`
 *  `auto-diversity`
 This gives request-level control and adjusts recommendation results
 based on Document category.
 * `attributeFilteringSyntax`: Boolean. False by default. If set to true,
 the `filter` field is interpreted according to the new,
 attribute-based syntax.
      map<string, .google.protobuf.Value> params = 6;
      Specified by:
      getParamsOrThrow in interface RecommendRequestOrBuilder

    • clearParams

      public RecommendRequest.Builder clearParams()

    • removeParams

      public RecommendRequest.Builder removeParams(String key)
       Additional domain specific parameters for the recommendations.

 Allowed values:

 * `returnDocument`: Boolean. If set to `true`, the associated Document
 object is returned in
 [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document].
 * `returnScore`: Boolean. If set to true, the recommendation score
 corresponding to each returned Document is set in
 [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata].
 The given score indicates the probability of a Document conversion given
 the user's context and history.
 * `strictFiltering`: Boolean. True by default. If set to `false`, the
 service
 returns generic (unfiltered) popular Documents instead of empty if
 your filter blocks all recommendation results.
 * `diversityLevel`: String. Default empty. If set to be non-empty, then
 it needs to be one of:
 *  `no-diversity`
 *  `low-diversity`
 *  `medium-diversity`
 *  `high-diversity`
 *  `auto-diversity`
 This gives request-level control and adjusts recommendation results
 based on Document category.
 * `attributeFilteringSyntax`: Boolean. False by default. If set to true,
 the `filter` field is interpreted according to the new,
 attribute-based syntax.
      map<string, .google.protobuf.Value> params = 6;

    • getMutableParams

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

    • putParams

      public RecommendRequest.Builder putParams(String key, com.google.protobuf.Value value)
       Additional domain specific parameters for the recommendations.

 Allowed values:

 * `returnDocument`: Boolean. If set to `true`, the associated Document
 object is returned in
 [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document].
 * `returnScore`: Boolean. If set to true, the recommendation score
 corresponding to each returned Document is set in
 [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata].
 The given score indicates the probability of a Document conversion given
 the user's context and history.
 * `strictFiltering`: Boolean. True by default. If set to `false`, the
 service
 returns generic (unfiltered) popular Documents instead of empty if
 your filter blocks all recommendation results.
 * `diversityLevel`: String. Default empty. If set to be non-empty, then
 it needs to be one of:
 *  `no-diversity`
 *  `low-diversity`
 *  `medium-diversity`
 *  `high-diversity`
 *  `auto-diversity`
 This gives request-level control and adjusts recommendation results
 based on Document category.
 * `attributeFilteringSyntax`: Boolean. False by default. If set to true,
 the `filter` field is interpreted according to the new,
 attribute-based syntax.
      map<string, .google.protobuf.Value> params = 6;

    • putAllParams

      public RecommendRequest.Builder putAllParams(Map<String,com.google.protobuf.Value> values)
       Additional domain specific parameters for the recommendations.

 Allowed values:

 * `returnDocument`: Boolean. If set to `true`, the associated Document
 object is returned in
 [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document].
 * `returnScore`: Boolean. If set to true, the recommendation score
 corresponding to each returned Document is set in
 [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata].
 The given score indicates the probability of a Document conversion given
 the user's context and history.
 * `strictFiltering`: Boolean. True by default. If set to `false`, the
 service
 returns generic (unfiltered) popular Documents instead of empty if
 your filter blocks all recommendation results.
 * `diversityLevel`: String. Default empty. If set to be non-empty, then
 it needs to be one of:
 *  `no-diversity`
 *  `low-diversity`
 *  `medium-diversity`
 *  `high-diversity`
 *  `auto-diversity`
 This gives request-level control and adjusts recommendation results
 based on Document category.
 * `attributeFilteringSyntax`: Boolean. False by default. If set to true,
 the `filter` field is interpreted according to the new,
 attribute-based syntax.
      map<string, .google.protobuf.Value> params = 6;

    • putParamsBuilderIfAbsent

      public com.google.protobuf.Value.Builder putParamsBuilderIfAbsent(String key)
       Additional domain specific parameters for the recommendations.

 Allowed values:

 * `returnDocument`: Boolean. If set to `true`, the associated Document
 object is returned in
 [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document].
 * `returnScore`: Boolean. If set to true, the recommendation score
 corresponding to each returned Document is set in
 [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata].
 The given score indicates the probability of a Document conversion given
 the user's context and history.
 * `strictFiltering`: Boolean. True by default. If set to `false`, the
 service
 returns generic (unfiltered) popular Documents instead of empty if
 your filter blocks all recommendation results.
 * `diversityLevel`: String. Default empty. If set to be non-empty, then
 it needs to be one of:
 *  `no-diversity`
 *  `low-diversity`
 *  `medium-diversity`
 *  `high-diversity`
 *  `auto-diversity`
 This gives request-level control and adjusts recommendation results
 based on Document category.
 * `attributeFilteringSyntax`: Boolean. False by default. If set to true,
 the `filter` field is interpreted according to the new,
 attribute-based syntax.
      map<string, .google.protobuf.Value> params = 6;

    • getUserLabelsCount

      public int getUserLabelsCount()
      Description copied from interface: RecommendRequestOrBuilder
       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 [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 8;
      Specified by:
      getUserLabelsCount in interface RecommendRequestOrBuilder

    • 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 [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 8;
      Specified by:
      containsUserLabels in interface RecommendRequestOrBuilder

    • getUserLabels

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

    • 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 [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 8;
      Specified by:
      getUserLabelsMap in interface RecommendRequestOrBuilder

    • 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 [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 8;
      Specified by:
      getUserLabelsOrDefault in interface RecommendRequestOrBuilder

    • 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 [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 8;
      Specified by:
      getUserLabelsOrThrow in interface RecommendRequestOrBuilder

    • clearUserLabels

      public RecommendRequest.Builder clearUserLabels()

    • removeUserLabels

      public RecommendRequest.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 [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 8;

    • getMutableUserLabels

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

    • putUserLabels

      public RecommendRequest.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 [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 8;

    • putAllUserLabels

      public RecommendRequest.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 [Requirements for
 labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
      map<string, string> user_labels = 8;