Class PredictResponse.Builder (0.52.0)

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

Response message for predict method.

Protobuf type google.cloud.recommendationengine.v1beta1.PredictResponse

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllItemsMissingInCatalog(Iterable<String> values)

public PredictResponse.Builder addAllItemsMissingInCatalog(Iterable<String> values)

IDs of items in the request that were missing from the catalog.

repeated string items_missing_in_catalog = 3;

Parameter
Name Description
values Iterable<String>

The itemsMissingInCatalog to add.

Returns
Type Description
PredictResponse.Builder

This builder for chaining.

addAllResults(Iterable<? extends PredictResponse.PredictionResult> values)

public PredictResponse.Builder addAllResults(Iterable<? extends PredictResponse.PredictionResult> values)

A list of recommended items. The order represents the ranking (from the most relevant item to the least).

repeated .google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult results = 1;

Parameter
Name Description
values Iterable<? extends com.google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult>
Returns
Type Description
PredictResponse.Builder

addItemsMissingInCatalog(String value)

public PredictResponse.Builder addItemsMissingInCatalog(String value)

IDs of items in the request that were missing from the catalog.

repeated string items_missing_in_catalog = 3;

Parameter
Name Description
value String

The itemsMissingInCatalog to add.

Returns
Type Description
PredictResponse.Builder

This builder for chaining.

addItemsMissingInCatalogBytes(ByteString value)

public PredictResponse.Builder addItemsMissingInCatalogBytes(ByteString value)

IDs of items in the request that were missing from the catalog.

repeated string items_missing_in_catalog = 3;

Parameter
Name Description
value ByteString

The bytes of the itemsMissingInCatalog to add.

Returns
Type Description
PredictResponse.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PredictResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PredictResponse.Builder
Overrides

addResults(PredictResponse.PredictionResult value)

public PredictResponse.Builder addResults(PredictResponse.PredictionResult value)

A list of recommended items. The order represents the ranking (from the most relevant item to the least).

repeated .google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult results = 1;

Parameter
Name Description
value PredictResponse.PredictionResult
Returns
Type Description
PredictResponse.Builder

addResults(PredictResponse.PredictionResult.Builder builderForValue)

public PredictResponse.Builder addResults(PredictResponse.PredictionResult.Builder builderForValue)

A list of recommended items. The order represents the ranking (from the most relevant item to the least).

repeated .google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult results = 1;

Parameter
Name Description
builderForValue PredictResponse.PredictionResult.Builder
Returns
Type Description
PredictResponse.Builder

addResults(int index, PredictResponse.PredictionResult value)

public PredictResponse.Builder addResults(int index, PredictResponse.PredictionResult value)

A list of recommended items. The order represents the ranking (from the most relevant item to the least).

repeated .google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult results = 1;

Parameters
Name Description
index int
value PredictResponse.PredictionResult
Returns
Type Description
PredictResponse.Builder

addResults(int index, PredictResponse.PredictionResult.Builder builderForValue)

public PredictResponse.Builder addResults(int index, PredictResponse.PredictionResult.Builder builderForValue)

A list of recommended items. The order represents the ranking (from the most relevant item to the least).

repeated .google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult results = 1;

Parameters
Name Description
index int
builderForValue PredictResponse.PredictionResult.Builder
Returns
Type Description
PredictResponse.Builder

addResultsBuilder()

public PredictResponse.PredictionResult.Builder addResultsBuilder()

A list of recommended items. The order represents the ranking (from the most relevant item to the least).

repeated .google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult results = 1;

Returns
Type Description
PredictResponse.PredictionResult.Builder

addResultsBuilder(int index)

public PredictResponse.PredictionResult.Builder addResultsBuilder(int index)

A list of recommended items. The order represents the ranking (from the most relevant item to the least).

repeated .google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult results = 1;

Parameter
Name Description
index int
Returns
Type Description
PredictResponse.PredictionResult.Builder

build()

public PredictResponse build()
Returns
Type Description
PredictResponse

buildPartial()

public PredictResponse buildPartial()
Returns
Type Description
PredictResponse

clear()

public PredictResponse.Builder clear()
Returns
Type Description
PredictResponse.Builder
Overrides

clearDryRun()

public PredictResponse.Builder clearDryRun()

True if the dryRun property was set in the request.

bool dry_run = 4;

Returns
Type Description
PredictResponse.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearItemsMissingInCatalog()

public PredictResponse.Builder clearItemsMissingInCatalog()

IDs of items in the request that were missing from the catalog.

repeated string items_missing_in_catalog = 3;

Returns
Type Description
PredictResponse.Builder

This builder for chaining.

clearMetadata()

public PredictResponse.Builder clearMetadata()
Returns
Type Description
PredictResponse.Builder

clearNextPageToken()

public PredictResponse.Builder clearNextPageToken()

If empty, the list is complete. If nonempty, the token to pass to the next request's PredictRequest.page_token.

string next_page_token = 6;

Returns
Type Description
PredictResponse.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public PredictResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
PredictResponse.Builder
Overrides

clearRecommendationToken()

public PredictResponse.Builder clearRecommendationToken()

A unique recommendation token. This should be included in the user event logs resulting from this recommendation, which enables accurate attribution of recommendation model performance.

string recommendation_token = 2;

Returns
Type Description
PredictResponse.Builder

This builder for chaining.

clearResults()

public PredictResponse.Builder clearResults()

A list of recommended items. The order represents the ranking (from the most relevant item to the least).

repeated .google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult results = 1;

Returns
Type Description
PredictResponse.Builder

clone()

public PredictResponse.Builder clone()
Returns
Type Description
PredictResponse.Builder
Overrides

containsMetadata(String key)

public boolean containsMetadata(String key)

Additional domain specific prediction response metadata.

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

Parameter
Name Description
key String
Returns
Type Description
boolean

getDefaultInstanceForType()

public PredictResponse getDefaultInstanceForType()
Returns
Type Description
PredictResponse

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDryRun()

public boolean getDryRun()

True if the dryRun property was set in the request.

bool dry_run = 4;

Returns
Type Description
boolean

The dryRun.

getItemsMissingInCatalog(int index)

public String getItemsMissingInCatalog(int index)

IDs of items in the request that were missing from the catalog.

repeated string items_missing_in_catalog = 3;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The itemsMissingInCatalog at the given index.

getItemsMissingInCatalogBytes(int index)

public ByteString getItemsMissingInCatalogBytes(int index)

IDs of items in the request that were missing from the catalog.

repeated string items_missing_in_catalog = 3;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the itemsMissingInCatalog at the given index.

getItemsMissingInCatalogCount()

public int getItemsMissingInCatalogCount()

IDs of items in the request that were missing from the catalog.

repeated string items_missing_in_catalog = 3;

Returns
Type Description
int

The count of itemsMissingInCatalog.

getItemsMissingInCatalogList()

public ProtocolStringList getItemsMissingInCatalogList()

IDs of items in the request that were missing from the catalog.

repeated string items_missing_in_catalog = 3;

Returns
Type Description
ProtocolStringList

A list containing the itemsMissingInCatalog.

getMetadata() (deprecated)

public Map<String,Value> getMetadata()

Use #getMetadataMap() instead.

Returns
Type Description
Map<String,Value>

getMetadataCount()

public int getMetadataCount()

Additional domain specific prediction response metadata.

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

Returns
Type Description
int

getMetadataMap()

public Map<String,Value> getMetadataMap()

Additional domain specific prediction response metadata.

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

Returns
Type Description
Map<String,Value>

getMetadataOrDefault(String key, Value defaultValue)

public Value getMetadataOrDefault(String key, Value defaultValue)

Additional domain specific prediction response metadata.

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

Parameters
Name Description
key String
defaultValue Value
Returns
Type Description
Value

getMetadataOrThrow(String key)

public Value getMetadataOrThrow(String key)

Additional domain specific prediction response metadata.

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

Parameter
Name Description
key String
Returns
Type Description
Value

getMutableMetadata() (deprecated)

public Map<String,Value> getMutableMetadata()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,Value>

getNextPageToken()

public String getNextPageToken()

If empty, the list is complete. If nonempty, the token to pass to the next request's PredictRequest.page_token.

string next_page_token = 6;

Returns
Type Description
String

The nextPageToken.

getNextPageTokenBytes()

public ByteString getNextPageTokenBytes()

If empty, the list is complete. If nonempty, the token to pass to the next request's PredictRequest.page_token.

string next_page_token = 6;

Returns
Type Description
ByteString

The bytes for nextPageToken.

getRecommendationToken()

public String getRecommendationToken()

A unique recommendation token. This should be included in the user event logs resulting from this recommendation, which enables accurate attribution of recommendation model performance.

string recommendation_token = 2;

Returns
Type Description
String

The recommendationToken.

getRecommendationTokenBytes()

public ByteString getRecommendationTokenBytes()

A unique recommendation token. This should be included in the user event logs resulting from this recommendation, which enables accurate attribution of recommendation model performance.

string recommendation_token = 2;

Returns
Type Description
ByteString

The bytes for recommendationToken.

getResults(int index)

public PredictResponse.PredictionResult getResults(int index)

A list of recommended items. The order represents the ranking (from the most relevant item to the least).

repeated .google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult results = 1;

Parameter
Name Description
index int
Returns
Type Description
PredictResponse.PredictionResult

getResultsBuilder(int index)

public PredictResponse.PredictionResult.Builder getResultsBuilder(int index)

A list of recommended items. The order represents the ranking (from the most relevant item to the least).

repeated .google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult results = 1;

Parameter
Name Description
index int
Returns
Type Description
PredictResponse.PredictionResult.Builder

getResultsBuilderList()

public List<PredictResponse.PredictionResult.Builder> getResultsBuilderList()

A list of recommended items. The order represents the ranking (from the most relevant item to the least).

repeated .google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult results = 1;

Returns
Type Description
List<Builder>

getResultsCount()

public int getResultsCount()

A list of recommended items. The order represents the ranking (from the most relevant item to the least).

repeated .google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult results = 1;

Returns
Type Description
int

getResultsList()

public List<PredictResponse.PredictionResult> getResultsList()

A list of recommended items. The order represents the ranking (from the most relevant item to the least).

repeated .google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult results = 1;

Returns
Type Description
List<PredictionResult>

getResultsOrBuilder(int index)

public PredictResponse.PredictionResultOrBuilder getResultsOrBuilder(int index)

A list of recommended items. The order represents the ranking (from the most relevant item to the least).

repeated .google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult results = 1;

Parameter
Name Description
index int
Returns
Type Description
PredictResponse.PredictionResultOrBuilder

getResultsOrBuilderList()

public List<? extends PredictResponse.PredictionResultOrBuilder> getResultsOrBuilderList()

A list of recommended items. The order represents the ranking (from the most relevant item to the least).

repeated .google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult results = 1;

Returns
Type Description
List<? extends com.google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResultOrBuilder>

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

public PredictResponse.Builder mergeFrom(PredictResponse other)
Parameter
Name Description
other PredictResponse
Returns
Type Description
PredictResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PredictResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PredictResponse.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public PredictResponse.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
PredictResponse.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

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

putAllMetadata(Map<String,Value> values)

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

Additional domain specific prediction response metadata.

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

Parameter
Name Description
values Map<String,Value>
Returns
Type Description
PredictResponse.Builder

putMetadata(String key, Value value)

public PredictResponse.Builder putMetadata(String key, Value value)

Additional domain specific prediction response metadata.

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

Parameters
Name Description
key String
value Value
Returns
Type Description
PredictResponse.Builder

putMetadataBuilderIfAbsent(String key)

public Value.Builder putMetadataBuilderIfAbsent(String key)

Additional domain specific prediction response metadata.

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

Parameter
Name Description
key String
Returns
Type Description
Builder

removeMetadata(String key)

public PredictResponse.Builder removeMetadata(String key)

Additional domain specific prediction response metadata.

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

Parameter
Name Description
key String
Returns
Type Description
PredictResponse.Builder

removeResults(int index)

public PredictResponse.Builder removeResults(int index)

A list of recommended items. The order represents the ranking (from the most relevant item to the least).

repeated .google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult results = 1;

Parameter
Name Description
index int
Returns
Type Description
PredictResponse.Builder

setDryRun(boolean value)

public PredictResponse.Builder setDryRun(boolean value)

True if the dryRun property was set in the request.

bool dry_run = 4;

Parameter
Name Description
value boolean

The dryRun to set.

Returns
Type Description
PredictResponse.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public PredictResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
PredictResponse.Builder
Overrides

setItemsMissingInCatalog(int index, String value)

public PredictResponse.Builder setItemsMissingInCatalog(int index, String value)

IDs of items in the request that were missing from the catalog.

repeated string items_missing_in_catalog = 3;

Parameters
Name Description
index int

The index to set the value at.

value String

The itemsMissingInCatalog to set.

Returns
Type Description
PredictResponse.Builder

This builder for chaining.

setNextPageToken(String value)

public PredictResponse.Builder setNextPageToken(String value)

If empty, the list is complete. If nonempty, the token to pass to the next request's PredictRequest.page_token.

string next_page_token = 6;

Parameter
Name Description
value String

The nextPageToken to set.

Returns
Type Description
PredictResponse.Builder

This builder for chaining.

setNextPageTokenBytes(ByteString value)

public PredictResponse.Builder setNextPageTokenBytes(ByteString value)

If empty, the list is complete. If nonempty, the token to pass to the next request's PredictRequest.page_token.

string next_page_token = 6;

Parameter
Name Description
value ByteString

The bytes for nextPageToken to set.

Returns
Type Description
PredictResponse.Builder

This builder for chaining.

setRecommendationToken(String value)

public PredictResponse.Builder setRecommendationToken(String value)

A unique recommendation token. This should be included in the user event logs resulting from this recommendation, which enables accurate attribution of recommendation model performance.

string recommendation_token = 2;

Parameter
Name Description
value String

The recommendationToken to set.

Returns
Type Description
PredictResponse.Builder

This builder for chaining.

setRecommendationTokenBytes(ByteString value)

public PredictResponse.Builder setRecommendationTokenBytes(ByteString value)

A unique recommendation token. This should be included in the user event logs resulting from this recommendation, which enables accurate attribution of recommendation model performance.

string recommendation_token = 2;

Parameter
Name Description
value ByteString

The bytes for recommendationToken to set.

Returns
Type Description
PredictResponse.Builder

This builder for chaining.

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

public PredictResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
PredictResponse.Builder
Overrides

setResults(int index, PredictResponse.PredictionResult value)

public PredictResponse.Builder setResults(int index, PredictResponse.PredictionResult value)

A list of recommended items. The order represents the ranking (from the most relevant item to the least).

repeated .google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult results = 1;

Parameters
Name Description
index int
value PredictResponse.PredictionResult
Returns
Type Description
PredictResponse.Builder

setResults(int index, PredictResponse.PredictionResult.Builder builderForValue)

public PredictResponse.Builder setResults(int index, PredictResponse.PredictionResult.Builder builderForValue)

A list of recommended items. The order represents the ranking (from the most relevant item to the least).

repeated .google.cloud.recommendationengine.v1beta1.PredictResponse.PredictionResult results = 1;

Parameters
Name Description
index int
builderForValue PredictResponse.PredictionResult.Builder
Returns
Type Description
PredictResponse.Builder

setUnknownFields(UnknownFieldSet unknownFields)

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