Class CompletionDetail

public final class CompletionDetail extends GeneratedMessageV3 implements CompletionDetailOrBuilder

Detailed completion information including completion attribution token and clicked completion info.

Protobuf type google.cloud.retail.v2.CompletionDetail

Fields

COMPLETION_ATTRIBUTION_TOKEN_FIELD_NUMBER

public static final int COMPLETION_ATTRIBUTION_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

SELECTED_POSITION_FIELD_NUMBER

public static final int SELECTED_POSITION_FIELD_NUMBER
Field Value
TypeDescription
int

SELECTED_SUGGESTION_FIELD_NUMBER

public static final int SELECTED_SUGGESTION_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getCompletionAttributionToken()

public String getCompletionAttributionToken()

Completion attribution token in CompleteQueryResponse.attribution_token.

string completion_attribution_token = 1;

Returns
TypeDescription
String

The completionAttributionToken.

getCompletionAttributionTokenBytes()

public ByteString getCompletionAttributionTokenBytes()

Completion attribution token in CompleteQueryResponse.attribution_token.

string completion_attribution_token = 1;

Returns
TypeDescription
ByteString

The bytes for completionAttributionToken.

getDefaultInstance()

public static CompletionDetail getDefaultInstance()
Returns
TypeDescription
CompletionDetail

getDefaultInstanceForType()

public CompletionDetail getDefaultInstanceForType()
Returns
TypeDescription
CompletionDetail

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getParserForType()

public Parser<CompletionDetail> getParserForType()
Returns
TypeDescription
Parser<CompletionDetail>
Overrides

getSelectedPosition()

public int getSelectedPosition()

End user selected CompleteQueryResponse.CompletionResult.suggestion position, starting from 0.

int32 selected_position = 3;

Returns
TypeDescription
int

The selectedPosition.

getSelectedSuggestion()

public String getSelectedSuggestion()

End user selected CompleteQueryResponse.CompletionResult.suggestion.

string selected_suggestion = 2;

Returns
TypeDescription
String

The selectedSuggestion.

getSelectedSuggestionBytes()

public ByteString getSelectedSuggestionBytes()

End user selected CompleteQueryResponse.CompletionResult.suggestion.

string selected_suggestion = 2;

Returns
TypeDescription
ByteString

The bytes for selectedSuggestion.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static CompletionDetail.Builder newBuilder()
Returns
TypeDescription
CompletionDetail.Builder

newBuilder(CompletionDetail prototype)

public static CompletionDetail.Builder newBuilder(CompletionDetail prototype)
Parameter
NameDescription
prototypeCompletionDetail
Returns
TypeDescription
CompletionDetail.Builder

newBuilderForType()

public CompletionDetail.Builder newBuilderForType()
Returns
TypeDescription
CompletionDetail.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CompletionDetail.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
CompletionDetail.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static CompletionDetail parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CompletionDetail
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CompletionDetail parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CompletionDetail
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static CompletionDetail parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
CompletionDetail
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CompletionDetail parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CompletionDetail
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CompletionDetail parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
CompletionDetail
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CompletionDetail parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CompletionDetail
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CompletionDetail parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
CompletionDetail
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CompletionDetail parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CompletionDetail
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static CompletionDetail parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
CompletionDetail
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CompletionDetail parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CompletionDetail
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static CompletionDetail parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
CompletionDetail
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CompletionDetail parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
CompletionDetail
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<CompletionDetail> parser()
Returns
TypeDescription
Parser<CompletionDetail>

toBuilder()

public CompletionDetail.Builder toBuilder()
Returns
TypeDescription
CompletionDetail.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException