Package com.google.cloud.recommendationengine.v1beta1

Class PredictResponse.PredictionResult

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult

All Implemented Interfaces:

PredictResponse.PredictionResultOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

PredictResponse

public static final class PredictResponse.PredictionResult
extends com.google.protobuf.GeneratedMessageV3
implements PredictResponse.PredictionResultOrBuilder

 PredictionResult represents the recommendation prediction results.
 

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PredictResponse.PredictionResult.Builder	PredictionResult represents the recommendation prediction results.

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	Description
static int	ID_FIELD_NUMBER
static int	ITEM_METADATA_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	Description
boolean	containsItemMetadata(String key)	Additional item metadata / annotations.
boolean	equals(Object obj)
static PredictResponse.PredictionResult	getDefaultInstance()
PredictResponse.PredictionResult	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getId()	ID of the recommended catalog item
com.google.protobuf.ByteString	getIdBytes()	ID of the recommended catalog item
Map<String,com.google.protobuf.Value>	getItemMetadata()	Deprecated.
int	getItemMetadataCount()	Additional item metadata / annotations.
Map<String,com.google.protobuf.Value>	getItemMetadataMap()	Additional item metadata / annotations.
com.google.protobuf.Value	getItemMetadataOrDefault(String key, com.google.protobuf.Value defaultValue)	Additional item metadata / annotations.
com.google.protobuf.Value	getItemMetadataOrThrow(String key)	Additional item metadata / annotations.
com.google.protobuf.Parser<PredictResponse.PredictionResult>	getParserForType()
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static PredictResponse.PredictionResult.Builder	newBuilder()
static PredictResponse.PredictionResult.Builder	newBuilder(PredictResponse.PredictionResult prototype)
PredictResponse.PredictionResult.Builder	newBuilderForType()
protected PredictResponse.PredictionResult.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static PredictResponse.PredictionResult	parseDelimitedFrom(InputStream input)
static PredictResponse.PredictionResult	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PredictResponse.PredictionResult	parseFrom(byte[] data)
static PredictResponse.PredictionResult	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PredictResponse.PredictionResult	parseFrom(com.google.protobuf.ByteString data)
static PredictResponse.PredictionResult	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PredictResponse.PredictionResult	parseFrom(com.google.protobuf.CodedInputStream input)
static PredictResponse.PredictionResult	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PredictResponse.PredictionResult	parseFrom(InputStream input)
static PredictResponse.PredictionResult	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PredictResponse.PredictionResult	parseFrom(ByteBuffer data)
static PredictResponse.PredictionResult	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<PredictResponse.PredictionResult>	parser()
PredictResponse.PredictionResult.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, 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.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Detail

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

See Also:

Constant Field Values

ITEM_METADATA_FIELD_NUMBER

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

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getId

public String getId()

 ID of the recommended catalog item
 

string id = 1;

Specified by:

getId in interface PredictResponse.PredictionResultOrBuilder

Returns:

The id.

getIdBytes

public com.google.protobuf.ByteString getIdBytes()

 ID of the recommended catalog item
 

string id = 1;

Specified by:

getIdBytes in interface PredictResponse.PredictionResultOrBuilder

Returns:

The bytes for id.

getItemMetadataCount

public int getItemMetadataCount()

Description copied from interface: PredictResponse.PredictionResultOrBuilder

 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;

Specified by:

getItemMetadataCount in interface PredictResponse.PredictionResultOrBuilder

containsItemMetadata

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;

Specified by:

containsItemMetadata in interface PredictResponse.PredictionResultOrBuilder

getItemMetadata

@Deprecated
public Map<String,com.google.protobuf.Value> getItemMetadata()

Deprecated.

Use getItemMetadataMap() instead.

Specified by:

getItemMetadata in interface PredictResponse.PredictionResultOrBuilder

getItemMetadataMap

public Map<String,com.google.protobuf.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;

Specified by:

getItemMetadataMap in interface PredictResponse.PredictionResultOrBuilder

getItemMetadataOrDefault

public com.google.protobuf.Value getItemMetadataOrDefault(String key,
                                                          com.google.protobuf.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;

Specified by:

getItemMetadataOrDefault in interface PredictResponse.PredictionResultOrBuilder

getItemMetadataOrThrow

public com.google.protobuf.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;

Specified by:

getItemMetadataOrThrow in interface PredictResponse.PredictionResultOrBuilder

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.PredictionResult parseFrom(ByteBuffer data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PredictResponse.PredictionResult 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.PredictionResult parseFrom(byte[] data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PredictResponse.PredictionResult parseFrom(InputStream input)
                                                  throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static PredictResponse.PredictionResult parseDelimitedFrom(InputStream input)
                                                           throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public PredictResponse.PredictionResult.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static PredictResponse.PredictionResult.Builder newBuilder()

newBuilder

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

toBuilder

public PredictResponse.PredictionResult.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static PredictResponse.PredictionResult getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<PredictResponse.PredictionResult> 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.PredictionResult getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder