Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class PredictResponse.PredictionResult.Builder (0.95.0)

public static final class PredictResponse.PredictionResult.Builder extends GeneratedMessage.Builder<PredictResponse.PredictionResult.Builder> implements PredictResponse.PredictionResultOrBuilder

PredictionResult represents the recommendation prediction results.

Protobuf type google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > PredictResponse.PredictionResult.Builder

Implements

PredictResponse.PredictionResultOrBuilder

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)

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

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

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

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

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

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

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

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

GeneratedMessage.Builder.internalGetMutableMapField(int)

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

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

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

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

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

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

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

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

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

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.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

build()

public PredictResponse.PredictionResult build()

Returns
Type	Description
`PredictResponse.PredictionResult`

buildPartial()

public PredictResponse.PredictionResult buildPartial()

Returns
Type	Description
`PredictResponse.PredictionResult`

clear()

public PredictResponse.PredictionResult.Builder clear()

Returns
Type	Description
`PredictResponse.PredictionResult.Builder`

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearId()

public PredictResponse.PredictionResult.Builder clearId()

ID of the recommended catalog item

string id = 1;

Returns
Type	Description
`PredictResponse.PredictionResult.Builder`	This builder for chaining.

clearItemMetadata()

public PredictResponse.PredictionResult.Builder clearItemMetadata()

Returns
Type	Description
`PredictResponse.PredictionResult.Builder`

containsItemMetadata(String key)

public boolean containsItemMetadata(String key)

Additional item metadata / annotations.

Possible values:

catalogItem: JSON representation of the catalogItem. Will be set if returnCatalogItem is set to true in PredictRequest.params.
score: Prediction score in double value. Will be set if returnItemScore is set to true in PredictRequest.params.

map<string, .google.protobuf.Value> item_metadata = 2;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

getDefaultInstanceForType()

public PredictResponse.PredictionResult getDefaultInstanceForType()

Returns
Type	Description
`PredictResponse.PredictionResult`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getId()

public String getId()

ID of the recommended catalog item

string id = 1;

Returns
Type	Description
`String`	The id.

getIdBytes()

public ByteString getIdBytes()

ID of the recommended catalog item

string id = 1;

Returns
Type	Description
`ByteString`	The bytes for id.

getItemMetadata() (deprecated)

public Map<String,Value> getItemMetadata()

Use #getItemMetadataMap() instead.

Returns
Type	Description
`Map<String,Value>`

getItemMetadataCount()

public int getItemMetadataCount()

Additional item metadata / annotations.

Possible values:

catalogItem: JSON representation of the catalogItem. Will be set if returnCatalogItem is set to true in PredictRequest.params.
score: Prediction score in double value. Will be set if returnItemScore is set to true in PredictRequest.params.

map<string, .google.protobuf.Value> item_metadata = 2;

Returns
Type	Description
`int`

getItemMetadataMap()

public Map<String,Value> getItemMetadataMap()

Additional item metadata / annotations.

Possible values:

catalogItem: JSON representation of the catalogItem. Will be set if returnCatalogItem is set to true in PredictRequest.params.
score: Prediction score in double value. Will be set if returnItemScore is set to true in PredictRequest.params.

map<string, .google.protobuf.Value> item_metadata = 2;

Returns
Type	Description
`Map<String,Value>`

getItemMetadataOrDefault(String key, Value defaultValue)

public Value getItemMetadataOrDefault(String key, Value defaultValue)

Additional item metadata / annotations.

Possible values:

catalogItem: JSON representation of the catalogItem. Will be set if returnCatalogItem is set to true in PredictRequest.params.
score: Prediction score in double value. Will be set if returnItemScore is set to true in PredictRequest.params.

map<string, .google.protobuf.Value> item_metadata = 2;

Parameters
Name	Description
`key`	`String`
`defaultValue`	`Value`

Returns
Type	Description
`Value`

getItemMetadataOrThrow(String key)

public Value getItemMetadataOrThrow(String key)

Additional item metadata / annotations.

Possible values:

catalogItem: JSON representation of the catalogItem. Will be set if returnCatalogItem is set to true in PredictRequest.params.
score: Prediction score in double value. Will be set if returnItemScore is set to true in PredictRequest.params.

map<string, .google.protobuf.Value> item_metadata = 2;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`Value`

getMutableItemMetadata() (deprecated)

public Map<String,Value> getMutableItemMetadata()

Use alternate mutation accessors instead.

Returns
Type	Description
`Map<String,Value>`

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`com.google.protobuf.MapFieldReflectionAccessor`

Overrides

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

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`com.google.protobuf.MapFieldReflectionAccessor`

Overrides

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

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(PredictResponse.PredictionResult other)

public PredictResponse.PredictionResult.Builder mergeFrom(PredictResponse.PredictionResult other)

Parameter
Name	Description
`other`	`PredictResponse.PredictionResult`

Returns
Type	Description
`PredictResponse.PredictionResult.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PredictResponse.PredictionResult.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PredictResponse.PredictionResult.Builder`

Overrides

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

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public PredictResponse.PredictionResult.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`PredictResponse.PredictionResult.Builder`

Overrides

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

putAllItemMetadata(Map<String,Value> values)

public PredictResponse.PredictionResult.Builder putAllItemMetadata(Map<String,Value> values)

Additional item metadata / annotations.

Possible values:

catalogItem: JSON representation of the catalogItem. Will be set if returnCatalogItem is set to true in PredictRequest.params.
score: Prediction score in double value. Will be set if returnItemScore is set to true in PredictRequest.params.

map<string, .google.protobuf.Value> item_metadata = 2;

Parameter
Name	Description
`values`	`Map<String,Value>`

Returns
Type	Description
`PredictResponse.PredictionResult.Builder`

putItemMetadata(String key, Value value)

public PredictResponse.PredictionResult.Builder putItemMetadata(String key, Value value)

Additional item metadata / annotations.

Possible values:

catalogItem: JSON representation of the catalogItem. Will be set if returnCatalogItem is set to true in PredictRequest.params.
score: Prediction score in double value. Will be set if returnItemScore is set to true in PredictRequest.params.

map<string, .google.protobuf.Value> item_metadata = 2;

Parameters
Name	Description
`key`	`String`
`value`	`Value`

Returns
Type	Description
`PredictResponse.PredictionResult.Builder`

putItemMetadataBuilderIfAbsent(String key)

public Value.Builder putItemMetadataBuilderIfAbsent(String key)

Additional item metadata / annotations.

Possible values:

catalogItem: JSON representation of the catalogItem. Will be set if returnCatalogItem is set to true in PredictRequest.params.
score: Prediction score in double value. Will be set if returnItemScore is set to true in PredictRequest.params.

map<string, .google.protobuf.Value> item_metadata = 2;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`Builder`

removeItemMetadata(String key)

public PredictResponse.PredictionResult.Builder removeItemMetadata(String key)

Additional item metadata / annotations.

Possible values:

catalogItem: JSON representation of the catalogItem. Will be set if returnCatalogItem is set to true in PredictRequest.params.
score: Prediction score in double value. Will be set if returnItemScore is set to true in PredictRequest.params.

map<string, .google.protobuf.Value> item_metadata = 2;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`PredictResponse.PredictionResult.Builder`

setId(String value)

public PredictResponse.PredictionResult.Builder setId(String value)

ID of the recommended catalog item

string id = 1;

Parameter
Name	Description
`value`	`String` The id to set.

Returns
Type	Description
`PredictResponse.PredictionResult.Builder`	This builder for chaining.

setIdBytes(ByteString value)

public PredictResponse.PredictionResult.Builder setIdBytes(ByteString value)

ID of the recommended catalog item

string id = 1;

Parameter
Name	Description
`value`	`ByteString` The bytes for id to set.

Returns
Type	Description
`PredictResponse.PredictionResult.Builder`	This builder for chaining.