Interface RemoveSuggestionRequestOrBuilder (0.90.0)

0.90.0 (latest) 0.89.0 0.87.0 0.84.0 0.83.0 0.81.0 0.79.0 0.78.0 0.77.0 0.76.0 0.74.0 0.72.0 0.71.0 0.70.0 0.69.0 0.68.0 0.66.0 0.64.0 0.63.0 0.60.0 0.59.0 0.58.0 0.56.0 0.55.0 0.54.0 0.53.0 0.52.0 0.51.0 0.50.0 0.49.0 0.48.0 0.47.0 0.45.0 0.44.0 0.43.0 0.42.0 0.41.0 0.40.0 0.39.0 0.38.0 0.37.0 0.36.0 0.35.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.0 0.25.0 0.24.0 0.23.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

public interface RemoveSuggestionRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCompletionConfig()

public abstract String getCompletionConfig()

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.

string completion_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The completionConfig.

getCompletionConfigBytes()

public abstract ByteString getCompletionConfigBytes()

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.

string completion_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for completionConfig.

getRemoveAllSearchHistorySuggestions()

public abstract boolean getRemoveAllSearchHistorySuggestions()

Remove all search history suggestions for the user.

bool remove_all_search_history_suggestions = 6;

Returns
Type	Description
boolean	The removeAllSearchHistorySuggestions.

getRemoveTime()

public abstract Timestamp getRemoveTime()

Required. Time at which the suggestion was removed. If not set, the current time will be used.

.google.protobuf.Timestamp remove_time = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Timestamp	The removeTime.

getRemoveTimeOrBuilder()

public abstract TimestampOrBuilder getRemoveTimeOrBuilder()

Required. Time at which the suggestion was removed. If not set, the current time will be used.

.google.protobuf.Timestamp remove_time = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
TimestampOrBuilder

getSearchHistorySuggestion()

public abstract String getSearchHistorySuggestion()

The search history suggestion to be removed.

string search_history_suggestion = 2;

Returns
Type	Description
String	The searchHistorySuggestion.

getSearchHistorySuggestionBytes()

public abstract ByteString getSearchHistorySuggestionBytes()

The search history suggestion to be removed.

string search_history_suggestion = 2;

Returns
Type	Description
ByteString	The bytes for searchHistorySuggestion.

getSuggestionCase()

public abstract RemoveSuggestionRequest.SuggestionCase getSuggestionCase()

Returns
Type	Description
RemoveSuggestionRequest.SuggestionCase

getUserInfo()

public abstract UserInfo getUserInfo()

Optional. Information about the end user.

This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info.

.google.cloud.discoveryengine.v1beta.UserInfo user_info = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
UserInfo	The userInfo.

getUserInfoOrBuilder()

public abstract UserInfoOrBuilder getUserInfoOrBuilder()

Optional. Information about the end user.

This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info.

.google.cloud.discoveryengine.v1beta.UserInfo user_info = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
UserInfoOrBuilder

getUserPseudoId()

public abstract String getUserPseudoId()

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.

string user_pseudo_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The userPseudoId.

getUserPseudoIdBytes()

public abstract ByteString getUserPseudoIdBytes()

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.

string user_pseudo_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for userPseudoId.

hasRemoveAllSearchHistorySuggestions()

public abstract boolean hasRemoveAllSearchHistorySuggestions()

Remove all search history suggestions for the user.

bool remove_all_search_history_suggestions = 6;

Returns
Type	Description
boolean	Whether the removeAllSearchHistorySuggestions field is set.

hasRemoveTime()

public abstract boolean hasRemoveTime()

Required. Time at which the suggestion was removed. If not set, the current time will be used.

.google.protobuf.Timestamp remove_time = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the removeTime field is set.

hasSearchHistorySuggestion()

public abstract boolean hasSearchHistorySuggestion()

The search history suggestion to be removed.

string search_history_suggestion = 2;

Returns
Type	Description
boolean	Whether the searchHistorySuggestion field is set.

hasUserInfo()

public abstract boolean hasUserInfo()

Optional. Information about the end user.

This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info.

.google.cloud.discoveryengine.v1beta.UserInfo user_info = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the userInfo field is set.