com.google.cloud.retail.v2

Class PredictResponse

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.retail.v2.PredictResponse

All Implemented Interfaces:

PredictResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class PredictResponse
extends com.google.protobuf.GeneratedMessageV3
implements PredictResponseOrBuilder

 Response message for predict method.
 

Protobuf type google.cloud.retail.v2.PredictResponse

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PredictResponse.Builder Response message for predict method.
static class	PredictResponse.PredictionResult PredictionResult represents the recommendation prediction results.
static interface	PredictResponse.PredictionResultOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ATTRIBUTION_TOKEN_FIELD_NUMBER
static int	MISSING_IDS_FIELD_NUMBER
static int	RESULTS_FIELD_NUMBER
static int	VALIDATE_ONLY_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAttributionToken() A unique attribution token.
com.google.protobuf.ByteString	getAttributionTokenBytes() A unique attribution token.
static PredictResponse	getDefaultInstance()
PredictResponse	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getMissingIds(int index) IDs of products in the request that were missing from the inventory.
com.google.protobuf.ByteString	getMissingIdsBytes(int index) IDs of products in the request that were missing from the inventory.
int	getMissingIdsCount() IDs of products in the request that were missing from the inventory.
com.google.protobuf.ProtocolStringList	getMissingIdsList() IDs of products in the request that were missing from the inventory.
com.google.protobuf.Parser<PredictResponse>	getParserForType()
PredictResponse.PredictionResult	getResults(int index) A list of recommended products.
int	getResultsCount() A list of recommended products.
List<PredictResponse.PredictionResult>	getResultsList() A list of recommended products.
PredictResponse.PredictionResultOrBuilder	getResultsOrBuilder(int index) A list of recommended products.
List<? extends PredictResponse.PredictionResultOrBuilder>	getResultsOrBuilderList() A list of recommended products.
int	getSerializedSize()
boolean	getValidateOnly() True if the validateOnly property was set in the request.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static PredictResponse.Builder	newBuilder()
static PredictResponse.Builder	newBuilder(PredictResponse prototype)
PredictResponse.Builder	newBuilderForType()
protected PredictResponse.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static PredictResponse	parseDelimitedFrom(InputStream input)
static PredictResponse	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PredictResponse	parseFrom(byte[] data)
static PredictResponse	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PredictResponse	parseFrom(ByteBuffer data)
static PredictResponse	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PredictResponse	parseFrom(com.google.protobuf.ByteString data)
static PredictResponse	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PredictResponse	parseFrom(com.google.protobuf.CodedInputStream input)
static PredictResponse	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PredictResponse	parseFrom(InputStream input)
static PredictResponse	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<PredictResponse>	parser()
PredictResponse.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

RESULTS_FIELD_NUMBER

public static final int RESULTS_FIELD_NUMBER

See Also:

Constant Field Values

ATTRIBUTION_TOKEN_FIELD_NUMBER

public static final int ATTRIBUTION_TOKEN_FIELD_NUMBER

See Also:

Constant Field Values

MISSING_IDS_FIELD_NUMBER

public static final int MISSING_IDS_FIELD_NUMBER

See Also:

Constant Field Values

VALIDATE_ONLY_FIELD_NUMBER

public static final int VALIDATE_ONLY_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getResultsList

public List<PredictResponse.PredictionResult> getResultsList()

 A list of recommended products. The order represents the ranking (from the
 most relevant product to the least).
 

repeated .google.cloud.retail.v2.PredictResponse.PredictionResult results = 1;

Specified by:

getResultsList in interface PredictResponseOrBuilder

getResultsOrBuilderList

public List<? extends PredictResponse.PredictionResultOrBuilder> getResultsOrBuilderList()

 A list of recommended products. The order represents the ranking (from the
 most relevant product to the least).
 

repeated .google.cloud.retail.v2.PredictResponse.PredictionResult results = 1;

Specified by:

getResultsOrBuilderList in interface PredictResponseOrBuilder

getResultsCount

public int getResultsCount()

 A list of recommended products. The order represents the ranking (from the
 most relevant product to the least).
 

repeated .google.cloud.retail.v2.PredictResponse.PredictionResult results = 1;

Specified by:

getResultsCount in interface PredictResponseOrBuilder

getResults

public PredictResponse.PredictionResult getResults(int index)

 A list of recommended products. The order represents the ranking (from the
 most relevant product to the least).
 

repeated .google.cloud.retail.v2.PredictResponse.PredictionResult results = 1;

Specified by:

getResults in interface PredictResponseOrBuilder

getResultsOrBuilder

public PredictResponse.PredictionResultOrBuilder getResultsOrBuilder(int index)

 A list of recommended products. The order represents the ranking (from the
 most relevant product to the least).
 

repeated .google.cloud.retail.v2.PredictResponse.PredictionResult results = 1;

Specified by:

getResultsOrBuilder in interface PredictResponseOrBuilder

getAttributionToken

public String getAttributionToken()

 A unique attribution token. This should be included in the
 [UserEvent][google.cloud.retail.v2.UserEvent] logs resulting from this
 recommendation, which enables accurate attribution of recommendation model
 performance.
 

string attribution_token = 2;

Specified by:

getAttributionToken in interface PredictResponseOrBuilder

Returns:

The attributionToken.

getAttributionTokenBytes

public com.google.protobuf.ByteString getAttributionTokenBytes()

 A unique attribution token. This should be included in the
 [UserEvent][google.cloud.retail.v2.UserEvent] logs resulting from this
 recommendation, which enables accurate attribution of recommendation model
 performance.
 

string attribution_token = 2;

Specified by:

getAttributionTokenBytes in interface PredictResponseOrBuilder

Returns:

The bytes for attributionToken.

getMissingIdsList

public com.google.protobuf.ProtocolStringList getMissingIdsList()

 IDs of products in the request that were missing from the inventory.
 

repeated string missing_ids = 3;

Specified by:

getMissingIdsList in interface PredictResponseOrBuilder

Returns:

A list containing the missingIds.

getMissingIdsCount

public int getMissingIdsCount()

 IDs of products in the request that were missing from the inventory.
 

repeated string missing_ids = 3;

Specified by:

getMissingIdsCount in interface PredictResponseOrBuilder

Returns:

The count of missingIds.

getMissingIds

public String getMissingIds(int index)

 IDs of products in the request that were missing from the inventory.
 

repeated string missing_ids = 3;

Specified by:

getMissingIds in interface PredictResponseOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The missingIds at the given index.

getMissingIdsBytes

public com.google.protobuf.ByteString getMissingIdsBytes(int index)

 IDs of products in the request that were missing from the inventory.
 

repeated string missing_ids = 3;

Specified by:

getMissingIdsBytes in interface PredictResponseOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the missingIds at the given index.

getValidateOnly

public boolean getValidateOnly()

 True if the validateOnly property was set in the request.
 

bool validate_only = 4;

Specified by:

getValidateOnly in interface PredictResponseOrBuilder

Returns:

The validateOnly.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static PredictResponse parseFrom(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PredictResponse parseFrom(ByteBuffer data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PredictResponse parseFrom(com.google.protobuf.ByteString data)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PredictResponse parseFrom(com.google.protobuf.ByteString data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PredictResponse parseFrom(byte[] data)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PredictResponse parseFrom(byte[] data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PredictResponse parseFrom(InputStream input)
                                 throws IOException

Throws:

IOException

parseFrom

public static PredictResponse parseFrom(InputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static PredictResponse parseDelimitedFrom(InputStream input)
                                          throws IOException

Throws:

IOException

parseDelimitedFrom

public static PredictResponse parseDelimitedFrom(InputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException

Throws:

IOException

parseFrom

public static PredictResponse parseFrom(com.google.protobuf.CodedInputStream input)
                                 throws IOException

Throws:

IOException

parseFrom

public static PredictResponse parseFrom(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

newBuilderForType

public PredictResponse.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static PredictResponse.Builder newBuilder()

newBuilder

public static PredictResponse.Builder newBuilder(PredictResponse prototype)

toBuilder

public PredictResponse.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected PredictResponse.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static PredictResponse getDefaultInstance()

parser

public static com.google.protobuf.Parser<PredictResponse> parser()

getParserForType

public com.google.protobuf.Parser<PredictResponse> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public PredictResponse getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder