public final class PredictResponse extends GeneratedMessageV3 implements PredictResponseOrBuilder
Response message for predict method.
Protobuf type google.cloud.retail.v2alpha.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
ATTRIBUTION_TOKEN_FIELD_NUMBER
public static final int ATTRIBUTION_TOKEN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MISSING_IDS_FIELD_NUMBER
public static final int MISSING_IDS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RESULTS_FIELD_NUMBER
public static final int RESULTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
VALIDATE_ONLY_FIELD_NUMBER
public static final int VALIDATE_ONLY_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
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAttributionToken()
public String getAttributionToken()
A unique attribution token. This should be included in the
UserEvent logs resulting from this
recommendation, which enables accurate attribution of recommendation model
performance.
string attribution_token = 2;
| Returns |
| Type |
Description |
String |
The attributionToken.
|
getAttributionTokenBytes()
public ByteString getAttributionTokenBytes()
A unique attribution token. This should be included in the
UserEvent logs resulting from this
recommendation, which enables accurate attribution of recommendation model
performance.
string attribution_token = 2;
| Returns |
| Type |
Description |
ByteString |
The bytes for attributionToken.
|
getDefaultInstanceForType()
public PredictResponse getDefaultInstanceForType()
getMissingIds(int index)
public String getMissingIds(int index)
IDs of products in the request that were missing from the inventory.
repeated string missing_ids = 3;
| Parameter |
| Name |
Description |
index |
int
The index of the element to return.
|
| Returns |
| Type |
Description |
String |
The missingIds at the given index.
|
getMissingIdsBytes(int index)
public ByteString getMissingIdsBytes(int index)
IDs of products in the request that were missing from the inventory.
repeated string missing_ids = 3;
| Parameter |
| Name |
Description |
index |
int
The index of the value to return.
|
| Returns |
| Type |
Description |
ByteString |
The bytes of the missingIds at the given index.
|
getMissingIdsCount()
public int getMissingIdsCount()
IDs of products in the request that were missing from the inventory.
repeated string missing_ids = 3;
| Returns |
| Type |
Description |
int |
The count of missingIds.
|
getMissingIdsList()
public ProtocolStringList getMissingIdsList()
IDs of products in the request that were missing from the inventory.
repeated string missing_ids = 3;
getParserForType()
public Parser<PredictResponse> getParserForType()
Overrides
getResults(int index)
public PredictResponse.PredictionResult getResults(int index)
A list of recommended products. The order represents the ranking (from the
most relevant product to the least).
repeated .google.cloud.retail.v2alpha.PredictResponse.PredictionResult results = 1;
| Parameter |
| Name |
Description |
index |
int
|
getResultsCount()
public int getResultsCount()
A list of recommended products. The order represents the ranking (from the
most relevant product to the least).
repeated .google.cloud.retail.v2alpha.PredictResponse.PredictionResult results = 1;
| Returns |
| Type |
Description |
int |
|
getResultsList()
public List<PredictResponse.PredictionResult> getResultsList()
A list of recommended products. The order represents the ranking (from the
most relevant product to the least).
repeated .google.cloud.retail.v2alpha.PredictResponse.PredictionResult results = 1;
getResultsOrBuilder(int index)
public PredictResponse.PredictionResultOrBuilder getResultsOrBuilder(int index)
A list of recommended products. The order represents the ranking (from the
most relevant product to the least).
repeated .google.cloud.retail.v2alpha.PredictResponse.PredictionResult results = 1;
| Parameter |
| Name |
Description |
index |
int
|
getResultsOrBuilderList()
public List<? extends PredictResponse.PredictionResultOrBuilder> getResultsOrBuilderList()
A list of recommended products. The order represents the ranking (from the
most relevant product to the least).
repeated .google.cloud.retail.v2alpha.PredictResponse.PredictionResult results = 1;
| Returns |
| Type |
Description |
List<? extends com.google.cloud.retail.v2alpha.PredictResponse.PredictionResultOrBuilder> |
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getValidateOnly()
public boolean getValidateOnly()
True if the validateOnly property was set in the request.
bool validate_only = 4;
| Returns |
| Type |
Description |
boolean |
The validateOnly.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
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
