Class PredictResponse.PredictionResult

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

PredictionResult represents the recommendation prediction results.

Protobuf type google.cloud.retail.v2.PredictResponse.PredictionResult

Inheritance

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

Fields

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
TypeDescription
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

containsMetadata(String key)

public boolean containsMetadata(String key)

Additional product metadata / annotations. Possible values:

  • product: JSON representation of the product. Will be set if returnProduct is set to true in PredictRequest.params.
  • score: Prediction score in double value. Will be set if returnScore is set to true in PredictRequest.params.

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

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

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

getDefaultInstance()

public static PredictResponse.PredictionResult getDefaultInstance()
Returns
TypeDescription
PredictResponse.PredictionResult

getDefaultInstanceForType()

public PredictResponse.PredictionResult getDefaultInstanceForType()
Returns
TypeDescription
PredictResponse.PredictionResult

getDescriptor()

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

getId()

public String getId()

ID of the recommended product

string id = 1;

Returns
TypeDescription
String

The id.

getIdBytes()

public ByteString getIdBytes()

ID of the recommended product

string id = 1;

Returns
TypeDescription
ByteString

The bytes for id.

getMetadata()

public Map<String,Value> getMetadata()

Use #getMetadataMap() instead.

Returns
TypeDescription
Map<String,Value>

getMetadataCount()

public int getMetadataCount()

Additional product metadata / annotations. Possible values:

  • product: JSON representation of the product. Will be set if returnProduct is set to true in PredictRequest.params.
  • score: Prediction score in double value. Will be set if returnScore is set to true in PredictRequest.params.

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

Returns
TypeDescription
int

getMetadataMap()

public Map<String,Value> getMetadataMap()

Additional product metadata / annotations. Possible values:

  • product: JSON representation of the product. Will be set if returnProduct is set to true in PredictRequest.params.
  • score: Prediction score in double value. Will be set if returnScore is set to true in PredictRequest.params.

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

Returns
TypeDescription
Map<String,Value>

getMetadataOrDefault(String key, Value defaultValue)

public Value getMetadataOrDefault(String key, Value defaultValue)

Additional product metadata / annotations. Possible values:

  • product: JSON representation of the product. Will be set if returnProduct is set to true in PredictRequest.params.
  • score: Prediction score in double value. Will be set if returnScore is set to true in PredictRequest.params.

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

Parameters
NameDescription
keyString
defaultValueValue
Returns
TypeDescription
Value

getMetadataOrThrow(String key)

public Value getMetadataOrThrow(String key)

Additional product metadata / annotations. Possible values:

  • product: JSON representation of the product. Will be set if returnProduct is set to true in PredictRequest.params.
  • score: Prediction score in double value. Will be set if returnScore is set to true in PredictRequest.params.

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

Parameter
NameDescription
keyString
Returns
TypeDescription
Value

getParserForType()

public Parser<PredictResponse.PredictionResult> getParserForType()
Returns
TypeDescription
Parser<PredictionResult>
Overrides

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

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static PredictResponse.PredictionResult.Builder newBuilder()
Returns
TypeDescription
PredictResponse.PredictionResult.Builder

newBuilder(PredictResponse.PredictionResult prototype)

public static PredictResponse.PredictionResult.Builder newBuilder(PredictResponse.PredictionResult prototype)
Parameter
NameDescription
prototypePredictResponse.PredictionResult
Returns
TypeDescription
PredictResponse.PredictionResult.Builder

newBuilderForType()

public PredictResponse.PredictionResult.Builder newBuilderForType()
Returns
TypeDescription
PredictResponse.PredictionResult.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

parseDelimitedFrom(InputStream input)

public static PredictResponse.PredictionResult parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PredictResponse.PredictionResult
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static PredictResponse.PredictionResult parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
PredictResponse.PredictionResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static PredictResponse.PredictionResult parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
PredictResponse.PredictionResult
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static PredictResponse.PredictionResult parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PredictResponse.PredictionResult
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static PredictResponse.PredictionResult parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
PredictResponse.PredictionResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<PredictResponse.PredictionResult> parser()
Returns
TypeDescription
Parser<PredictionResult>

toBuilder()

public PredictResponse.PredictionResult.Builder toBuilder()
Returns
TypeDescription
PredictResponse.PredictionResult.Builder

writeTo(CodedOutputStream output)

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