Class PredictResponse.PredictionResult (0.61.0)

Version 0.61.0

• 0.62.0 (latest)
• 0.61.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.46.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.34.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.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.4
• 0.8.10

public static final class PredictResponse.PredictionResult extends GeneratedMessageV3 implements PredictResponse.PredictionResultOrBuilder

PredictionResult represents the recommendation prediction results.

Protobuf type google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > PredictResponse.PredictionResult

Implements

PredictResponse.PredictionResultOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

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

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

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

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

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

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

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

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

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

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

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

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

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

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

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

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

Field Value
Type	Description
int

ITEM_METADATA_FIELD_NUMBER

public static final int ITEM_METADATA_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static PredictResponse.PredictionResult getDefaultInstance()

Returns
Type	Description
PredictResponse.PredictionResult

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static PredictResponse.PredictionResult.Builder newBuilder()

Returns
Type	Description
PredictResponse.PredictionResult.Builder

newBuilder(PredictResponse.PredictionResult prototype)

public static PredictResponse.PredictionResult.Builder newBuilder(PredictResponse.PredictionResult prototype)

Parameter
Name	Description
prototype	PredictResponse.PredictionResult

Returns
Type	Description
PredictResponse.PredictionResult.Builder

parseDelimitedFrom(InputStream input)

public static PredictResponse.PredictionResult parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
PredictResponse.PredictionResult

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PredictResponse.PredictionResult parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
PredictResponse.PredictionResult

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static PredictResponse.PredictionResult parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
PredictResponse.PredictionResult

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PredictResponse.PredictionResult parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
PredictResponse.PredictionResult

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PredictResponse.PredictionResult parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
PredictResponse.PredictionResult

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PredictResponse.PredictionResult parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
PredictResponse.PredictionResult

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PredictResponse.PredictionResult parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
PredictResponse.PredictionResult

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PredictResponse.PredictionResult parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
PredictResponse.PredictionResult

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static PredictResponse.PredictionResult parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
PredictResponse.PredictionResult

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PredictResponse.PredictionResult parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
PredictResponse.PredictionResult

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static PredictResponse.PredictionResult parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
PredictResponse.PredictionResult

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PredictResponse.PredictionResult parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
PredictResponse.PredictionResult

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<PredictResponse.PredictionResult> parser()

Returns
Type	Description
Parser<PredictionResult>

Methods

containsItemMetadata(String key)

public boolean containsItemMetadata(String key)

Additional item metadata / annotations.

Possible values:

• catalogItem: JSON representation of the catalogItem. Will be set if returnCatalogItem is set to true in PredictRequest.params.
• score: Prediction score in double value. Will be set if returnItemScore is set to true in PredictRequest.params.

map<string, .google.protobuf.Value> item_metadata = 2;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public PredictResponse.PredictionResult getDefaultInstanceForType()

Returns
Type	Description
PredictResponse.PredictionResult

getId()

public String getId()

ID of the recommended catalog item

string id = 1;

Returns
Type	Description
String	The id.

getIdBytes()

public ByteString getIdBytes()

ID of the recommended catalog item

string id = 1;

Returns
Type	Description
ByteString	The bytes for id.

getItemMetadata() (deprecated)

public Map<String,Value> getItemMetadata()

Use #getItemMetadataMap() instead.

Returns
Type	Description
Map<String,Value>

getItemMetadataCount()

public int getItemMetadataCount()

Additional item metadata / annotations.

Possible values:

• catalogItem: JSON representation of the catalogItem. Will be set if returnCatalogItem is set to true in PredictRequest.params.
• score: Prediction score in double value. Will be set if returnItemScore is set to true in PredictRequest.params.

map<string, .google.protobuf.Value> item_metadata = 2;

Returns
Type	Description
int

getItemMetadataMap()

public Map<String,Value> getItemMetadataMap()

Additional item metadata / annotations.

Possible values:

• catalogItem: JSON representation of the catalogItem. Will be set if returnCatalogItem is set to true in PredictRequest.params.
• score: Prediction score in double value. Will be set if returnItemScore is set to true in PredictRequest.params.

map<string, .google.protobuf.Value> item_metadata = 2;

Returns
Type	Description
Map<String,Value>

getItemMetadataOrDefault(String key, Value defaultValue)

public Value getItemMetadataOrDefault(String key, Value defaultValue)

Additional item metadata / annotations.

Possible values:

• catalogItem: JSON representation of the catalogItem. Will be set if returnCatalogItem is set to true in PredictRequest.params.
• score: Prediction score in double value. Will be set if returnItemScore is set to true in PredictRequest.params.

map<string, .google.protobuf.Value> item_metadata = 2;

Parameters
Name	Description
key	String
defaultValue	Value

Returns
Type	Description
Value

getItemMetadataOrThrow(String key)

public Value getItemMetadataOrThrow(String key)

Additional item metadata / annotations.

Possible values:

• catalogItem: JSON representation of the catalogItem. Will be set if returnCatalogItem is set to true in PredictRequest.params.
• score: Prediction score in double value. Will be set if returnItemScore is set to true in PredictRequest.params.

map<string, .google.protobuf.Value> item_metadata = 2;

Parameter
Name	Description
key	String

Returns
Type	Description
Value

getParserForType()

public Parser<PredictResponse.PredictionResult> getParserForType()

Returns
Type	Description
Parser<PredictionResult>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
number	int

Returns
Type	Description
com.google.protobuf.MapFieldReflectionAccessor

Overrides

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

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public PredictResponse.PredictionResult.Builder newBuilderForType()

Returns
Type	Description
PredictResponse.PredictionResult.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PredictResponse.PredictionResult.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
PredictResponse.PredictionResult.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public PredictResponse.PredictionResult.Builder toBuilder()

Returns
Type	Description
PredictResponse.PredictionResult.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException