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

Request message for CompletionService.RemoveSuggestion method.

Protobuf type google.cloud.discoveryengine.v1beta.RemoveSuggestionRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > RemoveSuggestionRequest

Implements

RemoveSuggestionRequestOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

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

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

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

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

COMPLETION_CONFIG_FIELD_NUMBER

public static final int COMPLETION_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

REMOVE_ALL_SEARCH_HISTORY_SUGGESTIONS_FIELD_NUMBER

public static final int REMOVE_ALL_SEARCH_HISTORY_SUGGESTIONS_FIELD_NUMBER

Field Value
Type	Description
int

REMOVE_TIME_FIELD_NUMBER

public static final int REMOVE_TIME_FIELD_NUMBER

Field Value
Type	Description
int

SEARCH_HISTORY_SUGGESTION_FIELD_NUMBER

public static final int SEARCH_HISTORY_SUGGESTION_FIELD_NUMBER

Field Value
Type	Description
int

USER_INFO_FIELD_NUMBER

public static final int USER_INFO_FIELD_NUMBER

Field Value
Type	Description
int

USER_PSEUDO_ID_FIELD_NUMBER

public static final int USER_PSEUDO_ID_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static RemoveSuggestionRequest getDefaultInstance()

Returns
Type	Description
RemoveSuggestionRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static RemoveSuggestionRequest.Builder newBuilder()

Returns
Type	Description
RemoveSuggestionRequest.Builder

newBuilder(RemoveSuggestionRequest prototype)

public static RemoveSuggestionRequest.Builder newBuilder(RemoveSuggestionRequest prototype)

Parameter
Name	Description
prototype	RemoveSuggestionRequest

Returns
Type	Description
RemoveSuggestionRequest.Builder

parseDelimitedFrom(InputStream input)

public static RemoveSuggestionRequest parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
RemoveSuggestionRequest

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RemoveSuggestionRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RemoveSuggestionRequest

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static RemoveSuggestionRequest parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
RemoveSuggestionRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RemoveSuggestionRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RemoveSuggestionRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RemoveSuggestionRequest parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
RemoveSuggestionRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RemoveSuggestionRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RemoveSuggestionRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RemoveSuggestionRequest parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
RemoveSuggestionRequest

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RemoveSuggestionRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RemoveSuggestionRequest

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static RemoveSuggestionRequest parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
RemoveSuggestionRequest

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RemoveSuggestionRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RemoveSuggestionRequest

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static RemoveSuggestionRequest parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
RemoveSuggestionRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RemoveSuggestionRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
RemoveSuggestionRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<RemoveSuggestionRequest> parser()

Returns
Type	Description
Parser<RemoveSuggestionRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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

getParserForType()

public Parser<RemoveSuggestionRequest> getParserForType()

Returns
Type	Description
Parser<RemoveSuggestionRequest>

Overrides

GeneratedMessage.getParserForType()

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.

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.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

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.

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.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public RemoveSuggestionRequest.Builder newBuilderForType()

Returns
Type	Description
RemoveSuggestionRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected RemoveSuggestionRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
RemoveSuggestionRequest.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public RemoveSuggestionRequest.Builder toBuilder()

Returns
Type	Description
RemoveSuggestionRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException