Class CompletionDetail (2.55.0)

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

Static Fields

COMPLETION_ATTRIBUTION_TOKEN_FIELD_NUMBER

public static final int COMPLETION_ATTRIBUTION_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

SELECTED_POSITION_FIELD_NUMBER

public static final int SELECTED_POSITION_FIELD_NUMBER
Field Value
Type Description
int

SELECTED_SUGGESTION_FIELD_NUMBER

public static final int SELECTED_SUGGESTION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CompletionDetail getDefaultInstance()
Returns
Type Description
CompletionDetail

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CompletionDetail.Builder newBuilder()
Returns
Type Description
CompletionDetail.Builder

newBuilder(CompletionDetail prototype)

public static CompletionDetail.Builder newBuilder(CompletionDetail prototype)
Parameter
Name Description
prototype CompletionDetail
Returns
Type Description
CompletionDetail.Builder

parseDelimitedFrom(InputStream input)

public static CompletionDetail parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CompletionDetail
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CompletionDetail parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CompletionDetail
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CompletionDetail parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CompletionDetail
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CompletionDetail parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CompletionDetail
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CompletionDetail parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CompletionDetail
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CompletionDetail parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CompletionDetail
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CompletionDetail parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CompletionDetail
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CompletionDetail parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CompletionDetail
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CompletionDetail parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CompletionDetail
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CompletionDetail parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CompletionDetail
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CompletionDetail parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CompletionDetail
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CompletionDetail parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CompletionDetail
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CompletionDetail> parser()
Returns
Type Description
Parser<CompletionDetail>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCompletionAttributionToken()

public String getCompletionAttributionToken()

Completion attribution token in CompleteQueryResponse.attribution_token.

string completion_attribution_token = 1;

Returns
Type Description
String

The completionAttributionToken.

getCompletionAttributionTokenBytes()

public ByteString getCompletionAttributionTokenBytes()

Completion attribution token in CompleteQueryResponse.attribution_token.

string completion_attribution_token = 1;

Returns
Type Description
ByteString

The bytes for completionAttributionToken.

getDefaultInstanceForType()

public CompletionDetail getDefaultInstanceForType()
Returns
Type Description
CompletionDetail

getParserForType()

public Parser<CompletionDetail> getParserForType()
Returns
Type Description
Parser<CompletionDetail>
Overrides

getSelectedPosition()

public int getSelectedPosition()

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

int32 selected_position = 3;

Returns
Type Description
int

The selectedPosition.

getSelectedSuggestion()

public String getSelectedSuggestion()

End user selected CompleteQueryResponse.CompletionResult.suggestion.

string selected_suggestion = 2;

Returns
Type Description
String

The selectedSuggestion.

getSelectedSuggestionBytes()

public ByteString getSelectedSuggestionBytes()

End user selected CompleteQueryResponse.CompletionResult.suggestion.

string selected_suggestion = 2;

Returns
Type Description
ByteString

The bytes for selectedSuggestion.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CompletionDetail.Builder newBuilderForType()
Returns
Type Description
CompletionDetail.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CompletionDetail.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CompletionDetail.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CompletionDetail.Builder toBuilder()
Returns
Type Description
CompletionDetail.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException