labels__ =
input.readMessage(
LabelsDefaultEntryHolder.defaultEntry.getParserForType(),
extensionRegistry);
internalGetMutableLabels()
.getMutableMap()
.put(labels__.getKey(), labels__.getValue());
bitField0_ |= 0x00000080;
break;
} // case 74
default:
{
if (!super.parseUnknownField(input, extensionRegistry, tag)) {
done = true; // was an endgroup tag
}
break;
} // default:
} // switch (tag)
} // while (!done)
} catch (com.google.protobuf.InvalidProtocolBufferException e) {
throw e.unwrapIOException();
} finally {
onChanged();
} // finally
return this;
}
private int bitField0_;
private java.lang.Object name_ = "";
/**
*
*
*
* 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) = { ... }
*
*
* @return The name.
*/
public java.lang.String getName() {
java.lang.Object ref = name_;
if (!(ref instanceof java.lang.String)) {
com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
java.lang.String s = bs.toStringUtf8();
name_ = s;
return s;
} else {
return (java.lang.String) ref;
}
}
/**
*
*
*
* 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) = { ... }
*
*
* @return The bytes for name.
*/
public com.google.protobuf.ByteString getNameBytes() {
java.lang.Object ref = name_;
if (ref instanceof String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
name_ = b;
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
/**
*
*
*
* 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) = { ... }
*
*
* @param value The name to set.
* @return This builder for chaining.
*/
public Builder setName(java.lang.String value) {
if (value == null) {
throw new NullPointerException();
}
name_ = value;
bitField0_ |= 0x00000001;
onChanged();
return this;
}
/**
*
*
*
* 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) = { ... }
*
*
* @return This builder for chaining.
*/
public Builder clearName() {
name_ = getDefaultInstance().getName();
bitField0_ = (bitField0_ & ~0x00000001);
onChanged();
return this;
}
/**
*
*
*
* 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) = { ... }
*
*
* @param value The bytes for name to set.
* @return This builder for chaining.
*/
public Builder setNameBytes(com.google.protobuf.ByteString value) {
if (value == null) {
throw new NullPointerException();
}
checkByteStringIsUtf8(value);
name_ = value;
bitField0_ |= 0x00000001;
onChanged();
return this;
}
private com.google.cloud.recommendationengine.v1beta1.UserEvent userEvent_;
private com.google.protobuf.SingleFieldBuilderV3<
com.google.cloud.recommendationengine.v1beta1.UserEvent,
com.google.cloud.recommendationengine.v1beta1.UserEvent.Builder,
com.google.cloud.recommendationengine.v1beta1.UserEventOrBuilder>
userEventBuilder_;
/**
*
*
*
* 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];
*
*
* @return Whether the userEvent field is set.
*/
public boolean hasUserEvent() {
return ((bitField0_ & 0x00000002) != 0);
}
/**
*
*
*
* 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];
*
*
* @return The userEvent.
*/
public com.google.cloud.recommendationengine.v1beta1.UserEvent getUserEvent() {
if (userEventBuilder_ == null) {
return userEvent_ == null
? com.google.cloud.recommendationengine.v1beta1.UserEvent.getDefaultInstance()
: userEvent_;
} else {
return userEventBuilder_.getMessage();
}
}
/**
*
*
*
* 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];
*
*/
public Builder setUserEvent(com.google.cloud.recommendationengine.v1beta1.UserEvent value) {
if (userEventBuilder_ == null) {
if (value == null) {
throw new NullPointerException();
}
userEvent_ = value;
} else {
userEventBuilder_.setMessage(value);
}
bitField0_ |= 0x00000002;
onChanged();
return this;
}
/**
*
*
*
* 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];
*
*/
public Builder setUserEvent(
com.google.cloud.recommendationengine.v1beta1.UserEvent.Builder builderForValue) {
if (userEventBuilder_ == null) {
userEvent_ = builderForValue.build();
} else {
userEventBuilder_.setMessage(builderForValue.build());
}
bitField0_ |= 0x00000002;
onChanged();
return this;
}
/**
*
*
*
* 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];
*
*/
public Builder mergeUserEvent(com.google.cloud.recommendationengine.v1beta1.UserEvent value) {
if (userEventBuilder_ == null) {
if (((bitField0_ & 0x00000002) != 0)
&& userEvent_ != null
&& userEvent_
!= com.google.cloud.recommendationengine.v1beta1.UserEvent.getDefaultInstance()) {
getUserEventBuilder().mergeFrom(value);
} else {
userEvent_ = value;
}
} else {
userEventBuilder_.mergeFrom(value);
}
bitField0_ |= 0x00000002;
onChanged();
return this;
}
/**
*
*
*
* 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];
*
*/
public Builder clearUserEvent() {
bitField0_ = (bitField0_ & ~0x00000002);
userEvent_ = null;
if (userEventBuilder_ != null) {
userEventBuilder_.dispose();
userEventBuilder_ = null;
}
onChanged();
return this;
}
/**
*
*
*
* 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];
*
*/
public com.google.cloud.recommendationengine.v1beta1.UserEvent.Builder getUserEventBuilder() {
bitField0_ |= 0x00000002;
onChanged();
return getUserEventFieldBuilder().getBuilder();
}
/**
*
*
*
* 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];
*
*/
public com.google.cloud.recommendationengine.v1beta1.UserEventOrBuilder
getUserEventOrBuilder() {
if (userEventBuilder_ != null) {
return userEventBuilder_.getMessageOrBuilder();
} else {
return userEvent_ == null
? com.google.cloud.recommendationengine.v1beta1.UserEvent.getDefaultInstance()
: userEvent_;
}
}
/**
*
*
*
* 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];
*
*/
private com.google.protobuf.SingleFieldBuilderV3<
com.google.cloud.recommendationengine.v1beta1.UserEvent,
com.google.cloud.recommendationengine.v1beta1.UserEvent.Builder,
com.google.cloud.recommendationengine.v1beta1.UserEventOrBuilder>
getUserEventFieldBuilder() {
if (userEventBuilder_ == null) {
userEventBuilder_ =
new com.google.protobuf.SingleFieldBuilderV3<
com.google.cloud.recommendationengine.v1beta1.UserEvent,
com.google.cloud.recommendationengine.v1beta1.UserEvent.Builder,
com.google.cloud.recommendationengine.v1beta1.UserEventOrBuilder>(
getUserEvent(), getParentForChildren(), isClean());
userEvent_ = null;
}
return userEventBuilder_;
}
private int pageSize_;
/**
*
*
*
* 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];
*
* @return The pageSize.
*/
@java.lang.Override
public int getPageSize() {
return pageSize_;
}
/**
*
*
*
* 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];
*
* @param value The pageSize to set.
* @return This builder for chaining.
*/
public Builder setPageSize(int value) {
pageSize_ = value;
bitField0_ |= 0x00000004;
onChanged();
return this;
}
/**
*
*
*
* 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];
*
* @return This builder for chaining.
*/
public Builder clearPageSize() {
bitField0_ = (bitField0_ & ~0x00000004);
pageSize_ = 0;
onChanged();
return this;
}
private java.lang.Object pageToken_ = "";
/**
*
*
*
* Optional. The previous PredictResponse.next_page_token.
*
*
* string page_token = 8 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The pageToken.
*/
public java.lang.String getPageToken() {
java.lang.Object ref = pageToken_;
if (!(ref instanceof java.lang.String)) {
com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
java.lang.String s = bs.toStringUtf8();
pageToken_ = s;
return s;
} else {
return (java.lang.String) ref;
}
}
/**
*
*
*
* Optional. The previous PredictResponse.next_page_token.
*
*
* string page_token = 8 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for pageToken.
*/
public com.google.protobuf.ByteString getPageTokenBytes() {
java.lang.Object ref = pageToken_;
if (ref instanceof String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
pageToken_ = b;
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
/**
*
*
*
* Optional. The previous PredictResponse.next_page_token.
*
*
* string page_token = 8 [(.google.api.field_behavior) = OPTIONAL];
*
* @param value The pageToken to set.
* @return This builder for chaining.
*/
public Builder setPageToken(java.lang.String value) {
if (value == null) {
throw new NullPointerException();
}
pageToken_ = value;
bitField0_ |= 0x00000008;
onChanged();
return this;
}
/**
*
*
*
* Optional. The previous PredictResponse.next_page_token.
*
*
* string page_token = 8 [(.google.api.field_behavior) = OPTIONAL];
*
* @return This builder for chaining.
*/
public Builder clearPageToken() {
pageToken_ = getDefaultInstance().getPageToken();
bitField0_ = (bitField0_ & ~0x00000008);
onChanged();
return this;
}
/**
*
*
*
* Optional. The previous PredictResponse.next_page_token.
*
*
* string page_token = 8 [(.google.api.field_behavior) = OPTIONAL];
*
* @param value The bytes for pageToken to set.
* @return This builder for chaining.
*/
public Builder setPageTokenBytes(com.google.protobuf.ByteString value) {
if (value == null) {
throw new NullPointerException();
}
checkByteStringIsUtf8(value);
pageToken_ = value;
bitField0_ |= 0x00000008;
onChanged();
return this;
}
private java.lang.Object filter_ = "";
/**
*
*
*
* 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];
*
* @return The filter.
*/
public java.lang.String getFilter() {
java.lang.Object ref = filter_;
if (!(ref instanceof java.lang.String)) {
com.google.protobuf.ByteString bs = (com.google.protobuf.ByteString) ref;
java.lang.String s = bs.toStringUtf8();
filter_ = s;
return s;
} else {
return (java.lang.String) ref;
}
}
/**
*
*
*
* 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];
*
* @return The bytes for filter.
*/
public com.google.protobuf.ByteString getFilterBytes() {
java.lang.Object ref = filter_;
if (ref instanceof String) {
com.google.protobuf.ByteString b =
com.google.protobuf.ByteString.copyFromUtf8((java.lang.String) ref);
filter_ = b;
return b;
} else {
return (com.google.protobuf.ByteString) ref;
}
}
/**
*
*
*
* 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];
*
* @param value The filter to set.
* @return This builder for chaining.
*/
public Builder setFilter(java.lang.String value) {
if (value == null) {
throw new NullPointerException();
}
filter_ = value;
bitField0_ |= 0x00000010;
onChanged();
return this;
}
/**
*
*
*
* 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];
*
* @return This builder for chaining.
*/
public Builder clearFilter() {
filter_ = getDefaultInstance().getFilter();
bitField0_ = (bitField0_ & ~0x00000010);
onChanged();
return this;
}
/**
*
*
*
* 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];
*
* @param value The bytes for filter to set.
* @return This builder for chaining.
*/
public Builder setFilterBytes(com.google.protobuf.ByteString value) {
if (value == null) {
throw new NullPointerException();
}
checkByteStringIsUtf8(value);
filter_ = value;
bitField0_ |= 0x00000010;
onChanged();
return this;
}
private boolean dryRun_;
/**
*
*
*
* 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];
*
* @return The dryRun.
*/
@java.lang.Override
public boolean getDryRun() {
return dryRun_;
}
/**
*
*
*
* 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];
*
* @param value The dryRun to set.
* @return This builder for chaining.
*/
public Builder setDryRun(boolean value) {
dryRun_ = value;
bitField0_ |= 0x00000020;
onChanged();
return this;
}
/**
*
*
*
* 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];
*
* @return This builder for chaining.
*/
public Builder clearDryRun() {
bitField0_ = (bitField0_ & ~0x00000020);
dryRun_ = false;
onChanged();
return this;
}
private com.google.protobuf.MapField params_;
private com.google.protobuf.MapField
internalGetParams() {
if (params_ == null) {
return com.google.protobuf.MapField.emptyMapField(ParamsDefaultEntryHolder.defaultEntry);
}
return params_;
}
private com.google.protobuf.MapField
internalGetMutableParams() {
if (params_ == null) {
params_ = com.google.protobuf.MapField.newMapField(ParamsDefaultEntryHolder.defaultEntry);
}
if (!params_.isMutable()) {
params_ = params_.copy();
}
bitField0_ |= 0x00000040;
onChanged();
return params_;
}
public int getParamsCount() {
return internalGetParams().getMap().size();
}
/**
*
*
*
* 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];
*
*/
@java.lang.Override
public boolean containsParams(java.lang.String key) {
if (key == null) {
throw new NullPointerException("map key");
}
return internalGetParams().getMap().containsKey(key);
}
/** Use {@link #getParamsMap()} instead. */
@java.lang.Override
@java.lang.Deprecated
public java.util.Map getParams() {
return 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];
*
*/
@java.lang.Override
public java.util.Map getParamsMap() {
return internalGetParams().getMap();
}
/**
*
*
*
* 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];
*
*/
@java.lang.Override
public /* nullable */ com.google.protobuf.Value getParamsOrDefault(
java.lang.String key,
/* nullable */
com.google.protobuf.Value defaultValue) {
if (key == null) {
throw new NullPointerException("map key");
}
java.util.Map map = internalGetParams().getMap();
return map.containsKey(key) ? map.get(key) : 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];
*
*/
@java.lang.Override
public com.google.protobuf.Value getParamsOrThrow(java.lang.String key) {
if (key == null) {
throw new NullPointerException("map key");
}
java.util.Map map = internalGetParams().getMap();
if (!map.containsKey(key)) {
throw new java.lang.IllegalArgumentException();
}
return map.get(key);
}
public Builder clearParams() {
bitField0_ = (bitField0_ & ~0x00000040);
internalGetMutableParams().getMutableMap().clear();
return this;
}
/**
*
*
*
* 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];
*
*/
public Builder removeParams(java.lang.String key) {
if (key == null) {
throw new NullPointerException("map key");
}
internalGetMutableParams().getMutableMap().remove(key);
return this;
}
/** Use alternate mutation accessors instead. */
@java.lang.Deprecated
public java.util.Map getMutableParams() {
bitField0_ |= 0x00000040;
return internalGetMutableParams().getMutableMap();
}
/**
*
*
*
* 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];
*
*/
public Builder putParams(java.lang.String key, com.google.protobuf.Value value) {
if (key == null) {
throw new NullPointerException("map key");
}
if (value == null) {
throw new NullPointerException("map value");
}
internalGetMutableParams().getMutableMap().put(key, value);
bitField0_ |= 0x00000040;
return this;
}
/**
*
*
*
* 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];
*
*/
public Builder putAllParams(java.util.Map values) {
internalGetMutableParams().getMutableMap().putAll(values);
bitField0_ |= 0x00000040;
return this;
}
private com.google.protobuf.MapField labels_;
private com.google.protobuf.MapField internalGetLabels() {
if (labels_ == null) {
return com.google.protobuf.MapField.emptyMapField(LabelsDefaultEntryHolder.defaultEntry);
}
return labels_;
}
private com.google.protobuf.MapField
internalGetMutableLabels() {
if (labels_ == null) {
labels_ = com.google.protobuf.MapField.newMapField(LabelsDefaultEntryHolder.defaultEntry);
}
if (!labels_.isMutable()) {
labels_ = labels_.copy();
}
bitField0_ |= 0x00000080;
onChanged();
return labels_;
}
public int getLabelsCount() {
return internalGetLabels().getMap().size();
}
/**
*
*
*
* 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];
*/
@java.lang.Override
public boolean containsLabels(java.lang.String key) {
if (key == null) {
throw new NullPointerException("map key");
}
return internalGetLabels().getMap().containsKey(key);
}
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Override
@java.lang.Deprecated
public java.util.Map getLabels() {
return 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];
*/
@java.lang.Override
public java.util.Map getLabelsMap() {
return internalGetLabels().getMap();
}
/**
*
*
*
* 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];
*/
@java.lang.Override
public /* nullable */ java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue) {
if (key == null) {
throw new NullPointerException("map key");
}
java.util.Map map = internalGetLabels().getMap();
return map.containsKey(key) ? map.get(key) : 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];
*/
@java.lang.Override
public java.lang.String getLabelsOrThrow(java.lang.String key) {
if (key == null) {
throw new NullPointerException("map key");
}
java.util.Map map = internalGetLabels().getMap();
if (!map.containsKey(key)) {
throw new java.lang.IllegalArgumentException();
}
return map.get(key);
}
public Builder clearLabels() {
bitField0_ = (bitField0_ & ~0x00000080);
internalGetMutableLabels().getMutableMap().clear();
return this;
}
/**
*
*
*
* 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];
*/
public Builder removeLabels(java.lang.String key) {
if (key == null) {
throw new NullPointerException("map key");
}
internalGetMutableLabels().getMutableMap().remove(key);
return this;
}
/** Use alternate mutation accessors instead. */
@java.lang.Deprecated
public java.util.Map getMutableLabels() {
bitField0_ |= 0x00000080;
return internalGetMutableLabels().getMutableMap();
}
/**
*
*
*
* 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];
*/
public Builder putLabels(java.lang.String key, java.lang.String value) {
if (key == null) {
throw new NullPointerException("map key");
}
if (value == null) {
throw new NullPointerException("map value");
}
internalGetMutableLabels().getMutableMap().put(key, value);
bitField0_ |= 0x00000080;
return this;
}
/**
*
*
*
* 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];
*/
public Builder putAllLabels(java.util.Map values) {
internalGetMutableLabels().getMutableMap().putAll(values);
bitField0_ |= 0x00000080;
return this;
}
@java.lang.Override
public final Builder setUnknownFields(final com.google.protobuf.UnknownFieldSet unknownFields) {
return super.setUnknownFields(unknownFields);
}
@java.lang.Override
public final Builder mergeUnknownFields(
final com.google.protobuf.UnknownFieldSet unknownFields) {
return super.mergeUnknownFields(unknownFields);
}
// @@protoc_insertion_point(builder_scope:google.cloud.recommendationengine.v1beta1.PredictRequest)
}
// @@protoc_insertion_point(class_scope:google.cloud.recommendationengine.v1beta1.PredictRequest)
private static final com.google.cloud.recommendationengine.v1beta1.PredictRequest
DEFAULT_INSTANCE;
static {
DEFAULT_INSTANCE = new com.google.cloud.recommendationengine.v1beta1.PredictRequest();
}
public static com.google.cloud.recommendationengine.v1beta1.PredictRequest getDefaultInstance() {
return DEFAULT_INSTANCE;
}
private static final com.google.protobuf.Parser PARSER =
new com.google.protobuf.AbstractParser() {
@java.lang.Override
public PredictRequest parsePartialFrom(
com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry)
throws com.google.protobuf.InvalidProtocolBufferException {
Builder builder = newBuilder();
try {
builder.mergeFrom(input, extensionRegistry);
} catch (com.google.protobuf.InvalidProtocolBufferException e) {
throw e.setUnfinishedMessage(builder.buildPartial());
} catch (com.google.protobuf.UninitializedMessageException e) {
throw e.asInvalidProtocolBufferException().setUnfinishedMessage(builder.buildPartial());
} catch (java.io.IOException e) {
throw new com.google.protobuf.InvalidProtocolBufferException(e)
.setUnfinishedMessage(builder.buildPartial());
}
return builder.buildPartial();
}
};
public static com.google.protobuf.Parser parser() {
return PARSER;
}
@java.lang.Override
public com.google.protobuf.Parser getParserForType() {
return PARSER;
}
@java.lang.Override
public com.google.cloud.recommendationengine.v1beta1.PredictRequest getDefaultInstanceForType() {
return DEFAULT_INSTANCE;
}
}