Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::RemoveSuggestionRequest (v0.28.0)

Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::RemoveSuggestionRequest.

Request message for CompletionService.RemoveSuggestion method.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#completion_config

def completion_config() -> ::String
Returns
  • (::String) — Required. The completion_config of the parent engine resource name for which the search history suggestion is to be removed, such as projects/*/locations/global/collections/default_collection/engines/*/completionConfig.

#completion_config=

def completion_config=(value) -> ::String
Parameter
  • value (::String) — Required. The completion_config of the parent engine resource name for which the search history suggestion is to be removed, such as projects/*/locations/global/collections/default_collection/engines/*/completionConfig.
Returns
  • (::String) — Required. The completion_config of the parent engine resource name for which the search history suggestion is to be removed, such as projects/*/locations/global/collections/default_collection/engines/*/completionConfig.

#remove_all_search_history_suggestions

def remove_all_search_history_suggestions() -> ::Boolean
Returns
  • (::Boolean) — Remove all search history suggestions for the user.

    Note: The following fields are mutually exclusive: remove_all_search_history_suggestions, search_history_suggestion. If a field in that set is populated, all other fields in the set will automatically be cleared.

#remove_all_search_history_suggestions=

def remove_all_search_history_suggestions=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Remove all search history suggestions for the user.

    Note: The following fields are mutually exclusive: remove_all_search_history_suggestions, search_history_suggestion. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Boolean) — Remove all search history suggestions for the user.

    Note: The following fields are mutually exclusive: remove_all_search_history_suggestions, search_history_suggestion. If a field in that set is populated, all other fields in the set will automatically be cleared.

#remove_time

def remove_time() -> ::Google::Protobuf::Timestamp
Returns

#remove_time=

def remove_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
Returns

#search_history_suggestion

def search_history_suggestion() -> ::String
Returns
  • (::String) — The search history suggestion to be removed.

    Note: The following fields are mutually exclusive: search_history_suggestion, remove_all_search_history_suggestions. If a field in that set is populated, all other fields in the set will automatically be cleared.

#search_history_suggestion=

def search_history_suggestion=(value) -> ::String
Parameter
  • value (::String) — The search history suggestion to be removed.

    Note: The following fields are mutually exclusive: search_history_suggestion, remove_all_search_history_suggestions. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — The search history suggestion to be removed.

    Note: The following fields are mutually exclusive: search_history_suggestion, remove_all_search_history_suggestions. If a field in that set is populated, all other fields in the set will automatically be cleared.

#user_info

def user_info() -> ::Google::Cloud::DiscoveryEngine::V1beta::UserInfo
Returns

#user_info=

def user_info=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::UserInfo
Parameter
Returns

#user_pseudo_id

def user_pseudo_id() -> ::String
Returns
  • (::String) — 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 field should NOT have a fixed value such as unknown_visitor.

    This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id.

    The field must be a UTF-8 encoded string with a length limit of 128.

#user_pseudo_id=

def user_pseudo_id=(value) -> ::String
Parameter
  • value (::String) — 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 field should NOT have a fixed value such as unknown_visitor.

    This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id.

    The field must be a UTF-8 encoded string with a length limit of 128.

Returns
  • (::String) — 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 field should NOT have a fixed value such as unknown_visitor.

    This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id.

    The field must be a UTF-8 encoded string with a length limit of 128.