Class PredictRequest.Builder (0.11.0)

public static final class PredictRequest.Builder extends GeneratedMessageV3.Builder<PredictRequest.Builder> implements PredictRequestOrBuilder

Request message for Predict method.

Protobuf type google.cloud.recommendationengine.v1beta1.PredictRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PredictRequest.Builder

Implements

PredictRequestOrBuilder

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 PredictRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
PredictRequest.Builder

Overrides

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

build()

public PredictRequest build()

Returns

Type	Description
PredictRequest

buildPartial()

public PredictRequest buildPartial()

Returns

Type	Description
PredictRequest

clear()

public PredictRequest.Builder clear()

Returns

Type	Description
PredictRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDryRun()

public PredictRequest.Builder clearDryRun()

Optional. Use dryRun mode for this prediction query. If set to true, a dummy model will be used that returns arbitrary catalog items. Note that the dryRun mode should only be used for testing the API, or if the model is not ready.

bool dry_run = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
PredictRequest.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public PredictRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	`FieldDescriptor`

Returns

Type	Description
PredictRequest.Builder

Overrides

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

clearFilter()

public PredictRequest.Builder clearFilter()

Optional. Filter for restricting prediction results. Accepts values for tags and the filterOutOfStockItems flag.

Tag expressions. Restricts predictions to items that match all of the specified tags. Boolean operators OR and NOT are supported if the expression is enclosed in parentheses, and must be separated from the tag values by a space. -"tagA" is also supported and is equivalent to NOT "tagA". Tag values must be double quoted UTF-8 encoded strings with a size limit of 1 KiB.
filterOutOfStockItems. Restricts predictions to items that do not have a stockState value of OUT_OF_STOCK. Examples:
tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional")
filterOutOfStockItems tag=(-"promotional")
filterOutOfStockItems

string filter = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
PredictRequest.Builder	This builder for chaining.

clearLabels()

public PredictRequest.Builder clearLabels()

Returns

Type	Description
PredictRequest.Builder

clearName()

public PredictRequest.Builder clearName()

Required. Full resource name of the format: {name=projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/*} The id of the recommendation engine placement. This id is used to identify the set of models that will be used to make the prediction. We currently support three placements with the following IDs by default:

shopping_cart: Predicts items frequently bought together with one or more catalog items in the same shopping session. Commonly displayed after add-to-cart events, on product detail pages, or on the shopping cart page.
home_page: Predicts the next product that a user will most likely engage with or purchase based on the shopping or viewing history of the specified userId or visitorId. For example - Recommendations for you.
product_detail: Predicts the next product that a user will most likely engage with or purchase. The prediction is based on the shopping or viewing history of the specified userId or visitorId and its relevance to a specified CatalogItem. Typically used on product detail pages. For example - More items like this.
recently_viewed_default: Returns up to 75 items recently viewed by the specified userId or visitorId, most recent ones first. Returns nothing if neither of them has viewed any items yet. For example - Recently viewed. The full list of available placements can be seen at https://console.cloud.google.com/recommendation/datafeeds/default_catalog/dashboard

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns

Type	Description
PredictRequest.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public PredictRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	`OneofDescriptor`

Returns

Type	Description
PredictRequest.Builder

Overrides

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

clearPageSize()

public PredictRequest.Builder clearPageSize()

Optional. Maximum number of results to return per page. Set this property to the number of prediction results required. If zero, the service will choose a reasonable default.

int32 page_size = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
PredictRequest.Builder	This builder for chaining.

clearPageToken()

public PredictRequest.Builder clearPageToken()

Optional. The previous PredictResponse.next_page_token.

string page_token = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
PredictRequest.Builder	This builder for chaining.

clearParams()

public PredictRequest.Builder clearParams()

Returns

Type	Description
PredictRequest.Builder

clearUserEvent()

public PredictRequest.Builder clearUserEvent()

Required. Context about the user, what they are looking at and what action they took to trigger the predict request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging.

.google.cloud.recommendationengine.v1beta1.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
PredictRequest.Builder

clone()

public PredictRequest.Builder clone()

Returns

Type	Description
PredictRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

containsLabels(String key)

public boolean containsLabels(String key)

Optional. The labels for the predict request.

Label keys can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit.
Non-zero label values can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit.
No more than 64 labels can be associated with a given request. See https://goo.gl/xmQnxf for more information on and examples of labels.

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
key	`String`

Returns

Type	Description
boolean

containsParams(String key)

public boolean containsParams(String key)

Optional. Additional domain specific parameters for the predictions. Allowed values:

returnCatalogItem: Boolean. If set to true, the associated catalogItem object will be returned in the PredictResponse.PredictionResult.itemMetadata object in the method response.
returnItemScore: Boolean. If set to true, the prediction 'score' corresponding to each returned item will be set in the metadata field in the prediction response. The given 'score' indicates the probability of an item being clicked/purchased given the user's context and history.

map<string, .google.protobuf.Value> params = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
key	`String`

Returns

Type	Description
boolean

getDefaultInstanceForType()

public PredictRequest getDefaultInstanceForType()

Returns

Type	Description
PredictRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDryRun()

public boolean getDryRun()

bool dry_run = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
boolean	The dryRun.

getFilter()

public String getFilter()

Optional. Filter for restricting prediction results. Accepts values for tags and the filterOutOfStockItems flag.

Tag expressions. Restricts predictions to items that match all of the specified tags. Boolean operators OR and NOT are supported if the expression is enclosed in parentheses, and must be separated from the tag values by a space. -"tagA" is also supported and is equivalent to NOT "tagA". Tag values must be double quoted UTF-8 encoded strings with a size limit of 1 KiB.
filterOutOfStockItems. Restricts predictions to items that do not have a stockState value of OUT_OF_STOCK. Examples:
tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional")
filterOutOfStockItems tag=(-"promotional")
filterOutOfStockItems

string filter = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
String	The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. Filter for restricting prediction results. Accepts values for tags and the filterOutOfStockItems flag.

Tag expressions. Restricts predictions to items that match all of the specified tags. Boolean operators OR and NOT are supported if the expression is enclosed in parentheses, and must be separated from the tag values by a space. -"tagA" is also supported and is equivalent to NOT "tagA". Tag values must be double quoted UTF-8 encoded strings with a size limit of 1 KiB.
filterOutOfStockItems. Restricts predictions to items that do not have a stockState value of OUT_OF_STOCK. Examples:
tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional")
filterOutOfStockItems tag=(-"promotional")
filterOutOfStockItems

string filter = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
ByteString	The bytes for filter.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns

Type	Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. The labels for the predict request.

Label keys can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit.
Non-zero label values can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit.
No more than 64 labels can be associated with a given request. See https://goo.gl/xmQnxf for more information on and examples of labels.

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. The labels for the predict request.

Label keys can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit.
Non-zero label values can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit.
No more than 64 labels can be associated with a given request. See https://goo.gl/xmQnxf for more information on and examples of labels.

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. The labels for the predict request.

Label keys can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit.
Non-zero label values can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit.
No more than 64 labels can be associated with a given request. See https://goo.gl/xmQnxf for more information on and examples of labels.

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameters

Name	Description
key	`String`
defaultValue	`String`

Returns

Type	Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. The labels for the predict request.

Label keys can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit.
Non-zero label values can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit.
No more than 64 labels can be associated with a given request. See https://goo.gl/xmQnxf for more information on and examples of labels.

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
key	`String`

Returns

Type	Description
String

getMutableLabels()

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns

Type	Description
Map<String,String>

getMutableParams()

public Map<String,Value> getMutableParams()

Use alternate mutation accessors instead.

Returns

Type	Description
Map<String,Value>

getName()

public String getName()

shopping_cart: Predicts items frequently bought together with one or more catalog items in the same shopping session. Commonly displayed after add-to-cart events, on product detail pages, or on the shopping cart page.
home_page: Predicts the next product that a user will most likely engage with or purchase based on the shopping or viewing history of the specified userId or visitorId. For example - Recommendations for you.
product_detail: Predicts the next product that a user will most likely engage with or purchase. The prediction is based on the shopping or viewing history of the specified userId or visitorId and its relevance to a specified CatalogItem. Typically used on product detail pages. For example - More items like this.
recently_viewed_default: Returns up to 75 items recently viewed by the specified userId or visitorId, most recent ones first. Returns nothing if neither of them has viewed any items yet. For example - Recently viewed. The full list of available placements can be seen at https://console.cloud.google.com/recommendation/datafeeds/default_catalog/dashboard

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns

Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

shopping_cart: Predicts items frequently bought together with one or more catalog items in the same shopping session. Commonly displayed after add-to-cart events, on product detail pages, or on the shopping cart page.
home_page: Predicts the next product that a user will most likely engage with or purchase based on the shopping or viewing history of the specified userId or visitorId. For example - Recommendations for you.
product_detail: Predicts the next product that a user will most likely engage with or purchase. The prediction is based on the shopping or viewing history of the specified userId or visitorId and its relevance to a specified CatalogItem. Typically used on product detail pages. For example - More items like this.
recently_viewed_default: Returns up to 75 items recently viewed by the specified userId or visitorId, most recent ones first. Returns nothing if neither of them has viewed any items yet. For example - Recently viewed. The full list of available placements can be seen at https://console.cloud.google.com/recommendation/datafeeds/default_catalog/dashboard

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns

Type	Description
ByteString	The bytes for name.

getPageSize()

public int getPageSize()

Optional. Maximum number of results to return per page. Set this property to the number of prediction results required. If zero, the service will choose a reasonable default.

int32 page_size = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
int	The pageSize.

getPageToken()

public String getPageToken()

Optional. The previous PredictResponse.next_page_token.

string page_token = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
String	The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. The previous PredictResponse.next_page_token.

string page_token = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
ByteString	The bytes for pageToken.

getParams()

public Map<String,Value> getParams()

Use #getParamsMap() instead.

Returns

Type	Description
Map<String,Value>

getParamsCount()

public int getParamsCount()

Optional. Additional domain specific parameters for the predictions. Allowed values:

returnCatalogItem: Boolean. If set to true, the associated catalogItem object will be returned in the PredictResponse.PredictionResult.itemMetadata object in the method response.
returnItemScore: Boolean. If set to true, the prediction 'score' corresponding to each returned item will be set in the metadata field in the prediction response. The given 'score' indicates the probability of an item being clicked/purchased given the user's context and history.

map<string, .google.protobuf.Value> params = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
int

getParamsMap()

public Map<String,Value> getParamsMap()

Optional. Additional domain specific parameters for the predictions. Allowed values:

returnCatalogItem: Boolean. If set to true, the associated catalogItem object will be returned in the PredictResponse.PredictionResult.itemMetadata object in the method response.
returnItemScore: Boolean. If set to true, the prediction 'score' corresponding to each returned item will be set in the metadata field in the prediction response. The given 'score' indicates the probability of an item being clicked/purchased given the user's context and history.

map<string, .google.protobuf.Value> params = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
Map<String,Value>

getParamsOrDefault(String key, Value defaultValue)

public Value getParamsOrDefault(String key, Value defaultValue)

Optional. Additional domain specific parameters for the predictions. Allowed values:

returnCatalogItem: Boolean. If set to true, the associated catalogItem object will be returned in the PredictResponse.PredictionResult.itemMetadata object in the method response.
returnItemScore: Boolean. If set to true, the prediction 'score' corresponding to each returned item will be set in the metadata field in the prediction response. The given 'score' indicates the probability of an item being clicked/purchased given the user's context and history.

map<string, .google.protobuf.Value> params = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters

Name	Description
key	`String`
defaultValue	`Value`

Returns

Type	Description
Value

getParamsOrThrow(String key)

public Value getParamsOrThrow(String key)

Optional. Additional domain specific parameters for the predictions. Allowed values:

returnCatalogItem: Boolean. If set to true, the associated catalogItem object will be returned in the PredictResponse.PredictionResult.itemMetadata object in the method response.
returnItemScore: Boolean. If set to true, the prediction 'score' corresponding to each returned item will be set in the metadata field in the prediction response. The given 'score' indicates the probability of an item being clicked/purchased given the user's context and history.

map<string, .google.protobuf.Value> params = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
key	`String`

Returns

Type	Description
Value

getUserEvent()

public UserEvent getUserEvent()

.google.cloud.recommendationengine.v1beta1.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
UserEvent	The userEvent.

getUserEventBuilder()

public UserEvent.Builder getUserEventBuilder()

.google.cloud.recommendationengine.v1beta1.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
UserEvent.Builder

getUserEventOrBuilder()

public UserEventOrBuilder getUserEventOrBuilder()

.google.cloud.recommendationengine.v1beta1.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
UserEventOrBuilder

hasUserEvent()

public boolean hasUserEvent()

.google.cloud.recommendationengine.v1beta1.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
boolean	Whether the userEvent field is set.

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

public PredictRequest.Builder mergeFrom(PredictRequest other)

Parameter

Name	Description
other	`PredictRequest`

Returns

Type	Description
PredictRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PredictRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	`CodedInputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
PredictRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public PredictRequest.Builder mergeFrom(Message other)

Parameter

Name	Description
other	`Message`

Returns

Type	Description
PredictRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PredictRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
PredictRequest.Builder

Overrides

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

mergeUserEvent(UserEvent value)

public PredictRequest.Builder mergeUserEvent(UserEvent value)

.google.cloud.recommendationengine.v1beta1.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	`UserEvent`

Returns

Type	Description
PredictRequest.Builder

putAllLabels(Map<String,String> values)

public PredictRequest.Builder putAllLabels(Map<String,String> values)

Optional. The labels for the predict request.

Label keys can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit.
Non-zero label values can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit.
No more than 64 labels can be associated with a given request. See https://goo.gl/xmQnxf for more information on and examples of labels.

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
values	`Map<String,String>`

Returns

Type	Description
PredictRequest.Builder

putAllParams(Map<String,Value> values)

public PredictRequest.Builder putAllParams(Map<String,Value> values)

Optional. Additional domain specific parameters for the predictions. Allowed values:

returnCatalogItem: Boolean. If set to true, the associated catalogItem object will be returned in the PredictResponse.PredictionResult.itemMetadata object in the method response.
returnItemScore: Boolean. If set to true, the prediction 'score' corresponding to each returned item will be set in the metadata field in the prediction response. The given 'score' indicates the probability of an item being clicked/purchased given the user's context and history.

map<string, .google.protobuf.Value> params = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
values	`Map<String,Value>`

Returns

Type	Description
PredictRequest.Builder

putLabels(String key, String value)

public PredictRequest.Builder putLabels(String key, String value)

Optional. The labels for the predict request.

Label keys can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit.
Non-zero label values can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit.
No more than 64 labels can be associated with a given request. See https://goo.gl/xmQnxf for more information on and examples of labels.

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameters

Name	Description
key	`String`
value	`String`

Returns

Type	Description
PredictRequest.Builder

putParams(String key, Value value)

public PredictRequest.Builder putParams(String key, Value value)

Optional. Additional domain specific parameters for the predictions. Allowed values:

returnCatalogItem: Boolean. If set to true, the associated catalogItem object will be returned in the PredictResponse.PredictionResult.itemMetadata object in the method response.
returnItemScore: Boolean. If set to true, the prediction 'score' corresponding to each returned item will be set in the metadata field in the prediction response. The given 'score' indicates the probability of an item being clicked/purchased given the user's context and history.

map<string, .google.protobuf.Value> params = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters

Name	Description
key	`String`
value	`Value`

Returns

Type	Description
PredictRequest.Builder

removeLabels(String key)

public PredictRequest.Builder removeLabels(String key)

Optional. The labels for the predict request.

Label keys can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit.
Non-zero label values can contain lowercase letters, digits and hyphens, must start with a letter, and must end with a letter or digit.
No more than 64 labels can be associated with a given request. See https://goo.gl/xmQnxf for more information on and examples of labels.

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
key	`String`

Returns

Type	Description
PredictRequest.Builder

removeParams(String key)

public PredictRequest.Builder removeParams(String key)

Optional. Additional domain specific parameters for the predictions. Allowed values:

returnCatalogItem: Boolean. If set to true, the associated catalogItem object will be returned in the PredictResponse.PredictionResult.itemMetadata object in the method response.
returnItemScore: Boolean. If set to true, the prediction 'score' corresponding to each returned item will be set in the metadata field in the prediction response. The given 'score' indicates the probability of an item being clicked/purchased given the user's context and history.

map<string, .google.protobuf.Value> params = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
key	`String`

Returns

Type	Description
PredictRequest.Builder

setDryRun(boolean value)

public PredictRequest.Builder setDryRun(boolean value)

bool dry_run = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	`boolean` The dryRun to set.

Returns

Type	Description
PredictRequest.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
PredictRequest.Builder

Overrides

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

setFilter(String value)

public PredictRequest.Builder setFilter(String value)

Optional. Filter for restricting prediction results. Accepts values for tags and the filterOutOfStockItems flag.

Tag expressions. Restricts predictions to items that match all of the specified tags. Boolean operators OR and NOT are supported if the expression is enclosed in parentheses, and must be separated from the tag values by a space. -"tagA" is also supported and is equivalent to NOT "tagA". Tag values must be double quoted UTF-8 encoded strings with a size limit of 1 KiB.
filterOutOfStockItems. Restricts predictions to items that do not have a stockState value of OUT_OF_STOCK. Examples:
tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional")
filterOutOfStockItems tag=(-"promotional")
filterOutOfStockItems

string filter = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	`String` The filter to set.

Returns

Type	Description
PredictRequest.Builder	This builder for chaining.

setFilterBytes(ByteString value)

public PredictRequest.Builder setFilterBytes(ByteString value)

Optional. Filter for restricting prediction results. Accepts values for tags and the filterOutOfStockItems flag.

Tag expressions. Restricts predictions to items that match all of the specified tags. Boolean operators OR and NOT are supported if the expression is enclosed in parentheses, and must be separated from the tag values by a space. -"tagA" is also supported and is equivalent to NOT "tagA". Tag values must be double quoted UTF-8 encoded strings with a size limit of 1 KiB.
filterOutOfStockItems. Restricts predictions to items that do not have a stockState value of OUT_OF_STOCK. Examples:
tag=("Red" OR "Blue") tag="New-Arrival" tag=(NOT "promotional")
filterOutOfStockItems tag=(-"promotional")
filterOutOfStockItems

string filter = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	`ByteString` The bytes for filter to set.

Returns

Type	Description
PredictRequest.Builder	This builder for chaining.

setName(String value)

public PredictRequest.Builder setName(String value)

shopping_cart: Predicts items frequently bought together with one or more catalog items in the same shopping session. Commonly displayed after add-to-cart events, on product detail pages, or on the shopping cart page.
home_page: Predicts the next product that a user will most likely engage with or purchase based on the shopping or viewing history of the specified userId or visitorId. For example - Recommendations for you.
product_detail: Predicts the next product that a user will most likely engage with or purchase. The prediction is based on the shopping or viewing history of the specified userId or visitorId and its relevance to a specified CatalogItem. Typically used on product detail pages. For example - More items like this.
recently_viewed_default: Returns up to 75 items recently viewed by the specified userId or visitorId, most recent ones first. Returns nothing if neither of them has viewed any items yet. For example - Recently viewed. The full list of available placements can be seen at https://console.cloud.google.com/recommendation/datafeeds/default_catalog/dashboard

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter

Name	Description
value	`String` The name to set.

Returns

Type	Description
PredictRequest.Builder	This builder for chaining.

setNameBytes(ByteString value)

public PredictRequest.Builder setNameBytes(ByteString value)

shopping_cart: Predicts items frequently bought together with one or more catalog items in the same shopping session. Commonly displayed after add-to-cart events, on product detail pages, or on the shopping cart page.
home_page: Predicts the next product that a user will most likely engage with or purchase based on the shopping or viewing history of the specified userId or visitorId. For example - Recommendations for you.
product_detail: Predicts the next product that a user will most likely engage with or purchase. The prediction is based on the shopping or viewing history of the specified userId or visitorId and its relevance to a specified CatalogItem. Typically used on product detail pages. For example - More items like this.
recently_viewed_default: Returns up to 75 items recently viewed by the specified userId or visitorId, most recent ones first. Returns nothing if neither of them has viewed any items yet. For example - Recently viewed. The full list of available placements can be seen at https://console.cloud.google.com/recommendation/datafeeds/default_catalog/dashboard

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter

Name	Description
value	`ByteString` The bytes for name to set.

Returns

Type	Description
PredictRequest.Builder	This builder for chaining.

setPageSize(int value)

public PredictRequest.Builder setPageSize(int value)

Optional. Maximum number of results to return per page. Set this property to the number of prediction results required. If zero, the service will choose a reasonable default.

int32 page_size = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	`int` The pageSize to set.

Returns

Type	Description
PredictRequest.Builder	This builder for chaining.

setPageToken(String value)

public PredictRequest.Builder setPageToken(String value)

Optional. The previous PredictResponse.next_page_token.

string page_token = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	`String` The pageToken to set.

Returns

Type	Description
PredictRequest.Builder	This builder for chaining.

setPageTokenBytes(ByteString value)

public PredictRequest.Builder setPageTokenBytes(ByteString value)

Optional. The previous PredictResponse.next_page_token.

string page_token = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
value	`ByteString` The bytes for pageToken to set.

Returns

Type	Description
PredictRequest.Builder	This builder for chaining.

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

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

Parameters

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

Returns

Type	Description
PredictRequest.Builder

Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

public final PredictRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
PredictRequest.Builder

Overrides

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

setUserEvent(UserEvent value)

public PredictRequest.Builder setUserEvent(UserEvent value)

.google.cloud.recommendationengine.v1beta1.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	`UserEvent`

Returns

Type	Description
PredictRequest.Builder

setUserEvent(UserEvent.Builder builderForValue)

public PredictRequest.Builder setUserEvent(UserEvent.Builder builderForValue)

.google.cloud.recommendationengine.v1beta1.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
builderForValue	`UserEvent.Builder`

Returns

Type	Description
PredictRequest.Builder