public final class PredictResponse extends GeneratedMessageV3 implements PredictResponseOrBuilder
Response message for predict method.
Protobuf type google.cloud.recommendationengine.v1beta1.PredictResponse
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
DRY_RUN_FIELD_NUMBER
public static final int DRY_RUN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ITEMS_MISSING_IN_CATALOG_FIELD_NUMBER
public static final int ITEMS_MISSING_IN_CATALOG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int METADATA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NEXT_PAGE_TOKEN_FIELD_NUMBER
public static final int NEXT_PAGE_TOKEN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RECOMMENDATION_TOKEN_FIELD_NUMBER
public static final int RECOMMENDATION_TOKEN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RESULTS_FIELD_NUMBER
public static final int RESULTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static PredictResponse getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static PredictResponse.Builder newBuilder()
newBuilder(PredictResponse prototype)
public static PredictResponse.Builder newBuilder(PredictResponse prototype)
public static PredictResponse parseDelimitedFrom(InputStream input)
public static PredictResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static PredictResponse parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PredictResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static PredictResponse parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PredictResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PredictResponse parseFrom(CodedInputStream input)
public static PredictResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static PredictResponse parseFrom(InputStream input)
public static PredictResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static PredictResponse parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PredictResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<PredictResponse> parser()
Methods
public boolean containsMetadata(String key)
Additional domain specific prediction response metadata.
map<string, .google.protobuf.Value> metadata = 5;
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public PredictResponse getDefaultInstanceForType()
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;
public Map<String,Value> getMetadata()
public int getMetadataCount()
Additional domain specific prediction response metadata.
map<string, .google.protobuf.Value> metadata = 5;
| Returns |
| Type |
Description |
int |
|
public Map<String,Value> getMetadataMap()
Additional domain specific prediction response metadata.
map<string, .google.protobuf.Value> metadata = 5;
public Value getMetadataOrDefault(String key, Value defaultValue)
Additional domain specific prediction response metadata.
map<string, .google.protobuf.Value> metadata = 5;
| Parameters |
| Name |
Description |
key |
String
|
defaultValue |
Value
|
| Returns |
| Type |
Description |
Value |
|
public Value getMetadataOrThrow(String key)
Additional domain specific prediction response metadata.
map<string, .google.protobuf.Value> metadata = 5;
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
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 |
| 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()
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
|
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 |
| Type |
Description |
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;
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
|
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 |
| Type |
Description |
int |
|
Overrides
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
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()
Overrides
newBuilderForType()
public PredictResponse.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PredictResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public PredictResponse.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
