Class PredictResponse.PredictionResult.Builder (0.53.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

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

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

clearField(Descriptors.FieldDescriptor field)

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

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

clone()

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

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 GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PredictResponse.PredictionResult.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
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
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

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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