public static final class Model.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Model.Builder> implements ModelOrBuilder
Metadata that describes the training and serving parameters of a [Model][google.cloud.retail.v2alpha.Model]. A [Model][google.cloud.retail.v2alpha.Model] can be associated with a [ServingConfig][google.cloud.retail.v2alpha.ServingConfig] and then queried through the Predict API.Protobuf type
google.cloud.retail.v2alpha.ModelgetAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Model.Builder>public Model.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<Model.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Model.Builder>public Model getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic Model build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic Model buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic Model.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<Model.Builder>public Model.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<Model.Builder>public Model.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<Model.Builder>public Model.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Model.Builder>public Model.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Model.Builder>public Model.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Model.Builder>public Model.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Model.Builder>public Model.Builder mergeFrom(Model other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Model.Builder>public Model.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Model.Builder>IOExceptionpublic Model.TrainingConfigCase getTrainingConfigCase()
getTrainingConfigCase in interface ModelOrBuilderpublic Model.Builder clearTrainingConfig()
public boolean hasPageOptimizationConfig()
Optional. The page optimization config.
.google.cloud.retail.v2alpha.Model.PageOptimizationConfig page_optimization_config = 17 [(.google.api.field_behavior) = OPTIONAL];
hasPageOptimizationConfig in interface ModelOrBuilderpublic Model.PageOptimizationConfig getPageOptimizationConfig()
Optional. The page optimization config.
.google.cloud.retail.v2alpha.Model.PageOptimizationConfig page_optimization_config = 17 [(.google.api.field_behavior) = OPTIONAL];
getPageOptimizationConfig in interface ModelOrBuilderpublic Model.Builder setPageOptimizationConfig(Model.PageOptimizationConfig value)
Optional. The page optimization config.
.google.cloud.retail.v2alpha.Model.PageOptimizationConfig page_optimization_config = 17 [(.google.api.field_behavior) = OPTIONAL];
public Model.Builder setPageOptimizationConfig(Model.PageOptimizationConfig.Builder builderForValue)
Optional. The page optimization config.
.google.cloud.retail.v2alpha.Model.PageOptimizationConfig page_optimization_config = 17 [(.google.api.field_behavior) = OPTIONAL];
public Model.Builder mergePageOptimizationConfig(Model.PageOptimizationConfig value)
Optional. The page optimization config.
.google.cloud.retail.v2alpha.Model.PageOptimizationConfig page_optimization_config = 17 [(.google.api.field_behavior) = OPTIONAL];
public Model.Builder clearPageOptimizationConfig()
Optional. The page optimization config.
.google.cloud.retail.v2alpha.Model.PageOptimizationConfig page_optimization_config = 17 [(.google.api.field_behavior) = OPTIONAL];
public Model.PageOptimizationConfig.Builder getPageOptimizationConfigBuilder()
Optional. The page optimization config.
.google.cloud.retail.v2alpha.Model.PageOptimizationConfig page_optimization_config = 17 [(.google.api.field_behavior) = OPTIONAL];
public Model.PageOptimizationConfigOrBuilder getPageOptimizationConfigOrBuilder()
Optional. The page optimization config.
.google.cloud.retail.v2alpha.Model.PageOptimizationConfig page_optimization_config = 17 [(.google.api.field_behavior) = OPTIONAL];
getPageOptimizationConfigOrBuilder in interface ModelOrBuilderpublic String getName()
Required. The fully qualified resource name of the model.
Format:
`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
catalog_id has char limit of 50.
recommendation_model_id has char limit of 40.
string name = 1 [(.google.api.field_behavior) = REQUIRED];getName in interface ModelOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
Required. The fully qualified resource name of the model.
Format:
`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
catalog_id has char limit of 50.
recommendation_model_id has char limit of 40.
string name = 1 [(.google.api.field_behavior) = REQUIRED];getNameBytes in interface ModelOrBuilderpublic Model.Builder setName(String value)
Required. The fully qualified resource name of the model.
Format:
`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
catalog_id has char limit of 50.
recommendation_model_id has char limit of 40.
string name = 1 [(.google.api.field_behavior) = REQUIRED];value - The name to set.public Model.Builder clearName()
Required. The fully qualified resource name of the model.
Format:
`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
catalog_id has char limit of 50.
recommendation_model_id has char limit of 40.
string name = 1 [(.google.api.field_behavior) = REQUIRED];public Model.Builder setNameBytes(com.google.protobuf.ByteString value)
Required. The fully qualified resource name of the model.
Format:
`projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}`
catalog_id has char limit of 50.
recommendation_model_id has char limit of 40.
string name = 1 [(.google.api.field_behavior) = REQUIRED];value - The bytes for name to set.public String getDisplayName()
Required. The display name of the model. Should be human readable, used to display Recommendation Models in the Retail Cloud Console Dashboard. UTF-8 encoded string with limit of 1024 characters.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];getDisplayName in interface ModelOrBuilderpublic com.google.protobuf.ByteString getDisplayNameBytes()
Required. The display name of the model. Should be human readable, used to display Recommendation Models in the Retail Cloud Console Dashboard. UTF-8 encoded string with limit of 1024 characters.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];getDisplayNameBytes in interface ModelOrBuilderpublic Model.Builder setDisplayName(String value)
Required. The display name of the model. Should be human readable, used to display Recommendation Models in the Retail Cloud Console Dashboard. UTF-8 encoded string with limit of 1024 characters.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];value - The displayName to set.public Model.Builder clearDisplayName()
Required. The display name of the model. Should be human readable, used to display Recommendation Models in the Retail Cloud Console Dashboard. UTF-8 encoded string with limit of 1024 characters.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];public Model.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)
Required. The display name of the model. Should be human readable, used to display Recommendation Models in the Retail Cloud Console Dashboard. UTF-8 encoded string with limit of 1024 characters.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];value - The bytes for displayName to set.public int getTrainingStateValue()
Optional. The training state that the model is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train model in order to control cost. If not specified: the default value for `CreateModel` method is `TRAINING`. The default value for `UpdateModel` method is to keep the state the same as before.
.google.cloud.retail.v2alpha.Model.TrainingState training_state = 3 [(.google.api.field_behavior) = OPTIONAL];
getTrainingStateValue in interface ModelOrBuilderpublic Model.Builder setTrainingStateValue(int value)
Optional. The training state that the model is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train model in order to control cost. If not specified: the default value for `CreateModel` method is `TRAINING`. The default value for `UpdateModel` method is to keep the state the same as before.
.google.cloud.retail.v2alpha.Model.TrainingState training_state = 3 [(.google.api.field_behavior) = OPTIONAL];
value - The enum numeric value on the wire for trainingState to set.public Model.TrainingState getTrainingState()
Optional. The training state that the model is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train model in order to control cost. If not specified: the default value for `CreateModel` method is `TRAINING`. The default value for `UpdateModel` method is to keep the state the same as before.
.google.cloud.retail.v2alpha.Model.TrainingState training_state = 3 [(.google.api.field_behavior) = OPTIONAL];
getTrainingState in interface ModelOrBuilderpublic Model.Builder setTrainingState(Model.TrainingState value)
Optional. The training state that the model is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train model in order to control cost. If not specified: the default value for `CreateModel` method is `TRAINING`. The default value for `UpdateModel` method is to keep the state the same as before.
.google.cloud.retail.v2alpha.Model.TrainingState training_state = 3 [(.google.api.field_behavior) = OPTIONAL];
value - The trainingState to set.public Model.Builder clearTrainingState()
Optional. The training state that the model is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train model in order to control cost. If not specified: the default value for `CreateModel` method is `TRAINING`. The default value for `UpdateModel` method is to keep the state the same as before.
.google.cloud.retail.v2alpha.Model.TrainingState training_state = 3 [(.google.api.field_behavior) = OPTIONAL];
public int getServingStateValue()
Output only. The serving state of the model: `ACTIVE`, `NOT_ACTIVE`.
.google.cloud.retail.v2alpha.Model.ServingState serving_state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getServingStateValue in interface ModelOrBuilderpublic Model.Builder setServingStateValue(int value)
Output only. The serving state of the model: `ACTIVE`, `NOT_ACTIVE`.
.google.cloud.retail.v2alpha.Model.ServingState serving_state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
value - The enum numeric value on the wire for servingState to set.public Model.ServingState getServingState()
Output only. The serving state of the model: `ACTIVE`, `NOT_ACTIVE`.
.google.cloud.retail.v2alpha.Model.ServingState serving_state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getServingState in interface ModelOrBuilderpublic Model.Builder setServingState(Model.ServingState value)
Output only. The serving state of the model: `ACTIVE`, `NOT_ACTIVE`.
.google.cloud.retail.v2alpha.Model.ServingState serving_state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
value - The servingState to set.public Model.Builder clearServingState()
Output only. The serving state of the model: `ACTIVE`, `NOT_ACTIVE`.
.google.cloud.retail.v2alpha.Model.ServingState serving_state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
public boolean hasCreateTime()
Output only. Timestamp the Recommendation Model was created at.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime in interface ModelOrBuilderpublic com.google.protobuf.Timestamp getCreateTime()
Output only. Timestamp the Recommendation Model was created at.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTime in interface ModelOrBuilderpublic Model.Builder setCreateTime(com.google.protobuf.Timestamp value)
Output only. Timestamp the Recommendation Model was created at.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Model.Builder setCreateTime(com.google.protobuf.Timestamp.Builder builderForValue)
Output only. Timestamp the Recommendation Model was created at.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Model.Builder mergeCreateTime(com.google.protobuf.Timestamp value)
Output only. Timestamp the Recommendation Model was created at.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Model.Builder clearCreateTime()
Output only. Timestamp the Recommendation Model was created at.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder()
Output only. Timestamp the Recommendation Model was created at.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Timestamp the Recommendation Model was created at.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder in interface ModelOrBuilderpublic boolean hasUpdateTime()
Output only. Timestamp the Recommendation Model was last updated. E.g. if a Recommendation Model was paused - this would be the time the pause was initiated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasUpdateTime in interface ModelOrBuilderpublic com.google.protobuf.Timestamp getUpdateTime()
Output only. Timestamp the Recommendation Model was last updated. E.g. if a Recommendation Model was paused - this would be the time the pause was initiated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTime in interface ModelOrBuilderpublic Model.Builder setUpdateTime(com.google.protobuf.Timestamp value)
Output only. Timestamp the Recommendation Model was last updated. E.g. if a Recommendation Model was paused - this would be the time the pause was initiated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Model.Builder setUpdateTime(com.google.protobuf.Timestamp.Builder builderForValue)
Output only. Timestamp the Recommendation Model was last updated. E.g. if a Recommendation Model was paused - this would be the time the pause was initiated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Model.Builder mergeUpdateTime(com.google.protobuf.Timestamp value)
Output only. Timestamp the Recommendation Model was last updated. E.g. if a Recommendation Model was paused - this would be the time the pause was initiated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Model.Builder clearUpdateTime()
Output only. Timestamp the Recommendation Model was last updated. E.g. if a Recommendation Model was paused - this would be the time the pause was initiated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
public com.google.protobuf.Timestamp.Builder getUpdateTimeBuilder()
Output only. Timestamp the Recommendation Model was last updated. E.g. if a Recommendation Model was paused - this would be the time the pause was initiated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Timestamp the Recommendation Model was last updated. E.g. if a Recommendation Model was paused - this would be the time the pause was initiated.
.google.protobuf.Timestamp update_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTimeOrBuilder in interface ModelOrBuilderpublic String getType()
Required. The type of model e.g. `home-page`. Currently supported values: `recommended-for-you`, `others-you-may-like`, `frequently-bought-together`, `page-optimization`, `similar-items`, `buy-it-again`, `on-sale-items`, and `recently-viewed`(readonly value). This field together with [optimization_objective][google.cloud.retail.v2alpha.Model.optimization_objective] describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = `frequently-bought-together` and optimization_objective = `ctr`), you receive an error 400 if you try to create/update a recommendation with this set of knobs.
string type = 7 [(.google.api.field_behavior) = REQUIRED];getType in interface ModelOrBuilderpublic com.google.protobuf.ByteString getTypeBytes()
Required. The type of model e.g. `home-page`. Currently supported values: `recommended-for-you`, `others-you-may-like`, `frequently-bought-together`, `page-optimization`, `similar-items`, `buy-it-again`, `on-sale-items`, and `recently-viewed`(readonly value). This field together with [optimization_objective][google.cloud.retail.v2alpha.Model.optimization_objective] describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = `frequently-bought-together` and optimization_objective = `ctr`), you receive an error 400 if you try to create/update a recommendation with this set of knobs.
string type = 7 [(.google.api.field_behavior) = REQUIRED];getTypeBytes in interface ModelOrBuilderpublic Model.Builder setType(String value)
Required. The type of model e.g. `home-page`. Currently supported values: `recommended-for-you`, `others-you-may-like`, `frequently-bought-together`, `page-optimization`, `similar-items`, `buy-it-again`, `on-sale-items`, and `recently-viewed`(readonly value). This field together with [optimization_objective][google.cloud.retail.v2alpha.Model.optimization_objective] describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = `frequently-bought-together` and optimization_objective = `ctr`), you receive an error 400 if you try to create/update a recommendation with this set of knobs.
string type = 7 [(.google.api.field_behavior) = REQUIRED];value - The type to set.public Model.Builder clearType()
Required. The type of model e.g. `home-page`. Currently supported values: `recommended-for-you`, `others-you-may-like`, `frequently-bought-together`, `page-optimization`, `similar-items`, `buy-it-again`, `on-sale-items`, and `recently-viewed`(readonly value). This field together with [optimization_objective][google.cloud.retail.v2alpha.Model.optimization_objective] describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = `frequently-bought-together` and optimization_objective = `ctr`), you receive an error 400 if you try to create/update a recommendation with this set of knobs.
string type = 7 [(.google.api.field_behavior) = REQUIRED];public Model.Builder setTypeBytes(com.google.protobuf.ByteString value)
Required. The type of model e.g. `home-page`. Currently supported values: `recommended-for-you`, `others-you-may-like`, `frequently-bought-together`, `page-optimization`, `similar-items`, `buy-it-again`, `on-sale-items`, and `recently-viewed`(readonly value). This field together with [optimization_objective][google.cloud.retail.v2alpha.Model.optimization_objective] describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = `frequently-bought-together` and optimization_objective = `ctr`), you receive an error 400 if you try to create/update a recommendation with this set of knobs.
string type = 7 [(.google.api.field_behavior) = REQUIRED];value - The bytes for type to set.public String getOptimizationObjective()
Optional. The optimization objective e.g. `cvr`. Currently supported values: `ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on model type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `revenue_per_order` This field together with [optimization_objective][google.cloud.retail.v2alpha.Model.type] describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = `frequently-bought-together` and optimization_objective = `ctr`), you receive an error 400 if you try to create/update a recommendation with this set of knobs.
string optimization_objective = 8 [(.google.api.field_behavior) = OPTIONAL];getOptimizationObjective in interface ModelOrBuilderpublic com.google.protobuf.ByteString getOptimizationObjectiveBytes()
Optional. The optimization objective e.g. `cvr`. Currently supported values: `ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on model type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `revenue_per_order` This field together with [optimization_objective][google.cloud.retail.v2alpha.Model.type] describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = `frequently-bought-together` and optimization_objective = `ctr`), you receive an error 400 if you try to create/update a recommendation with this set of knobs.
string optimization_objective = 8 [(.google.api.field_behavior) = OPTIONAL];getOptimizationObjectiveBytes in interface ModelOrBuilderpublic Model.Builder setOptimizationObjective(String value)
Optional. The optimization objective e.g. `cvr`. Currently supported values: `ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on model type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `revenue_per_order` This field together with [optimization_objective][google.cloud.retail.v2alpha.Model.type] describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = `frequently-bought-together` and optimization_objective = `ctr`), you receive an error 400 if you try to create/update a recommendation with this set of knobs.
string optimization_objective = 8 [(.google.api.field_behavior) = OPTIONAL];value - The optimizationObjective to set.public Model.Builder clearOptimizationObjective()
Optional. The optimization objective e.g. `cvr`. Currently supported values: `ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on model type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `revenue_per_order` This field together with [optimization_objective][google.cloud.retail.v2alpha.Model.type] describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = `frequently-bought-together` and optimization_objective = `ctr`), you receive an error 400 if you try to create/update a recommendation with this set of knobs.
string optimization_objective = 8 [(.google.api.field_behavior) = OPTIONAL];public Model.Builder setOptimizationObjectiveBytes(com.google.protobuf.ByteString value)
Optional. The optimization objective e.g. `cvr`. Currently supported values: `ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on model type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `revenue_per_order` This field together with [optimization_objective][google.cloud.retail.v2alpha.Model.type] describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = `frequently-bought-together` and optimization_objective = `ctr`), you receive an error 400 if you try to create/update a recommendation with this set of knobs.
string optimization_objective = 8 [(.google.api.field_behavior) = OPTIONAL];value - The bytes for optimizationObjective to set.public int getPeriodicTuningStateValue()
Optional. The state of periodic tuning. The period we use is 3 months - to do a one-off tune earlier use the `TuneModel` method. Default value is `PERIODIC_TUNING_ENABLED`.
.google.cloud.retail.v2alpha.Model.PeriodicTuningState periodic_tuning_state = 11 [(.google.api.field_behavior) = OPTIONAL];
getPeriodicTuningStateValue in interface ModelOrBuilderpublic Model.Builder setPeriodicTuningStateValue(int value)
Optional. The state of periodic tuning. The period we use is 3 months - to do a one-off tune earlier use the `TuneModel` method. Default value is `PERIODIC_TUNING_ENABLED`.
.google.cloud.retail.v2alpha.Model.PeriodicTuningState periodic_tuning_state = 11 [(.google.api.field_behavior) = OPTIONAL];
value - The enum numeric value on the wire for periodicTuningState to set.public Model.PeriodicTuningState getPeriodicTuningState()
Optional. The state of periodic tuning. The period we use is 3 months - to do a one-off tune earlier use the `TuneModel` method. Default value is `PERIODIC_TUNING_ENABLED`.
.google.cloud.retail.v2alpha.Model.PeriodicTuningState periodic_tuning_state = 11 [(.google.api.field_behavior) = OPTIONAL];
getPeriodicTuningState in interface ModelOrBuilderpublic Model.Builder setPeriodicTuningState(Model.PeriodicTuningState value)
Optional. The state of periodic tuning. The period we use is 3 months - to do a one-off tune earlier use the `TuneModel` method. Default value is `PERIODIC_TUNING_ENABLED`.
.google.cloud.retail.v2alpha.Model.PeriodicTuningState periodic_tuning_state = 11 [(.google.api.field_behavior) = OPTIONAL];
value - The periodicTuningState to set.public Model.Builder clearPeriodicTuningState()
Optional. The state of periodic tuning. The period we use is 3 months - to do a one-off tune earlier use the `TuneModel` method. Default value is `PERIODIC_TUNING_ENABLED`.
.google.cloud.retail.v2alpha.Model.PeriodicTuningState periodic_tuning_state = 11 [(.google.api.field_behavior) = OPTIONAL];
public boolean hasLastTuneTime()
Output only. The timestamp when the latest successful tune finished.
.google.protobuf.Timestamp last_tune_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasLastTuneTime in interface ModelOrBuilderpublic com.google.protobuf.Timestamp getLastTuneTime()
Output only. The timestamp when the latest successful tune finished.
.google.protobuf.Timestamp last_tune_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getLastTuneTime in interface ModelOrBuilderpublic Model.Builder setLastTuneTime(com.google.protobuf.Timestamp value)
Output only. The timestamp when the latest successful tune finished.
.google.protobuf.Timestamp last_tune_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Model.Builder setLastTuneTime(com.google.protobuf.Timestamp.Builder builderForValue)
Output only. The timestamp when the latest successful tune finished.
.google.protobuf.Timestamp last_tune_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Model.Builder mergeLastTuneTime(com.google.protobuf.Timestamp value)
Output only. The timestamp when the latest successful tune finished.
.google.protobuf.Timestamp last_tune_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Model.Builder clearLastTuneTime()
Output only. The timestamp when the latest successful tune finished.
.google.protobuf.Timestamp last_tune_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
public com.google.protobuf.Timestamp.Builder getLastTuneTimeBuilder()
Output only. The timestamp when the latest successful tune finished.
.google.protobuf.Timestamp last_tune_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
public com.google.protobuf.TimestampOrBuilder getLastTuneTimeOrBuilder()
Output only. The timestamp when the latest successful tune finished.
.google.protobuf.Timestamp last_tune_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
getLastTuneTimeOrBuilder in interface ModelOrBuilderpublic String getTuningOperation()
Output only. The tune operation associated with the model. Can be used to determine if there is an ongoing tune for this recommendation. Empty field implies no tune is goig on.
string tuning_operation = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];getTuningOperation in interface ModelOrBuilderpublic com.google.protobuf.ByteString getTuningOperationBytes()
Output only. The tune operation associated with the model. Can be used to determine if there is an ongoing tune for this recommendation. Empty field implies no tune is goig on.
string tuning_operation = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];getTuningOperationBytes in interface ModelOrBuilderpublic Model.Builder setTuningOperation(String value)
Output only. The tune operation associated with the model. Can be used to determine if there is an ongoing tune for this recommendation. Empty field implies no tune is goig on.
string tuning_operation = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];value - The tuningOperation to set.public Model.Builder clearTuningOperation()
Output only. The tune operation associated with the model. Can be used to determine if there is an ongoing tune for this recommendation. Empty field implies no tune is goig on.
string tuning_operation = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];public Model.Builder setTuningOperationBytes(com.google.protobuf.ByteString value)
Output only. The tune operation associated with the model. Can be used to determine if there is an ongoing tune for this recommendation. Empty field implies no tune is goig on.
string tuning_operation = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];value - The bytes for tuningOperation to set.public int getDataStateValue()
Output only. The state of data requirements for this model: `DATA_OK` and `DATA_ERROR`. Recommendation model cannot be trained if the data is in `DATA_ERROR` state. Recommendation model can have `DATA_ERROR` state even if serving state is `ACTIVE`: models were trained successfully before, but cannot be refreshed because model no longer has sufficient data for training.
.google.cloud.retail.v2alpha.Model.DataState data_state = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDataStateValue in interface ModelOrBuilderpublic Model.Builder setDataStateValue(int value)
Output only. The state of data requirements for this model: `DATA_OK` and `DATA_ERROR`. Recommendation model cannot be trained if the data is in `DATA_ERROR` state. Recommendation model can have `DATA_ERROR` state even if serving state is `ACTIVE`: models were trained successfully before, but cannot be refreshed because model no longer has sufficient data for training.
.google.cloud.retail.v2alpha.Model.DataState data_state = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
value - The enum numeric value on the wire for dataState to set.public Model.DataState getDataState()
Output only. The state of data requirements for this model: `DATA_OK` and `DATA_ERROR`. Recommendation model cannot be trained if the data is in `DATA_ERROR` state. Recommendation model can have `DATA_ERROR` state even if serving state is `ACTIVE`: models were trained successfully before, but cannot be refreshed because model no longer has sufficient data for training.
.google.cloud.retail.v2alpha.Model.DataState data_state = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDataState in interface ModelOrBuilderpublic Model.Builder setDataState(Model.DataState value)
Output only. The state of data requirements for this model: `DATA_OK` and `DATA_ERROR`. Recommendation model cannot be trained if the data is in `DATA_ERROR` state. Recommendation model can have `DATA_ERROR` state even if serving state is `ACTIVE`: models were trained successfully before, but cannot be refreshed because model no longer has sufficient data for training.
.google.cloud.retail.v2alpha.Model.DataState data_state = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
value - The dataState to set.public Model.Builder clearDataState()
Output only. The state of data requirements for this model: `DATA_OK` and `DATA_ERROR`. Recommendation model cannot be trained if the data is in `DATA_ERROR` state. Recommendation model can have `DATA_ERROR` state even if serving state is `ACTIVE`: models were trained successfully before, but cannot be refreshed because model no longer has sufficient data for training.
.google.cloud.retail.v2alpha.Model.DataState data_state = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
public int getFilteringOptionValue()
Optional. If `RECOMMENDATIONS_FILTERING_ENABLED`, recommendation filtering by attributes is enabled for the model.
.google.cloud.retail.v2alpha.RecommendationsFilteringOption filtering_option = 18 [(.google.api.field_behavior) = OPTIONAL];
getFilteringOptionValue in interface ModelOrBuilderpublic Model.Builder setFilteringOptionValue(int value)
Optional. If `RECOMMENDATIONS_FILTERING_ENABLED`, recommendation filtering by attributes is enabled for the model.
.google.cloud.retail.v2alpha.RecommendationsFilteringOption filtering_option = 18 [(.google.api.field_behavior) = OPTIONAL];
value - The enum numeric value on the wire for filteringOption to set.public RecommendationsFilteringOption getFilteringOption()
Optional. If `RECOMMENDATIONS_FILTERING_ENABLED`, recommendation filtering by attributes is enabled for the model.
.google.cloud.retail.v2alpha.RecommendationsFilteringOption filtering_option = 18 [(.google.api.field_behavior) = OPTIONAL];
getFilteringOption in interface ModelOrBuilderpublic Model.Builder setFilteringOption(RecommendationsFilteringOption value)
Optional. If `RECOMMENDATIONS_FILTERING_ENABLED`, recommendation filtering by attributes is enabled for the model.
.google.cloud.retail.v2alpha.RecommendationsFilteringOption filtering_option = 18 [(.google.api.field_behavior) = OPTIONAL];
value - The filteringOption to set.public Model.Builder clearFilteringOption()
Optional. If `RECOMMENDATIONS_FILTERING_ENABLED`, recommendation filtering by attributes is enabled for the model.
.google.cloud.retail.v2alpha.RecommendationsFilteringOption filtering_option = 18 [(.google.api.field_behavior) = OPTIONAL];
public List<Model.ServingConfigList> getServingConfigListsList()
Output only. The list of valid serving configs associated with the PageOptimizationConfig.
repeated .google.cloud.retail.v2alpha.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
getServingConfigListsList in interface ModelOrBuilderpublic int getServingConfigListsCount()
Output only. The list of valid serving configs associated with the PageOptimizationConfig.
repeated .google.cloud.retail.v2alpha.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
getServingConfigListsCount in interface ModelOrBuilderpublic Model.ServingConfigList getServingConfigLists(int index)
Output only. The list of valid serving configs associated with the PageOptimizationConfig.
repeated .google.cloud.retail.v2alpha.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
getServingConfigLists in interface ModelOrBuilderpublic Model.Builder setServingConfigLists(int index, Model.ServingConfigList value)
Output only. The list of valid serving configs associated with the PageOptimizationConfig.
repeated .google.cloud.retail.v2alpha.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Model.Builder setServingConfigLists(int index, Model.ServingConfigList.Builder builderForValue)
Output only. The list of valid serving configs associated with the PageOptimizationConfig.
repeated .google.cloud.retail.v2alpha.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Model.Builder addServingConfigLists(Model.ServingConfigList value)
Output only. The list of valid serving configs associated with the PageOptimizationConfig.
repeated .google.cloud.retail.v2alpha.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Model.Builder addServingConfigLists(int index, Model.ServingConfigList value)
Output only. The list of valid serving configs associated with the PageOptimizationConfig.
repeated .google.cloud.retail.v2alpha.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Model.Builder addServingConfigLists(Model.ServingConfigList.Builder builderForValue)
Output only. The list of valid serving configs associated with the PageOptimizationConfig.
repeated .google.cloud.retail.v2alpha.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Model.Builder addServingConfigLists(int index, Model.ServingConfigList.Builder builderForValue)
Output only. The list of valid serving configs associated with the PageOptimizationConfig.
repeated .google.cloud.retail.v2alpha.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Model.Builder addAllServingConfigLists(Iterable<? extends Model.ServingConfigList> values)
Output only. The list of valid serving configs associated with the PageOptimizationConfig.
repeated .google.cloud.retail.v2alpha.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Model.Builder clearServingConfigLists()
Output only. The list of valid serving configs associated with the PageOptimizationConfig.
repeated .google.cloud.retail.v2alpha.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Model.Builder removeServingConfigLists(int index)
Output only. The list of valid serving configs associated with the PageOptimizationConfig.
repeated .google.cloud.retail.v2alpha.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Model.ServingConfigList.Builder getServingConfigListsBuilder(int index)
Output only. The list of valid serving configs associated with the PageOptimizationConfig.
repeated .google.cloud.retail.v2alpha.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Model.ServingConfigListOrBuilder getServingConfigListsOrBuilder(int index)
Output only. The list of valid serving configs associated with the PageOptimizationConfig.
repeated .google.cloud.retail.v2alpha.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
getServingConfigListsOrBuilder in interface ModelOrBuilderpublic List<? extends Model.ServingConfigListOrBuilder> getServingConfigListsOrBuilderList()
Output only. The list of valid serving configs associated with the PageOptimizationConfig.
repeated .google.cloud.retail.v2alpha.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
getServingConfigListsOrBuilderList in interface ModelOrBuilderpublic Model.ServingConfigList.Builder addServingConfigListsBuilder()
Output only. The list of valid serving configs associated with the PageOptimizationConfig.
repeated .google.cloud.retail.v2alpha.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Model.ServingConfigList.Builder addServingConfigListsBuilder(int index)
Output only. The list of valid serving configs associated with the PageOptimizationConfig.
repeated .google.cloud.retail.v2alpha.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
public List<Model.ServingConfigList.Builder> getServingConfigListsBuilderList()
Output only. The list of valid serving configs associated with the PageOptimizationConfig.
repeated .google.cloud.retail.v2alpha.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
public final Model.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Model.Builder>public final Model.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Model.Builder>Copyright © 2024 Google LLC. All rights reserved.