Class RemoveSuggestionRequest.Builder (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 static final class RemoveSuggestionRequest.Builder extends GeneratedMessage.Builder<RemoveSuggestionRequest.Builder> implements RemoveSuggestionRequestOrBuilder

Request message for CompletionService.RemoveSuggestion method.

Protobuf type google.cloud.discoveryengine.v1beta.RemoveSuggestionRequest

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > RemoveSuggestionRequest.Builder

Implements

RemoveSuggestionRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

build()

public RemoveSuggestionRequest build()

Returns
Type	Description
RemoveSuggestionRequest

buildPartial()

public RemoveSuggestionRequest buildPartial()

Returns
Type	Description
RemoveSuggestionRequest

clear()

public RemoveSuggestionRequest.Builder clear()

Returns
Type	Description
RemoveSuggestionRequest.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearCompletionConfig()

public RemoveSuggestionRequest.Builder clearCompletionConfig()

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
RemoveSuggestionRequest.Builder	This builder for chaining.

clearRemoveAllSearchHistorySuggestions()

public RemoveSuggestionRequest.Builder clearRemoveAllSearchHistorySuggestions()

Remove all search history suggestions for the user.

bool remove_all_search_history_suggestions = 6;

Returns
Type	Description
RemoveSuggestionRequest.Builder	This builder for chaining.

clearRemoveTime()

public RemoveSuggestionRequest.Builder clearRemoveTime()

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
RemoveSuggestionRequest.Builder

clearSearchHistorySuggestion()

public RemoveSuggestionRequest.Builder clearSearchHistorySuggestion()

The search history suggestion to be removed.

string search_history_suggestion = 2;

Returns
Type	Description
RemoveSuggestionRequest.Builder	This builder for chaining.

clearSuggestion()

public RemoveSuggestionRequest.Builder clearSuggestion()

Returns
Type	Description
RemoveSuggestionRequest.Builder

clearUserInfo()

public RemoveSuggestionRequest.Builder clearUserInfo()

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
RemoveSuggestionRequest.Builder

clearUserPseudoId()

public RemoveSuggestionRequest.Builder clearUserPseudoId()

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
RemoveSuggestionRequest.Builder	This builder for chaining.

getCompletionConfig()

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

getDefaultInstanceForType()

public RemoveSuggestionRequest getDefaultInstanceForType()

Returns
Type	Description
RemoveSuggestionRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getRemoveAllSearchHistorySuggestions()

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

getRemoveTimeBuilder()

public Timestamp.Builder getRemoveTimeBuilder()

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
Builder

getRemoveTimeOrBuilder()

public 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 String getSearchHistorySuggestion()

The search history suggestion to be removed.

string search_history_suggestion = 2;

Returns
Type	Description
String	The searchHistorySuggestion.

getSearchHistorySuggestionBytes()

public ByteString getSearchHistorySuggestionBytes()

The search history suggestion to be removed.

string search_history_suggestion = 2;

Returns
Type	Description
ByteString	The bytes for searchHistorySuggestion.

getSuggestionCase()

public RemoveSuggestionRequest.SuggestionCase getSuggestionCase()

Returns
Type	Description
RemoveSuggestionRequest.SuggestionCase

getUserInfo()

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

getUserInfoBuilder()

public UserInfo.Builder getUserInfoBuilder()

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

getUserInfoOrBuilder()

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

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(RemoveSuggestionRequest other)

public RemoveSuggestionRequest.Builder mergeFrom(RemoveSuggestionRequest other)

Parameter
Name	Description
other	RemoveSuggestionRequest

Returns
Type	Description
RemoveSuggestionRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RemoveSuggestionRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RemoveSuggestionRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public RemoveSuggestionRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
RemoveSuggestionRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeRemoveTime(Timestamp value)

public RemoveSuggestionRequest.Builder mergeRemoveTime(Timestamp value)

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];

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
RemoveSuggestionRequest.Builder

mergeUserInfo(UserInfo value)

public RemoveSuggestionRequest.Builder mergeUserInfo(UserInfo value)

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];

Parameter
Name	Description
value	UserInfo

Returns
Type	Description
RemoveSuggestionRequest.Builder

setCompletionConfig(String value)

public RemoveSuggestionRequest.Builder setCompletionConfig(String value)

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) = { ... }

Parameter
Name	Description
value	String The completionConfig to set.

Returns
Type	Description
RemoveSuggestionRequest.Builder	This builder for chaining.

setCompletionConfigBytes(ByteString value)

public RemoveSuggestionRequest.Builder setCompletionConfigBytes(ByteString value)

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) = { ... }

Parameter
Name	Description
value	ByteString The bytes for completionConfig to set.

Returns
Type	Description
RemoveSuggestionRequest.Builder	This builder for chaining.

setRemoveAllSearchHistorySuggestions(boolean value)

public RemoveSuggestionRequest.Builder setRemoveAllSearchHistorySuggestions(boolean value)

Remove all search history suggestions for the user.

bool remove_all_search_history_suggestions = 6;

Parameter
Name	Description
value	boolean The removeAllSearchHistorySuggestions to set.

Returns
Type	Description
RemoveSuggestionRequest.Builder	This builder for chaining.

setRemoveTime(Timestamp value)

public RemoveSuggestionRequest.Builder setRemoveTime(Timestamp value)

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];

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
RemoveSuggestionRequest.Builder

setRemoveTime(Timestamp.Builder builderForValue)

public RemoveSuggestionRequest.Builder setRemoveTime(Timestamp.Builder builderForValue)

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];

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
RemoveSuggestionRequest.Builder

setSearchHistorySuggestion(String value)

public RemoveSuggestionRequest.Builder setSearchHistorySuggestion(String value)

The search history suggestion to be removed.

string search_history_suggestion = 2;

Parameter
Name	Description
value	String The searchHistorySuggestion to set.

Returns
Type	Description
RemoveSuggestionRequest.Builder	This builder for chaining.

setSearchHistorySuggestionBytes(ByteString value)

public RemoveSuggestionRequest.Builder setSearchHistorySuggestionBytes(ByteString value)

The search history suggestion to be removed.

string search_history_suggestion = 2;

Parameter
Name	Description
value	ByteString The bytes for searchHistorySuggestion to set.

Returns
Type	Description
RemoveSuggestionRequest.Builder	This builder for chaining.

setUserInfo(UserInfo value)

public RemoveSuggestionRequest.Builder setUserInfo(UserInfo value)

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];

Parameter
Name	Description
value	UserInfo

Returns
Type	Description
RemoveSuggestionRequest.Builder

setUserInfo(UserInfo.Builder builderForValue)

public RemoveSuggestionRequest.Builder setUserInfo(UserInfo.Builder builderForValue)

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];

Parameter
Name	Description
builderForValue	UserInfo.Builder

Returns
Type	Description
RemoveSuggestionRequest.Builder

setUserPseudoId(String value)

public RemoveSuggestionRequest.Builder setUserPseudoId(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 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];

Parameter
Name	Description
value	String The userPseudoId to set.

Returns
Type	Description
RemoveSuggestionRequest.Builder	This builder for chaining.

setUserPseudoIdBytes(ByteString value)

public RemoveSuggestionRequest.Builder setUserPseudoIdBytes(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 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];

Parameter
Name	Description
value	ByteString The bytes for userPseudoId to set.

Returns
Type	Description
RemoveSuggestionRequest.Builder	This builder for chaining.