com.google.cloud.retail.v2

Class PredictRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.retail.v2.PredictRequest

All Implemented Interfaces:

PredictRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class PredictRequest
extends com.google.protobuf.GeneratedMessageV3
implements PredictRequestOrBuilder

 Request message for Predict method.
 

Protobuf type google.cloud.retail.v2.PredictRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PredictRequest.Builder Request message for Predict method.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	FILTER_FIELD_NUMBER
static int	LABELS_FIELD_NUMBER
static int	PAGE_SIZE_FIELD_NUMBER
static int	PAGE_TOKEN_FIELD_NUMBER
static int	PARAMS_FIELD_NUMBER
static int	PLACEMENT_FIELD_NUMBER
static int	USER_EVENT_FIELD_NUMBER
static int	VALIDATE_ONLY_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) The labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64.
boolean	containsParams(String key) Additional domain specific parameters for the predictions.
boolean	equals(Object obj)
static PredictRequest	getDefaultInstance()
PredictRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getFilter() Filter for restricting prediction results with a length limit of 5,000 characters.
com.google.protobuf.ByteString	getFilterBytes() Filter for restricting prediction results with a length limit of 5,000 characters.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() The labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64.
Map<String,String>	getLabelsMap() The labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64.
String	getLabelsOrDefault(String key, String defaultValue) The labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64.
String	getLabelsOrThrow(String key) The labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64.
int	getPageSize() Maximum number of results to return.
String	getPageToken() Deprecated. google.cloud.retail.v2.PredictRequest.page_token is deprecated. See google/cloud/retail/v2/prediction_service.proto;l=94
com.google.protobuf.ByteString	getPageTokenBytes() Deprecated. google.cloud.retail.v2.PredictRequest.page_token is deprecated. See google/cloud/retail/v2/prediction_service.proto;l=94
Map<String,com.google.protobuf.Value>	getParams() Deprecated.
int	getParamsCount() Additional domain specific parameters for the predictions.
Map<String,com.google.protobuf.Value>	getParamsMap() Additional domain specific parameters for the predictions.
com.google.protobuf.Value	getParamsOrDefault(String key, com.google.protobuf.Value defaultValue) Additional domain specific parameters for the predictions.
com.google.protobuf.Value	getParamsOrThrow(String key) Additional domain specific parameters for the predictions.
com.google.protobuf.Parser<PredictRequest>	getParserForType()
String	getPlacement() Required.
com.google.protobuf.ByteString	getPlacementBytes() Required.
int	getSerializedSize()
UserEvent	getUserEvent() Required.
UserEventOrBuilder	getUserEventOrBuilder() Required.
boolean	getValidateOnly() Use validate only mode for this prediction query.
int	hashCode()
boolean	hasUserEvent() Required.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static PredictRequest.Builder	newBuilder()
static PredictRequest.Builder	newBuilder(PredictRequest prototype)
PredictRequest.Builder	newBuilderForType()
protected PredictRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static PredictRequest	parseDelimitedFrom(InputStream input)
static PredictRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PredictRequest	parseFrom(byte[] data)
static PredictRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PredictRequest	parseFrom(ByteBuffer data)
static PredictRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PredictRequest	parseFrom(com.google.protobuf.ByteString data)
static PredictRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PredictRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static PredictRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static PredictRequest	parseFrom(InputStream input)
static PredictRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<PredictRequest>	parser()
PredictRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PLACEMENT_FIELD_NUMBER

public static final int PLACEMENT_FIELD_NUMBER

See Also:

Constant Field Values

USER_EVENT_FIELD_NUMBER

public static final int USER_EVENT_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER

See Also:

Constant Field Values

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

See Also:

Constant Field Values

VALIDATE_ONLY_FIELD_NUMBER

public static final int VALIDATE_ONLY_FIELD_NUMBER

See Also:

Constant Field Values

PARAMS_FIELD_NUMBER

public static final int PARAMS_FIELD_NUMBER

See Also:

Constant Field Values

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getPlacement

public String getPlacement()

 Required. Full resource name of the format:
 `{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}`
 or
 `{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`.
 We recommend using the `servingConfigs` resource. `placements` is a legacy
 resource.
 The ID of the Recommendations AI serving config or placement.
 Before you can request predictions from your model, you must create at
 least one serving config or placement for it. For more information, see
 [Manage serving configs]
 (https://cloud.google.com/retail/docs/manage-configs).

 The full list of available serving configs can be seen at
 https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs
 

string placement = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getPlacement in interface PredictRequestOrBuilder

Returns:

The placement.

getPlacementBytes

public com.google.protobuf.ByteString getPlacementBytes()

 Required. Full resource name of the format:
 `{placement=projects/*/locations/global/catalogs/default_catalog/servingConfigs/*}`
 or
 `{placement=projects/*/locations/global/catalogs/default_catalog/placements/*}`.
 We recommend using the `servingConfigs` resource. `placements` is a legacy
 resource.
 The ID of the Recommendations AI serving config or placement.
 Before you can request predictions from your model, you must create at
 least one serving config or placement for it. For more information, see
 [Manage serving configs]
 (https://cloud.google.com/retail/docs/manage-configs).

 The full list of available serving configs can be seen at
 https://console.cloud.google.com/ai/retail/catalogs/default_catalog/configs
 

string placement = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getPlacementBytes in interface PredictRequestOrBuilder

Returns:

The bytes for placement.

hasUserEvent

public boolean hasUserEvent()

 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.

 Don't set
 [UserEvent.visitor_id][google.cloud.retail.v2.UserEvent.visitor_id] or
 [UserInfo.user_id][google.cloud.retail.v2.UserInfo.user_id] to the same
 fixed ID for different users. If you are trying to receive non-personalized
 recommendations (not recommended; this can negatively impact model
 performance), instead set
 [UserEvent.visitor_id][google.cloud.retail.v2.UserEvent.visitor_id] to a
 random unique ID and leave
 [UserInfo.user_id][google.cloud.retail.v2.UserInfo.user_id] unset.
 

.google.cloud.retail.v2.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

hasUserEvent in interface PredictRequestOrBuilder

Returns:

Whether the userEvent field is set.

getUserEvent

public UserEvent getUserEvent()

 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.

 Don't set
 [UserEvent.visitor_id][google.cloud.retail.v2.UserEvent.visitor_id] or
 [UserInfo.user_id][google.cloud.retail.v2.UserInfo.user_id] to the same
 fixed ID for different users. If you are trying to receive non-personalized
 recommendations (not recommended; this can negatively impact model
 performance), instead set
 [UserEvent.visitor_id][google.cloud.retail.v2.UserEvent.visitor_id] to a
 random unique ID and leave
 [UserInfo.user_id][google.cloud.retail.v2.UserInfo.user_id] unset.
 

.google.cloud.retail.v2.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getUserEvent in interface PredictRequestOrBuilder

Returns:

The userEvent.

getUserEventOrBuilder

public UserEventOrBuilder getUserEventOrBuilder()

 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.

 Don't set
 [UserEvent.visitor_id][google.cloud.retail.v2.UserEvent.visitor_id] or
 [UserInfo.user_id][google.cloud.retail.v2.UserInfo.user_id] to the same
 fixed ID for different users. If you are trying to receive non-personalized
 recommendations (not recommended; this can negatively impact model
 performance), instead set
 [UserEvent.visitor_id][google.cloud.retail.v2.UserEvent.visitor_id] to a
 random unique ID and leave
 [UserInfo.user_id][google.cloud.retail.v2.UserInfo.user_id] unset.
 

.google.cloud.retail.v2.UserEvent user_event = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getUserEventOrBuilder in interface PredictRequestOrBuilder

getPageSize

public int getPageSize()

 Maximum number of results to return. Set this property to the number of
 prediction results needed. If zero, the service will choose a reasonable
 default. The maximum allowed value is 100. Values above 100 will be coerced
 to 100.
 

int32 page_size = 3;

Specified by:

getPageSize in interface PredictRequestOrBuilder

Returns:

The pageSize.

getPageToken

@Deprecated
public String getPageToken()

Deprecated. google.cloud.retail.v2.PredictRequest.page_token is deprecated. See google/cloud/retail/v2/prediction_service.proto;l=94

 This field is not used; leave it unset.
 

string page_token = 4 [deprecated = true];

Specified by:

getPageToken in interface PredictRequestOrBuilder

Returns:

The pageToken.

getPageTokenBytes

@Deprecated
public com.google.protobuf.ByteString getPageTokenBytes()

Deprecated. google.cloud.retail.v2.PredictRequest.page_token is deprecated. See google/cloud/retail/v2/prediction_service.proto;l=94

 This field is not used; leave it unset.
 

string page_token = 4 [deprecated = true];

Specified by:

getPageTokenBytes in interface PredictRequestOrBuilder

Returns:

The bytes for pageToken.

getFilter

public String getFilter()

 Filter for restricting prediction results with a length limit of 5,000
 characters. Accepts values for tags and the `filterOutOfStockItems` flag.

  * Tag expressions. Restricts predictions to products 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,000 characters.

    Note: "Recently viewed" models don't support tag filtering at the
    moment.

  * filterOutOfStockItems. Restricts predictions to products 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

 If your filter blocks all prediction results, the API will return *no*
 results. If instead you want empty result sets to return generic
 (unfiltered) popular products, set `strictFiltering` to False in
 `PredictRequest.params`. Note that the API will never return items with
 storageStatus of "EXPIRED" or "DELETED" regardless of filter choices.

 If `filterSyntaxV2` is set to true under the `params` field, then
 attribute-based expressions are expected instead of the above described
 tag-based syntax. Examples:

  * (colors: ANY("Red", "Blue")) AND NOT (categories: ANY("Phones"))
  * (availability: ANY("IN_STOCK")) AND
    (colors: ANY("Red") OR categories: ANY("Phones"))

 For more information, see
 [Filter recommendations](https://cloud.google.com/retail/docs/filter-recs).
 

string filter = 5;

Specified by:

getFilter in interface PredictRequestOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

 Filter for restricting prediction results with a length limit of 5,000
 characters. Accepts values for tags and the `filterOutOfStockItems` flag.

  * Tag expressions. Restricts predictions to products 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,000 characters.

    Note: "Recently viewed" models don't support tag filtering at the
    moment.

  * filterOutOfStockItems. Restricts predictions to products 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

 If your filter blocks all prediction results, the API will return *no*
 results. If instead you want empty result sets to return generic
 (unfiltered) popular products, set `strictFiltering` to False in
 `PredictRequest.params`. Note that the API will never return items with
 storageStatus of "EXPIRED" or "DELETED" regardless of filter choices.

 If `filterSyntaxV2` is set to true under the `params` field, then
 attribute-based expressions are expected instead of the above described
 tag-based syntax. Examples:

  * (colors: ANY("Red", "Blue")) AND NOT (categories: ANY("Phones"))
  * (availability: ANY("IN_STOCK")) AND
    (colors: ANY("Red") OR categories: ANY("Phones"))

 For more information, see
 [Filter recommendations](https://cloud.google.com/retail/docs/filter-recs).
 

string filter = 5;

Specified by:

getFilterBytes in interface PredictRequestOrBuilder

Returns:

The bytes for filter.

getValidateOnly

public boolean getValidateOnly()

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

bool validate_only = 6;

Specified by:

getValidateOnly in interface PredictRequestOrBuilder

Returns:

The validateOnly.

getParamsCount

public int getParamsCount()

Description copied from interface: PredictRequestOrBuilder

 Additional domain specific parameters for the predictions.

 Allowed values:

 * `returnProduct`: Boolean. If set to true, the associated product
    object will be returned in the `results.metadata` field in the
    prediction response.
 * `returnScore`: Boolean. If set to true, the prediction 'score'
    corresponding to each returned product will be set in the
    `results.metadata` field in the prediction response. The given
    'score' indicates the probability of a product being clicked/purchased
    given the user's context and history.
 * `strictFiltering`: Boolean. True by default. If set to false, the service
    will return generic (unfiltered) popular products instead of empty if
    your filter blocks all prediction results.
 * `priceRerankLevel`: String. Default empty. If set to be non-empty, then
    it needs to be one of {'no-price-reranking', 'low-price-reranking',
    'medium-price-reranking', 'high-price-reranking'}. This gives
    request-level control and adjusts prediction results based on product
    price.
 * `diversityLevel`: String. Default empty. If set to be non-empty, then
    it needs to be one of {'no-diversity', 'low-diversity',
    'medium-diversity', 'high-diversity', 'auto-diversity'}. This gives
    request-level control and adjusts prediction results based on product
    category.
 * `filterSyntaxV2`: Boolean. False by default. If set to true, the `filter`
   field is interpreteted according to the new, attribute-based syntax.
 

map<string, .google.protobuf.Value> params = 7;

Specified by:

getParamsCount in interface PredictRequestOrBuilder

containsParams

public boolean containsParams(String key)

 Additional domain specific parameters for the predictions.

 Allowed values:

 * `returnProduct`: Boolean. If set to true, the associated product
    object will be returned in the `results.metadata` field in the
    prediction response.
 * `returnScore`: Boolean. If set to true, the prediction 'score'
    corresponding to each returned product will be set in the
    `results.metadata` field in the prediction response. The given
    'score' indicates the probability of a product being clicked/purchased
    given the user's context and history.
 * `strictFiltering`: Boolean. True by default. If set to false, the service
    will return generic (unfiltered) popular products instead of empty if
    your filter blocks all prediction results.
 * `priceRerankLevel`: String. Default empty. If set to be non-empty, then
    it needs to be one of {'no-price-reranking', 'low-price-reranking',
    'medium-price-reranking', 'high-price-reranking'}. This gives
    request-level control and adjusts prediction results based on product
    price.
 * `diversityLevel`: String. Default empty. If set to be non-empty, then
    it needs to be one of {'no-diversity', 'low-diversity',
    'medium-diversity', 'high-diversity', 'auto-diversity'}. This gives
    request-level control and adjusts prediction results based on product
    category.
 * `filterSyntaxV2`: Boolean. False by default. If set to true, the `filter`
   field is interpreteted according to the new, attribute-based syntax.
 

map<string, .google.protobuf.Value> params = 7;

Specified by:

containsParams in interface PredictRequestOrBuilder

getParams

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

Deprecated.

Use getParamsMap() instead.

Specified by:

getParams in interface PredictRequestOrBuilder

getParamsMap

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

 Additional domain specific parameters for the predictions.

 Allowed values:

 * `returnProduct`: Boolean. If set to true, the associated product
    object will be returned in the `results.metadata` field in the
    prediction response.
 * `returnScore`: Boolean. If set to true, the prediction 'score'
    corresponding to each returned product will be set in the
    `results.metadata` field in the prediction response. The given
    'score' indicates the probability of a product being clicked/purchased
    given the user's context and history.
 * `strictFiltering`: Boolean. True by default. If set to false, the service
    will return generic (unfiltered) popular products instead of empty if
    your filter blocks all prediction results.
 * `priceRerankLevel`: String. Default empty. If set to be non-empty, then
    it needs to be one of {'no-price-reranking', 'low-price-reranking',
    'medium-price-reranking', 'high-price-reranking'}. This gives
    request-level control and adjusts prediction results based on product
    price.
 * `diversityLevel`: String. Default empty. If set to be non-empty, then
    it needs to be one of {'no-diversity', 'low-diversity',
    'medium-diversity', 'high-diversity', 'auto-diversity'}. This gives
    request-level control and adjusts prediction results based on product
    category.
 * `filterSyntaxV2`: Boolean. False by default. If set to true, the `filter`
   field is interpreteted according to the new, attribute-based syntax.
 

map<string, .google.protobuf.Value> params = 7;

Specified by:

getParamsMap in interface PredictRequestOrBuilder

getParamsOrDefault

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

 Additional domain specific parameters for the predictions.

 Allowed values:

 * `returnProduct`: Boolean. If set to true, the associated product
    object will be returned in the `results.metadata` field in the
    prediction response.
 * `returnScore`: Boolean. If set to true, the prediction 'score'
    corresponding to each returned product will be set in the
    `results.metadata` field in the prediction response. The given
    'score' indicates the probability of a product being clicked/purchased
    given the user's context and history.
 * `strictFiltering`: Boolean. True by default. If set to false, the service
    will return generic (unfiltered) popular products instead of empty if
    your filter blocks all prediction results.
 * `priceRerankLevel`: String. Default empty. If set to be non-empty, then
    it needs to be one of {'no-price-reranking', 'low-price-reranking',
    'medium-price-reranking', 'high-price-reranking'}. This gives
    request-level control and adjusts prediction results based on product
    price.
 * `diversityLevel`: String. Default empty. If set to be non-empty, then
    it needs to be one of {'no-diversity', 'low-diversity',
    'medium-diversity', 'high-diversity', 'auto-diversity'}. This gives
    request-level control and adjusts prediction results based on product
    category.
 * `filterSyntaxV2`: Boolean. False by default. If set to true, the `filter`
   field is interpreteted according to the new, attribute-based syntax.
 

map<string, .google.protobuf.Value> params = 7;

Specified by:

getParamsOrDefault in interface PredictRequestOrBuilder

getParamsOrThrow

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

 Additional domain specific parameters for the predictions.

 Allowed values:

 * `returnProduct`: Boolean. If set to true, the associated product
    object will be returned in the `results.metadata` field in the
    prediction response.
 * `returnScore`: Boolean. If set to true, the prediction 'score'
    corresponding to each returned product will be set in the
    `results.metadata` field in the prediction response. The given
    'score' indicates the probability of a product being clicked/purchased
    given the user's context and history.
 * `strictFiltering`: Boolean. True by default. If set to false, the service
    will return generic (unfiltered) popular products instead of empty if
    your filter blocks all prediction results.
 * `priceRerankLevel`: String. Default empty. If set to be non-empty, then
    it needs to be one of {'no-price-reranking', 'low-price-reranking',
    'medium-price-reranking', 'high-price-reranking'}. This gives
    request-level control and adjusts prediction results based on product
    price.
 * `diversityLevel`: String. Default empty. If set to be non-empty, then
    it needs to be one of {'no-diversity', 'low-diversity',
    'medium-diversity', 'high-diversity', 'auto-diversity'}. This gives
    request-level control and adjusts prediction results based on product
    category.
 * `filterSyntaxV2`: Boolean. False by default. If set to true, the `filter`
   field is interpreteted according to the new, attribute-based syntax.
 

map<string, .google.protobuf.Value> params = 7;

Specified by:

getParamsOrThrow in interface PredictRequestOrBuilder

getLabelsCount

public int getLabelsCount()

Description copied from interface: PredictRequestOrBuilder

 The labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
   characters and cannot be empty. Values can be empty and have a maximum
   length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
   underscores, and dashes. All characters must use UTF-8 encoding, and
   international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
   key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
 

map<string, string> labels = 8;

Specified by:

getLabelsCount in interface PredictRequestOrBuilder

containsLabels

public boolean containsLabels(String key)

 The labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
   characters and cannot be empty. Values can be empty and have a maximum
   length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
   underscores, and dashes. All characters must use UTF-8 encoding, and
   international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
   key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
 

map<string, string> labels = 8;

Specified by:

containsLabels in interface PredictRequestOrBuilder

getLabels

@Deprecated
public Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

Specified by:

getLabels in interface PredictRequestOrBuilder

getLabelsMap

public Map<String,String> getLabelsMap()

 The labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
   characters and cannot be empty. Values can be empty and have a maximum
   length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
   underscores, and dashes. All characters must use UTF-8 encoding, and
   international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
   key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
 

map<string, string> labels = 8;

Specified by:

getLabelsMap in interface PredictRequestOrBuilder

getLabelsOrDefault

public String getLabelsOrDefault(String key,
                                 String defaultValue)

 The labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
   characters and cannot be empty. Values can be empty and have a maximum
   length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
   underscores, and dashes. All characters must use UTF-8 encoding, and
   international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
   key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
 

map<string, string> labels = 8;

Specified by:

getLabelsOrDefault in interface PredictRequestOrBuilder

getLabelsOrThrow

public String getLabelsOrThrow(String key)

 The labels applied to a resource must meet the following requirements:

 * Each resource can have multiple labels, up to a maximum of 64.
 * Each label must be a key-value pair.
 * Keys have a minimum length of 1 character and a maximum length of 63
   characters and cannot be empty. Values can be empty and have a maximum
   length of 63 characters.
 * Keys and values can contain only lowercase letters, numeric characters,
   underscores, and dashes. All characters must use UTF-8 encoding, and
   international characters are allowed.
 * The key portion of a label must be unique. However, you can use the same
   key with multiple resources.
 * Keys must start with a lowercase letter or international character.

 See [Google Cloud
 Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
 for more details.
 

map<string, string> labels = 8;

Specified by:

getLabelsOrThrow in interface PredictRequestOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static PredictRequest parseFrom(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PredictRequest parseFrom(ByteBuffer data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PredictRequest parseFrom(com.google.protobuf.ByteString data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PredictRequest parseFrom(com.google.protobuf.ByteString data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PredictRequest parseFrom(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PredictRequest parseFrom(byte[] data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static PredictRequest parseFrom(InputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static PredictRequest parseFrom(InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static PredictRequest parseDelimitedFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static PredictRequest parseDelimitedFrom(InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseFrom

public static PredictRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static PredictRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

newBuilderForType

public PredictRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static PredictRequest.Builder newBuilder()

newBuilder

public static PredictRequest.Builder newBuilder(PredictRequest prototype)

toBuilder

public PredictRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected PredictRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static PredictRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<PredictRequest> parser()

getParserForType

public com.google.protobuf.Parser<PredictRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public PredictRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder