Class PredictResponse.PredictionResult.Builder (0.11.0)

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

PredictionResult represents the recommendation prediction results.

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.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)

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)

GeneratedMessageV3.Builder.internalGetMutableMapField(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

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PredictResponse.PredictionResult.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
PredictResponse.PredictionResult.Builder

Overrides

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

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

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public PredictResponse.PredictionResult.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	`FieldDescriptor`

Returns

Type	Description
PredictResponse.PredictionResult.Builder

Overrides

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

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

clearOneof(Descriptors.OneofDescriptor oneof)

public PredictResponse.PredictionResult.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	`OneofDescriptor`

Returns

Type	Description
PredictResponse.PredictionResult.Builder

Overrides

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

clone()

public PredictResponse.PredictionResult.Builder clone()

Returns

Type	Description
PredictResponse.PredictionResult.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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

GeneratedMessageV3.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()

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()

public Map<String,Value> getMutableItemMetadata()

Use alternate mutation accessors instead.

Returns

Type	Description
Map<String,Value>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter

Name	Description
number	`int`

Returns

Type	Description
MapField

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMapField(int fieldNumber)

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)

Parameter

Name	Description
number	`int`

Returns

Type	Description
MapField

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMutableMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.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)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PredictResponse.PredictionResult.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
PredictResponse.PredictionResult.Builder

Overrides

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

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

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

setField(Descriptors.FieldDescriptor field, Object value)

public PredictResponse.PredictionResult.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
PredictResponse.PredictionResult.Builder

Overrides

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

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.

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

public PredictResponse.PredictionResult.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
index	`int`
value	`Object`

Returns

Type	Description
PredictResponse.PredictionResult.Builder

Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

public final PredictResponse.PredictionResult.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
PredictResponse.PredictionResult.Builder

Overrides

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