Class PredictResponse.PredictionResult.Builder

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PredictResponse.PredictionResult.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PredictResponse.PredictionResult.Builder
Overrides

build()

public PredictResponse.PredictionResult build()
Returns
TypeDescription
PredictResponse.PredictionResult

buildPartial()

public PredictResponse.PredictionResult buildPartial()
Returns
TypeDescription
PredictResponse.PredictionResult

clear()

public PredictResponse.PredictionResult.Builder clear()
Returns
TypeDescription
PredictResponse.PredictionResult.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public PredictResponse.PredictionResult.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
PredictResponse.PredictionResult.Builder
Overrides

clearId()

public PredictResponse.PredictionResult.Builder clearId()

ID of the recommended catalog item

string id = 1;

Returns
TypeDescription
PredictResponse.PredictionResult.Builder

This builder for chaining.

clearItemMetadata()

public PredictResponse.PredictionResult.Builder clearItemMetadata()
Returns
TypeDescription
PredictResponse.PredictionResult.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public PredictResponse.PredictionResult.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
PredictResponse.PredictionResult.Builder
Overrides

clone()

public PredictResponse.PredictionResult.Builder clone()
Returns
TypeDescription
PredictResponse.PredictionResult.Builder
Overrides

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
NameDescription
keyString
Returns
TypeDescription
boolean

getDefaultInstanceForType()

public PredictResponse.PredictionResult getDefaultInstanceForType()
Returns
TypeDescription
PredictResponse.PredictionResult

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getId()

public String getId()

ID of the recommended catalog item

string id = 1;

Returns
TypeDescription
String

The id.

getIdBytes()

public ByteString getIdBytes()

ID of the recommended catalog item

string id = 1;

Returns
TypeDescription
ByteString

The bytes for id.

getItemMetadata()

public Map<String,Value> getItemMetadata()

Use #getItemMetadataMap() instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueValue
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
Value

getMutableItemMetadata()

public Map<String,Value> getMutableItemMetadata()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,Value>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(PredictResponse.PredictionResult other)

public PredictResponse.PredictionResult.Builder mergeFrom(PredictResponse.PredictionResult other)
Parameter
NameDescription
otherPredictResponse.PredictionResult
Returns
TypeDescription
PredictResponse.PredictionResult.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PredictResponse.PredictionResult.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PredictResponse.PredictionResult.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public PredictResponse.PredictionResult.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
PredictResponse.PredictionResult.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PredictResponse.PredictionResult.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PredictResponse.PredictionResult.Builder
Overrides

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
NameDescription
valuesMap<String,Value>
Returns
TypeDescription
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
NameDescription
keyString
valueValue
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
PredictResponse.PredictionResult.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public PredictResponse.PredictionResult.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PredictResponse.PredictionResult.Builder
Overrides

setId(String value)

public PredictResponse.PredictionResult.Builder setId(String value)

ID of the recommended catalog item

string id = 1;

Parameter
NameDescription
valueString

The id to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for id to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
PredictResponse.PredictionResult.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final PredictResponse.PredictionResult.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PredictResponse.PredictionResult.Builder
Overrides