Class PredictResponse (0.12.0)
Note: Some or all of the information on this page might not apply
to Trusted Cloud. For a list of services that are available in
Trusted Cloud, see Services available for
Trusted Cloud .
Version 0.12.0keyboard_arrow_down
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
ITEMS_MISSING_IN_CATALOG_FIELD_NUMBER
public static final int ITEMS_MISSING_IN_CATALOG_FIELD_NUMBER
Field Value
public static final int METADATA_FIELD_NUMBER
Field Value
NEXT_PAGE_TOKEN_FIELD_NUMBER
public static final int NEXT_PAGE_TOKEN_FIELD_NUMBER
Field Value
RECOMMENDATION_TOKEN_FIELD_NUMBER
public static final int RECOMMENDATION_TOKEN_FIELD_NUMBER
Field Value
RESULTS_FIELD_NUMBER
public static final int RESULTS_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static PredictResponse getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static PredictResponse . Builder newBuilder ()
Returns
newBuilder(PredictResponse prototype)
public static PredictResponse . Builder newBuilder ( PredictResponse prototype )
Parameter
Returns
public static PredictResponse parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static PredictResponse parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static PredictResponse parseFrom ( byte [] data )
Parameter
Name Description
data byte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PredictResponse parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static PredictResponse parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PredictResponse parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static PredictResponse parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static PredictResponse parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static PredictResponse parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static PredictResponse parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static PredictResponse parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PredictResponse parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<PredictResponse> parser ()
Returns
Methods
public boolean containsMetadata ( String key )
Additional domain specific prediction response metadata.
map<string, .google.protobuf.Value> metadata = 5;
Parameter
Returns
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
Overrides
getDefaultInstanceForType()
public PredictResponse getDefaultInstanceForType ()
Returns
getDryRun()
public boolean getDryRun ()
True if the dryRun property was set in the request.
bool dry_run = 4;
Returns
Type Description
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
Name Description
index int The index of the element to return.
Returns
Type Description
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
Name Description
index int The index of the value to return.
Returns
Type Description
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
Type Description
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
public Map<String , Value > getMetadata ()
Returns
public int getMetadataCount ()
Additional domain specific prediction response metadata.
map<string, .google.protobuf.Value> metadata = 5;
Returns
public Map<String , Value > getMetadataMap ()
Additional domain specific prediction response metadata.
map<string, .google.protobuf.Value> metadata = 5;
Returns
public Value getMetadataOrDefault ( String key , Value defaultValue )
Additional domain specific prediction response metadata.
map<string, .google.protobuf.Value> metadata = 5;
Parameters
Returns
public Value getMetadataOrThrow ( String key )
Additional domain specific prediction response metadata.
map<string, .google.protobuf.Value> metadata = 5;
Parameter
Returns
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
Type Description
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
Type Description
ByteString The bytes for nextPageToken.
getParserForType()
public Parser<PredictResponse> getParserForType ()
Returns
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
Type Description
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
Type Description
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
Name Description
index int
Returns
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
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
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
Name Description
index int
Returns
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
Type Description
List <? extends com.google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResultOrBuilder >
getSerializedSize()
public int getSerializedSize ()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField ( int number )
Parameter
Name Description
number int
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public PredictResponse . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PredictResponse . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public PredictResponse . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-16 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-16 UTC."],[],[]]
