com.google.cloud.retail.v2

Class PredictResponse.PredictionResult.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<PredictResponse.PredictionResult.Builder>

com.google.cloud.retail.v2.PredictResponse.PredictionResult.Builder

All Implemented Interfaces:

PredictResponse.PredictionResultOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

PredictResponse.PredictionResult

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

 PredictionResult represents the recommendation prediction results.
 

Protobuf type google.cloud.retail.v2.PredictResponse.PredictionResult

Method Summary

Modifier and Type	Method and Description
PredictResponse.PredictionResult.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
PredictResponse.PredictionResult	build()
PredictResponse.PredictionResult	buildPartial()
PredictResponse.PredictionResult.Builder	clear()
PredictResponse.PredictionResult.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
PredictResponse.PredictionResult.Builder	clearId() ID of the recommended product
PredictResponse.PredictionResult.Builder	clearMetadata()
PredictResponse.PredictionResult.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
PredictResponse.PredictionResult.Builder	clone()
boolean	containsMetadata(String key) Additional product metadata / annotations.
PredictResponse.PredictionResult	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getId() ID of the recommended product
com.google.protobuf.ByteString	getIdBytes() ID of the recommended product
Map<String,com.google.protobuf.Value>	getMetadata() Deprecated.
int	getMetadataCount() Additional product metadata / annotations.
Map<String,com.google.protobuf.Value>	getMetadataMap() Additional product metadata / annotations.
com.google.protobuf.Value	getMetadataOrDefault(String key, com.google.protobuf.Value defaultValue) Additional product metadata / annotations.
com.google.protobuf.Value	getMetadataOrThrow(String key) Additional product metadata / annotations.
Map<String,com.google.protobuf.Value>	getMutableMetadata() Deprecated.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
protected com.google.protobuf.MapField	internalGetMutableMapField(int number)
boolean	isInitialized()
PredictResponse.PredictionResult.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
PredictResponse.PredictionResult.Builder	mergeFrom(com.google.protobuf.Message other)
PredictResponse.PredictionResult.Builder	mergeFrom(PredictResponse.PredictionResult other)
PredictResponse.PredictionResult.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
PredictResponse.PredictionResult.Builder	putAllMetadata(Map<String,com.google.protobuf.Value> values) Additional product metadata / annotations.
PredictResponse.PredictionResult.Builder	putMetadata(String key, com.google.protobuf.Value value) Additional product metadata / annotations.
PredictResponse.PredictionResult.Builder	removeMetadata(String key) Additional product metadata / annotations.
PredictResponse.PredictionResult.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
PredictResponse.PredictionResult.Builder	setId(String value) ID of the recommended product
PredictResponse.PredictionResult.Builder	setIdBytes(com.google.protobuf.ByteString value) ID of the recommended product
PredictResponse.PredictionResult.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
PredictResponse.PredictionResult.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapFieldReflection, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<PredictResponse.PredictionResult.Builder>

internalGetMutableMapField

protected com.google.protobuf.MapField internalGetMutableMapField(int number)

Overrides:

internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<PredictResponse.PredictionResult.Builder>

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<PredictResponse.PredictionResult.Builder>

clear

public PredictResponse.PredictionResult.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<PredictResponse.PredictionResult.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<PredictResponse.PredictionResult.Builder>

getDefaultInstanceForType

public PredictResponse.PredictionResult getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public PredictResponse.PredictionResult build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public PredictResponse.PredictionResult buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public PredictResponse.PredictionResult.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<PredictResponse.PredictionResult.Builder>

setField

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

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<PredictResponse.PredictionResult.Builder>

clearField

public PredictResponse.PredictionResult.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<PredictResponse.PredictionResult.Builder>

clearOneof

public PredictResponse.PredictionResult.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<PredictResponse.PredictionResult.Builder>

setRepeatedField

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

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PredictResponse.PredictionResult.Builder>

addRepeatedField

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

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<PredictResponse.PredictionResult.Builder>

mergeFrom

public PredictResponse.PredictionResult.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PredictResponse.PredictionResult.Builder>

mergeFrom

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<PredictResponse.PredictionResult.Builder>

mergeFrom

public PredictResponse.PredictionResult.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PredictResponse.PredictionResult.Builder>

Throws:

IOException

getId

public String getId()

 ID of the recommended product
 

string id = 1;

Specified by:

getId in interface PredictResponse.PredictionResultOrBuilder

Returns:

The id.

getIdBytes

public com.google.protobuf.ByteString getIdBytes()

 ID of the recommended product
 

string id = 1;

Specified by:

getIdBytes in interface PredictResponse.PredictionResultOrBuilder

Returns:

The bytes for id.

setId

public PredictResponse.PredictionResult.Builder setId(String value)

 ID of the recommended product
 

string id = 1;

Parameters:

value - The id to set.

Returns:

This builder for chaining.

clearId

public PredictResponse.PredictionResult.Builder clearId()

 ID of the recommended product
 

string id = 1;

Returns:

This builder for chaining.

setIdBytes

public PredictResponse.PredictionResult.Builder setIdBytes(com.google.protobuf.ByteString value)

 ID of the recommended product
 

string id = 1;

Parameters:

value - The bytes for id to set.

Returns:

This builder for chaining.

getMetadataCount

public int getMetadataCount()

Description copied from interface: PredictResponse.PredictionResultOrBuilder

 Additional product metadata / annotations.

 Possible values:

 * `product`: JSON representation of the product. Is set if
   `returnProduct` is set to true in `PredictRequest.params`.
 * `score`: Prediction score in double value. Is set if
   `returnScore` is set to true in `PredictRequest.params`.
 

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

Specified by:

getMetadataCount in interface PredictResponse.PredictionResultOrBuilder

containsMetadata

public boolean containsMetadata(String key)

 Additional product metadata / annotations.

 Possible values:

 * `product`: JSON representation of the product. Is set if
   `returnProduct` is set to true in `PredictRequest.params`.
 * `score`: Prediction score in double value. Is set if
   `returnScore` is set to true in `PredictRequest.params`.
 

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

Specified by:

containsMetadata in interface PredictResponse.PredictionResultOrBuilder

getMetadata

@Deprecated
public Map<String,com.google.protobuf.Value> getMetadata()

Deprecated.

Use getMetadataMap() instead.

Specified by:

getMetadata in interface PredictResponse.PredictionResultOrBuilder

getMetadataMap

public Map<String,com.google.protobuf.Value> getMetadataMap()

 Additional product metadata / annotations.

 Possible values:

 * `product`: JSON representation of the product. Is set if
   `returnProduct` is set to true in `PredictRequest.params`.
 * `score`: Prediction score in double value. Is set if
   `returnScore` is set to true in `PredictRequest.params`.
 

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

Specified by:

getMetadataMap in interface PredictResponse.PredictionResultOrBuilder

getMetadataOrDefault

public com.google.protobuf.Value getMetadataOrDefault(String key,
                                                      com.google.protobuf.Value defaultValue)

 Additional product metadata / annotations.

 Possible values:

 * `product`: JSON representation of the product. Is set if
   `returnProduct` is set to true in `PredictRequest.params`.
 * `score`: Prediction score in double value. Is set if
   `returnScore` is set to true in `PredictRequest.params`.
 

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

Specified by:

getMetadataOrDefault in interface PredictResponse.PredictionResultOrBuilder

getMetadataOrThrow

public com.google.protobuf.Value getMetadataOrThrow(String key)

 Additional product metadata / annotations.

 Possible values:

 * `product`: JSON representation of the product. Is set if
   `returnProduct` is set to true in `PredictRequest.params`.
 * `score`: Prediction score in double value. Is set if
   `returnScore` is set to true in `PredictRequest.params`.
 

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

Specified by:

getMetadataOrThrow in interface PredictResponse.PredictionResultOrBuilder

clearMetadata

public PredictResponse.PredictionResult.Builder clearMetadata()

removeMetadata

public PredictResponse.PredictionResult.Builder removeMetadata(String key)

 Additional product metadata / annotations.

 Possible values:

 * `product`: JSON representation of the product. Is set if
   `returnProduct` is set to true in `PredictRequest.params`.
 * `score`: Prediction score in double value. Is set if
   `returnScore` is set to true in `PredictRequest.params`.
 

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

getMutableMetadata

@Deprecated
public Map<String,com.google.protobuf.Value> getMutableMetadata()

Deprecated.

Use alternate mutation accessors instead.

putMetadata

public PredictResponse.PredictionResult.Builder putMetadata(String key,
                                                            com.google.protobuf.Value value)

 Additional product metadata / annotations.

 Possible values:

 * `product`: JSON representation of the product. Is set if
   `returnProduct` is set to true in `PredictRequest.params`.
 * `score`: Prediction score in double value. Is set if
   `returnScore` is set to true in `PredictRequest.params`.
 

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

putAllMetadata

public PredictResponse.PredictionResult.Builder putAllMetadata(Map<String,com.google.protobuf.Value> values)

 Additional product metadata / annotations.

 Possible values:

 * `product`: JSON representation of the product. Is set if
   `returnProduct` is set to true in `PredictRequest.params`.
 * `score`: Prediction score in double value. Is set if
   `returnScore` is set to true in `PredictRequest.params`.
 

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

setUnknownFields

public final PredictResponse.PredictionResult.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PredictResponse.PredictionResult.Builder>

mergeUnknownFields

public final PredictResponse.PredictionResult.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<PredictResponse.PredictionResult.Builder>