Class PredictResponse (0.40.0)

public final class PredictResponse extends GeneratedMessageV3 implements PredictResponseOrBuilder

Response message for predict method.

Protobuf type google.cloud.recommendationengine.v1beta1.PredictResponse

Static Fields

DRY_RUN_FIELD_NUMBER

public static final int DRY_RUN_FIELD_NUMBER
Field Value
TypeDescription
int

ITEMS_MISSING_IN_CATALOG_FIELD_NUMBER

public static final int ITEMS_MISSING_IN_CATALOG_FIELD_NUMBER
Field Value
TypeDescription
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

NEXT_PAGE_TOKEN_FIELD_NUMBER

public static final int NEXT_PAGE_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

RECOMMENDATION_TOKEN_FIELD_NUMBER

public static final int RECOMMENDATION_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

RESULTS_FIELD_NUMBER

public static final int RESULTS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static PredictResponse getDefaultInstance()
Returns
TypeDescription
PredictResponse

getDescriptor()

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

newBuilder()

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

newBuilder(PredictResponse prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsMetadata(String key)

public boolean containsMetadata(String key)

Additional domain specific prediction response metadata.

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

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

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

getDefaultInstanceForType()

public PredictResponse getDefaultInstanceForType()
Returns
TypeDescription
PredictResponse

getDryRun()

public boolean getDryRun()

True if the dryRun property was set in the request.

bool dry_run = 4;

Returns
TypeDescription
boolean

The dryRun.

getItemsMissingInCatalog(int index)

public String getItemsMissingInCatalog(int index)

IDs of items in the request that were missing from the catalog.

repeated string items_missing_in_catalog = 3;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The itemsMissingInCatalog at the given index.

getItemsMissingInCatalogBytes(int index)

public ByteString getItemsMissingInCatalogBytes(int index)

IDs of items in the request that were missing from the catalog.

repeated string items_missing_in_catalog = 3;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the itemsMissingInCatalog at the given index.

getItemsMissingInCatalogCount()

public int getItemsMissingInCatalogCount()

IDs of items in the request that were missing from the catalog.

repeated string items_missing_in_catalog = 3;

Returns
TypeDescription
int

The count of itemsMissingInCatalog.

getItemsMissingInCatalogList()

public ProtocolStringList getItemsMissingInCatalogList()

IDs of items in the request that were missing from the catalog.

repeated string items_missing_in_catalog = 3;

Returns
TypeDescription
ProtocolStringList

A list containing the itemsMissingInCatalog.

getMetadata() (deprecated)

public Map<String,Value> getMetadata()

Use #getMetadataMap() instead.

Returns
TypeDescription
Map<String,Value>

getMetadataCount()

public int getMetadataCount()

Additional domain specific prediction response metadata.

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

Returns
TypeDescription
int

getMetadataMap()

public Map<String,Value> getMetadataMap()

Additional domain specific prediction response metadata.

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

Returns
TypeDescription
Map<String,Value>

getMetadataOrDefault(String key, Value defaultValue)

public Value getMetadataOrDefault(String key, Value defaultValue)

Additional domain specific prediction response metadata.

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

Parameters
NameDescription
keyString
defaultValueValue
Returns
TypeDescription
Value

getMetadataOrThrow(String key)

public Value getMetadataOrThrow(String key)

Additional domain specific prediction response metadata.

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

Parameter
NameDescription
keyString
Returns
TypeDescription
Value

getNextPageToken()

public String getNextPageToken()

If empty, the list is complete. If nonempty, the token to pass to the next request's PredictRequest.page_token.

string next_page_token = 6;

Returns
TypeDescription
String

The nextPageToken.

getNextPageTokenBytes()

public ByteString getNextPageTokenBytes()

If empty, the list is complete. If nonempty, the token to pass to the next request's PredictRequest.page_token.

string next_page_token = 6;

Returns
TypeDescription
ByteString

The bytes for nextPageToken.

getParserForType()

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

getRecommendationToken()

public String getRecommendationToken()

A unique recommendation token. This should be included in the user event logs resulting from this recommendation, which enables accurate attribution of recommendation model performance.

string recommendation_token = 2;

Returns
TypeDescription
String

The recommendationToken.

getRecommendationTokenBytes()

public ByteString getRecommendationTokenBytes()

A unique recommendation token. This should be included in the user event logs resulting from this recommendation, which enables accurate attribution of recommendation model performance.

string recommendation_token = 2;

Returns
TypeDescription
ByteString

The bytes for recommendationToken.

getResults(int index)

public PredictResponse.PredictionResult getResults(int index)

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

repeated .google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult results = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
PredictResponse.PredictionResult

getResultsCount()

public int getResultsCount()

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

repeated .google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult results = 1;

Returns
TypeDescription
int

getResultsList()

public List<PredictResponse.PredictionResult> getResultsList()

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

repeated .google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult results = 1;

Returns
TypeDescription
List<PredictionResult>

getResultsOrBuilder(int index)

public PredictResponse.PredictionResultOrBuilder getResultsOrBuilder(int index)

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

repeated .google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult results = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
PredictResponse.PredictionResultOrBuilder

getResultsOrBuilderList()

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

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

repeated .google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult results = 1;

Returns
TypeDescription
List<? extends com.google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResultOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
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

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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