Package com.google.cloud.retail.v2
Class PredictRequest.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessageV3.Builder<PredictRequest.Builder>
-
- com.google.cloud.retail.v2.PredictRequest.Builder
-
- All Implemented Interfaces:
PredictRequestOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- PredictRequest
public static final class PredictRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<PredictRequest.Builder> implements PredictRequestOrBuilder
Request message for Predict method.
Protobuf typegoogle.cloud.retail.v2.PredictRequest
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description PredictRequest.BuilderaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)PredictRequestbuild()PredictRequestbuildPartial()PredictRequest.Builderclear()PredictRequest.BuilderclearField(com.google.protobuf.Descriptors.FieldDescriptor field)PredictRequest.BuilderclearFilter()Filter for restricting prediction results with a length limit of 5,000 characters.PredictRequest.BuilderclearLabels()PredictRequest.BuilderclearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)PredictRequest.BuilderclearPageSize()Maximum number of results to return.PredictRequest.BuilderclearPageToken()Deprecated.google.cloud.retail.v2.PredictRequest.page_token is deprecated.PredictRequest.BuilderclearParams()PredictRequest.BuilderclearPlacement()Required.PredictRequest.BuilderclearUserEvent()Required.PredictRequest.BuilderclearValidateOnly()Use validate only mode for this prediction query.PredictRequest.Builderclone()booleancontainsLabels(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.booleancontainsParams(String key)Additional domain specific parameters for the predictions.PredictRequestgetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()com.google.protobuf.Descriptors.DescriptorgetDescriptorForType()StringgetFilter()Filter for restricting prediction results with a length limit of 5,000 characters.com.google.protobuf.ByteStringgetFilterBytes()Filter for restricting prediction results with a length limit of 5,000 characters.Map<String,String>getLabels()Deprecated.intgetLabelsCount()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.StringgetLabelsOrDefault(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.StringgetLabelsOrThrow(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.Map<String,String>getMutableLabels()Deprecated.Map<String,com.google.protobuf.Value>getMutableParams()Deprecated.intgetPageSize()Maximum number of results to return.StringgetPageToken()Deprecated.google.cloud.retail.v2.PredictRequest.page_token is deprecated.com.google.protobuf.ByteStringgetPageTokenBytes()Deprecated.google.cloud.retail.v2.PredictRequest.page_token is deprecated.Map<String,com.google.protobuf.Value>getParams()Deprecated.intgetParamsCount()Additional domain specific parameters for the predictions.Map<String,com.google.protobuf.Value>getParamsMap()Additional domain specific parameters for the predictions.com.google.protobuf.ValuegetParamsOrDefault(String key, com.google.protobuf.Value defaultValue)Additional domain specific parameters for the predictions.com.google.protobuf.ValuegetParamsOrThrow(String key)Additional domain specific parameters for the predictions.StringgetPlacement()Required.com.google.protobuf.ByteStringgetPlacementBytes()Required.UserEventgetUserEvent()Required.UserEvent.BuildergetUserEventBuilder()Required.UserEventOrBuildergetUserEventOrBuilder()Required.booleangetValidateOnly()Use validate only mode for this prediction query.booleanhasUserEvent()Required.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()protected com.google.protobuf.MapFieldinternalGetMapField(int number)protected com.google.protobuf.MapFieldinternalGetMutableMapField(int number)booleanisInitialized()PredictRequest.BuildermergeFrom(PredictRequest other)PredictRequest.BuildermergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)PredictRequest.BuildermergeFrom(com.google.protobuf.Message other)PredictRequest.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)PredictRequest.BuildermergeUserEvent(UserEvent value)Required.PredictRequest.BuilderputAllLabels(Map<String,String> values)The labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64.PredictRequest.BuilderputAllParams(Map<String,com.google.protobuf.Value> values)Additional domain specific parameters for the predictions.PredictRequest.BuilderputLabels(String key, String value)The labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64.PredictRequest.BuilderputParams(String key, com.google.protobuf.Value value)Additional domain specific parameters for the predictions.PredictRequest.BuilderremoveLabels(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.PredictRequest.BuilderremoveParams(String key)Additional domain specific parameters for the predictions.PredictRequest.BuildersetField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)PredictRequest.BuildersetFilter(String value)Filter for restricting prediction results with a length limit of 5,000 characters.PredictRequest.BuildersetFilterBytes(com.google.protobuf.ByteString value)Filter for restricting prediction results with a length limit of 5,000 characters.PredictRequest.BuildersetPageSize(int value)Maximum number of results to return.PredictRequest.BuildersetPageToken(String value)Deprecated.google.cloud.retail.v2.PredictRequest.page_token is deprecated.PredictRequest.BuildersetPageTokenBytes(com.google.protobuf.ByteString value)Deprecated.google.cloud.retail.v2.PredictRequest.page_token is deprecated.PredictRequest.BuildersetPlacement(String value)Required.PredictRequest.BuildersetPlacementBytes(com.google.protobuf.ByteString value)Required.PredictRequest.BuildersetRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)PredictRequest.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)PredictRequest.BuildersetUserEvent(UserEvent value)Required.PredictRequest.BuildersetUserEvent(UserEvent.Builder builderForValue)Required.PredictRequest.BuildersetValidateOnly(boolean value)Use validate only mode for this prediction query.-
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetMapField
protected com.google.protobuf.MapField internalGetMapField(int number)
- Overrides:
internalGetMapFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<PredictRequest.Builder>
-
internalGetMutableMapField
protected com.google.protobuf.MapField internalGetMutableMapField(int number)
- Overrides:
internalGetMutableMapFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<PredictRequest.Builder>
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<PredictRequest.Builder>
-
clear
public PredictRequest.Builder clear()
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<PredictRequest.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<PredictRequest.Builder>
-
getDefaultInstanceForType
public PredictRequest getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
public PredictRequest build()
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public PredictRequest buildPartial()
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
public PredictRequest.Builder clone()
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<PredictRequest.Builder>
-
setField
public PredictRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<PredictRequest.Builder>
-
clearField
public PredictRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<PredictRequest.Builder>
-
clearOneof
public PredictRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<PredictRequest.Builder>
-
setRepeatedField
public PredictRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
- Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<PredictRequest.Builder>
-
addRepeatedField
public PredictRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<PredictRequest.Builder>
-
mergeFrom
public PredictRequest.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<PredictRequest.Builder>
-
mergeFrom
public PredictRequest.Builder mergeFrom(PredictRequest other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<PredictRequest.Builder>
-
mergeFrom
public PredictRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<PredictRequest.Builder>- Throws:
IOException
-
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/configsstring placement = 1 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getPlacementin interfacePredictRequestOrBuilder- 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/configsstring placement = 1 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getPlacementBytesin interfacePredictRequestOrBuilder- Returns:
- The bytes for placement.
-
setPlacement
public PredictRequest.Builder setPlacement(String value)
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/configsstring placement = 1 [(.google.api.field_behavior) = REQUIRED];- Parameters:
value- The placement to set.- Returns:
- This builder for chaining.
-
clearPlacement
public PredictRequest.Builder clearPlacement()
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/configsstring placement = 1 [(.google.api.field_behavior) = REQUIRED];- Returns:
- This builder for chaining.
-
setPlacementBytes
public PredictRequest.Builder setPlacementBytes(com.google.protobuf.ByteString value)
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/configsstring placement = 1 [(.google.api.field_behavior) = REQUIRED];- Parameters:
value- The bytes for placement to set.- Returns:
- This builder for chaining.
-
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:
hasUserEventin interfacePredictRequestOrBuilder- 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:
getUserEventin interfacePredictRequestOrBuilder- Returns:
- The userEvent.
-
setUserEvent
public PredictRequest.Builder setUserEvent(UserEvent value)
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];
-
setUserEvent
public PredictRequest.Builder setUserEvent(UserEvent.Builder builderForValue)
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];
-
mergeUserEvent
public PredictRequest.Builder mergeUserEvent(UserEvent value)
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];
-
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. 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];
-
getUserEventBuilder
public UserEvent.Builder getUserEventBuilder()
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];
-
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:
getUserEventOrBuilderin interfacePredictRequestOrBuilder
-
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:
getPageSizein interfacePredictRequestOrBuilder- Returns:
- The pageSize.
-
setPageSize
public PredictRequest.Builder setPageSize(int value)
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;- Parameters:
value- The pageSize to set.- Returns:
- This builder for chaining.
-
clearPageSize
public PredictRequest.Builder clearPageSize()
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;- Returns:
- This builder for chaining.
-
getPageToken
@Deprecated public String getPageToken()
Deprecated.google.cloud.retail.v2.PredictRequest.page_token is deprecated. See google/cloud/retail/v2/prediction_service.proto;l=94This field is not used; leave it unset.
string page_token = 4 [deprecated = true];- Specified by:
getPageTokenin interfacePredictRequestOrBuilder- 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=94This field is not used; leave it unset.
string page_token = 4 [deprecated = true];- Specified by:
getPageTokenBytesin interfacePredictRequestOrBuilder- Returns:
- The bytes for pageToken.
-
setPageToken
@Deprecated public PredictRequest.Builder setPageToken(String value)
Deprecated.google.cloud.retail.v2.PredictRequest.page_token is deprecated. See google/cloud/retail/v2/prediction_service.proto;l=94This field is not used; leave it unset.
string page_token = 4 [deprecated = true];- Parameters:
value- The pageToken to set.- Returns:
- This builder for chaining.
-
clearPageToken
@Deprecated public PredictRequest.Builder clearPageToken()
Deprecated.google.cloud.retail.v2.PredictRequest.page_token is deprecated. See google/cloud/retail/v2/prediction_service.proto;l=94This field is not used; leave it unset.
string page_token = 4 [deprecated = true];- Returns:
- This builder for chaining.
-
setPageTokenBytes
@Deprecated public PredictRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)
Deprecated.google.cloud.retail.v2.PredictRequest.page_token is deprecated. See google/cloud/retail/v2/prediction_service.proto;l=94This field is not used; leave it unset.
string page_token = 4 [deprecated = true];- Parameters:
value- The bytes for pageToken to set.- Returns:
- This builder for chaining.
-
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:
getFilterin interfacePredictRequestOrBuilder- 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:
getFilterBytesin interfacePredictRequestOrBuilder- Returns:
- The bytes for filter.
-
setFilter
public PredictRequest.Builder setFilter(String value)
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;- Parameters:
value- The filter to set.- Returns:
- This builder for chaining.
-
clearFilter
public PredictRequest.Builder clearFilter()
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;- Returns:
- This builder for chaining.
-
setFilterBytes
public PredictRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)
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;- Parameters:
value- The bytes for filter to set.- Returns:
- This builder for chaining.
-
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:
getValidateOnlyin interfacePredictRequestOrBuilder- Returns:
- The validateOnly.
-
setValidateOnly
public PredictRequest.Builder setValidateOnly(boolean value)
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;- Parameters:
value- The validateOnly to set.- Returns:
- This builder for chaining.
-
clearValidateOnly
public PredictRequest.Builder clearValidateOnly()
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;- Returns:
- This builder for chaining.
-
getParamsCount
public int getParamsCount()
Description copied from interface:PredictRequestOrBuilderAdditional 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:
getParamsCountin interfacePredictRequestOrBuilder
-
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:
containsParamsin interfacePredictRequestOrBuilder
-
getParams
@Deprecated public Map<String,com.google.protobuf.Value> getParams()
Deprecated.UsegetParamsMap()instead.- Specified by:
getParamsin interfacePredictRequestOrBuilder
-
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:
getParamsMapin interfacePredictRequestOrBuilder
-
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:
getParamsOrDefaultin interfacePredictRequestOrBuilder
-
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:
getParamsOrThrowin interfacePredictRequestOrBuilder
-
clearParams
public PredictRequest.Builder clearParams()
-
removeParams
public PredictRequest.Builder removeParams(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;
-
getMutableParams
@Deprecated public Map<String,com.google.protobuf.Value> getMutableParams()
Deprecated.Use alternate mutation accessors instead.
-
putParams
public PredictRequest.Builder putParams(String key, com.google.protobuf.Value value)
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;
-
putAllParams
public PredictRequest.Builder putAllParams(Map<String,com.google.protobuf.Value> values)
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;
-
getLabelsCount
public int getLabelsCount()
Description copied from interface:PredictRequestOrBuilderThe 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:
getLabelsCountin interfacePredictRequestOrBuilder
-
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:
containsLabelsin interfacePredictRequestOrBuilder
-
getLabels
@Deprecated public Map<String,String> getLabels()
Deprecated.UsegetLabelsMap()instead.- Specified by:
getLabelsin interfacePredictRequestOrBuilder
-
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:
getLabelsMapin interfacePredictRequestOrBuilder
-
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:
getLabelsOrDefaultin interfacePredictRequestOrBuilder
-
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:
getLabelsOrThrowin interfacePredictRequestOrBuilder
-
clearLabels
public PredictRequest.Builder clearLabels()
-
removeLabels
public PredictRequest.Builder removeLabels(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;
-
getMutableLabels
@Deprecated public Map<String,String> getMutableLabels()
Deprecated.Use alternate mutation accessors instead.
-
putLabels
public PredictRequest.Builder putLabels(String key, String value)
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;
-
putAllLabels
public PredictRequest.Builder putAllLabels(Map<String,String> values)
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;
-
setUnknownFields
public final PredictRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<PredictRequest.Builder>
-
mergeUnknownFields
public final PredictRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<PredictRequest.Builder>
-
-