Class PredictResponse.Builder (2.44.0)

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

Response message for predict method.

Protobuf type google.cloud.retail.v2beta.PredictResponse

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PredictResponse.Builder

Implements

PredictResponseOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

Parameter
Name	Description
`values`	`Iterable<? extends com.google.cloud.retail.v2beta.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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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.v2beta.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.v2beta.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.v2beta.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.v2beta.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.v2beta.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.v2beta.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

GeneratedMessageV3.Builder<BuilderType>.clear()

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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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.v2beta.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

GeneratedMessageV3.Builder<BuilderType>.clone()

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

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

Returns
Type	Description
`List<? extends com.google.cloud.retail.v2beta.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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public PredictResponse.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`PredictResponse.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PredictResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`PredictResponse.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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.v2beta.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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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.v2beta.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.v2beta.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

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

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.