Class PredictResponse.Builder (2.47.0)

public static final class PredictResponse.Builder extends GeneratedMessageV3.Builder<PredictResponse.Builder> implements PredictResponseOrBuilder

Response message for predict method.

Protobuf type google.cloud.retail.v2.PredictResponse

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllMissingIds(Iterable<String> values)

public PredictResponse.Builder addAllMissingIds(Iterable<String> values)

IDs of products in the request that were missing from the inventory.

repeated string missing_ids = 3;

Parameter
Name Description
values Iterable<String>

The missingIds to add.

Returns
Type Description
PredictResponse.Builder

This builder for chaining.

addAllResults(Iterable<? extends PredictResponse.PredictionResult> values)

public PredictResponse.Builder addAllResults(Iterable<? extends PredictResponse.PredictionResult> values)

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

repeated .google.cloud.retail.v2.PredictResponse.PredictionResult results = 1;

Parameter
Name Description
values Iterable<? extends com.google.cloud.retail.v2.PredictResponse.PredictionResult>
Returns
Type Description
PredictResponse.Builder

addMissingIds(String value)

public PredictResponse.Builder addMissingIds(String value)

IDs of products in the request that were missing from the inventory.

repeated string missing_ids = 3;

Parameter
Name Description
value String

The missingIds to add.

Returns
Type Description
PredictResponse.Builder

This builder for chaining.

addMissingIdsBytes(ByteString value)

public PredictResponse.Builder addMissingIdsBytes(ByteString value)

IDs of products in the request that were missing from the inventory.

repeated string missing_ids = 3;

Parameter
Name Description
value ByteString

The bytes of the missingIds to add.

Returns
Type Description
PredictResponse.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PredictResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PredictResponse.Builder
Overrides

addResults(PredictResponse.PredictionResult value)

public PredictResponse.Builder addResults(PredictResponse.PredictionResult value)

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

repeated .google.cloud.retail.v2.PredictResponse.PredictionResult results = 1;

Parameter
Name Description
value PredictResponse.PredictionResult
Returns
Type Description
PredictResponse.Builder

addResults(PredictResponse.PredictionResult.Builder builderForValue)

public PredictResponse.Builder addResults(PredictResponse.PredictionResult.Builder builderForValue)

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

repeated .google.cloud.retail.v2.PredictResponse.PredictionResult results = 1;

Parameter
Name Description
builderForValue PredictResponse.PredictionResult.Builder
Returns
Type Description
PredictResponse.Builder

addResults(int index, PredictResponse.PredictionResult value)

public PredictResponse.Builder addResults(int index, PredictResponse.PredictionResult value)

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

repeated .google.cloud.retail.v2.PredictResponse.PredictionResult results = 1;

Parameters
Name Description
index int
value PredictResponse.PredictionResult
Returns
Type Description
PredictResponse.Builder

addResults(int index, PredictResponse.PredictionResult.Builder builderForValue)

public PredictResponse.Builder addResults(int index, PredictResponse.PredictionResult.Builder builderForValue)

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

repeated .google.cloud.retail.v2.PredictResponse.PredictionResult results = 1;

Parameters
Name Description
index int
builderForValue PredictResponse.PredictionResult.Builder
Returns
Type Description
PredictResponse.Builder

addResultsBuilder()

public PredictResponse.PredictionResult.Builder addResultsBuilder()

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

repeated .google.cloud.retail.v2.PredictResponse.PredictionResult results = 1;

Returns
Type Description
PredictResponse.PredictionResult.Builder

addResultsBuilder(int index)

public PredictResponse.PredictionResult.Builder addResultsBuilder(int index)

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

repeated .google.cloud.retail.v2.PredictResponse.PredictionResult results = 1;

Parameter
Name Description
index int
Returns
Type Description
PredictResponse.PredictionResult.Builder

build()

public PredictResponse build()
Returns
Type Description
PredictResponse

buildPartial()

public PredictResponse buildPartial()
Returns
Type Description
PredictResponse

clear()

public PredictResponse.Builder clear()
Returns
Type Description
PredictResponse.Builder
Overrides

clearAttributionToken()

public PredictResponse.Builder clearAttributionToken()

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
PredictResponse.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public PredictResponse.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
PredictResponse.Builder
Overrides

clearMissingIds()

public PredictResponse.Builder clearMissingIds()

IDs of products in the request that were missing from the inventory.

repeated string missing_ids = 3;

Returns
Type Description
PredictResponse.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public PredictResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
PredictResponse.Builder
Overrides

clearResults()

public PredictResponse.Builder clearResults()

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

repeated .google.cloud.retail.v2.PredictResponse.PredictionResult results = 1;

Returns
Type Description
PredictResponse.Builder

clearValidateOnly()

public PredictResponse.Builder clearValidateOnly()

True if the validateOnly property was set in the request.

bool validate_only = 4;

Returns
Type Description
PredictResponse.Builder

This builder for chaining.

clone()

public PredictResponse.Builder clone()
Returns
Type Description
PredictResponse.Builder
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()
Returns
Type Description
PredictResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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;

Returns
Type Description
ProtocolStringList

A list containing the missingIds.

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.v2.PredictResponse.PredictionResult results = 1;

Parameter
Name Description
index int
Returns
Type Description
PredictResponse.PredictionResult

getResultsBuilder(int index)

public PredictResponse.PredictionResult.Builder getResultsBuilder(int index)

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

repeated .google.cloud.retail.v2.PredictResponse.PredictionResult results = 1;

Parameter
Name Description
index int
Returns
Type Description
PredictResponse.PredictionResult.Builder

getResultsBuilderList()

public List<PredictResponse.PredictionResult.Builder> getResultsBuilderList()

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

repeated .google.cloud.retail.v2.PredictResponse.PredictionResult results = 1;

Returns
Type Description
List<Builder>

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.v2.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.v2.PredictResponse.PredictionResult results = 1;

Returns
Type Description
List<PredictionResult>

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.v2.PredictResponse.PredictionResult results = 1;

Parameter
Name Description
index int
Returns
Type Description
PredictResponse.PredictionResultOrBuilder

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.v2.PredictResponse.PredictionResult results = 1;

Returns
Type Description
List<? extends com.google.cloud.retail.v2.PredictResponse.PredictionResultOrBuilder>

getValidateOnly()

public boolean getValidateOnly()

True if the validateOnly property was set in the request.

bool validate_only = 4;

Returns
Type Description
boolean

The validateOnly.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(PredictResponse other)

public PredictResponse.Builder mergeFrom(PredictResponse other)
Parameter
Name Description
other PredictResponse
Returns
Type Description
PredictResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PredictResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PredictResponse.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public PredictResponse.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
PredictResponse.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PredictResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PredictResponse.Builder
Overrides

removeResults(int index)

public PredictResponse.Builder removeResults(int index)

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

repeated .google.cloud.retail.v2.PredictResponse.PredictionResult results = 1;

Parameter
Name Description
index int
Returns
Type Description
PredictResponse.Builder

setAttributionToken(String value)

public PredictResponse.Builder setAttributionToken(String value)

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;

Parameter
Name Description
value String

The attributionToken to set.

Returns
Type Description
PredictResponse.Builder

This builder for chaining.

setAttributionTokenBytes(ByteString value)

public PredictResponse.Builder setAttributionTokenBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for attributionToken to set.

Returns
Type Description
PredictResponse.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public PredictResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PredictResponse.Builder
Overrides

setMissingIds(int index, String value)

public PredictResponse.Builder setMissingIds(int index, String value)

IDs of products in the request that were missing from the inventory.

repeated string missing_ids = 3;

Parameters
Name Description
index int

The index to set the value at.

value String

The missingIds to set.

Returns
Type Description
PredictResponse.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PredictResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
PredictResponse.Builder
Overrides

setResults(int index, PredictResponse.PredictionResult value)

public PredictResponse.Builder setResults(int index, PredictResponse.PredictionResult value)

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

repeated .google.cloud.retail.v2.PredictResponse.PredictionResult results = 1;

Parameters
Name Description
index int
value PredictResponse.PredictionResult
Returns
Type Description
PredictResponse.Builder

setResults(int index, PredictResponse.PredictionResult.Builder builderForValue)

public PredictResponse.Builder setResults(int index, PredictResponse.PredictionResult.Builder builderForValue)

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

repeated .google.cloud.retail.v2.PredictResponse.PredictionResult results = 1;

Parameters
Name Description
index int
builderForValue PredictResponse.PredictionResult.Builder
Returns
Type Description
PredictResponse.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final PredictResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
PredictResponse.Builder
Overrides

setValidateOnly(boolean value)

public PredictResponse.Builder setValidateOnly(boolean value)

True if the validateOnly property was set in the request.

bool validate_only = 4;

Parameter
Name Description
value boolean

The validateOnly to set.

Returns
Type Description
PredictResponse.Builder

This builder for chaining.