Class PredictResponse.PredictionResult (2.55.0) 

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

PredictionResult represents the recommendation prediction results.

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

Inheritance

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

Static Fields

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

METADATA_FIELD_NUMBER

public static final int 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

containsMetadata(String key)

public boolean containsMetadata(String key)

Additional product metadata / annotations.

Possible values:

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

map<string, .google.protobuf.Value> 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

getDefaultInstanceForType()

public PredictResponse.PredictionResult getDefaultInstanceForType()
Returns
Type Description
PredictResponse.PredictionResult

getId()

public String getId()

ID of the recommended product

string id = 1;

Returns
Type Description
String

The id.

getIdBytes()

public ByteString getIdBytes()

ID of the recommended product

string id = 1;

Returns
Type Description
ByteString

The bytes for id.

getMetadata() (deprecated)

public Map<String,Value> getMetadata()

Use #getMetadataMap() instead.

Returns
Type Description
Map<String,Value>

getMetadataCount()

public int getMetadataCount()

Additional product metadata / annotations.

Possible values:

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

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

Returns
Type Description
int

getMetadataMap()

public Map<String,Value> getMetadataMap()

Additional product metadata / annotations.

Possible values:

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

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

Returns
Type Description
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. Is set if returnProduct is set to true in PredictRequest.params.
  • score: Prediction score in double value. Is set if returnScore is set to true in PredictRequest.params.

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

Parameters
Name Description
key String
defaultValue Value
Returns
Type Description
Value

getMetadataOrThrow(String key)

public Value getMetadataOrThrow(String key)

Additional product metadata / annotations.

Possible values:

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

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

Parameter
Name Description
key String
Returns
Type Description
Value

getParserForType()

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

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

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

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

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
Exceptions
Type Description
IOException