- 2.55.0 (latest)
- 2.54.0
- 2.53.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.1
- 2.4.0
- 2.3.0
- 2.2.3
- 2.1.0
- 2.0.19
public interface ModelOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getCreateTime()
public abstract Timestamp getCreateTime()Output only. Timestamp the Recommendation Model was created at.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The createTime. |
getCreateTimeOrBuilder()
public abstract TimestampOrBuilder getCreateTimeOrBuilder()Output only. Timestamp the Recommendation Model was created at.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDataState()
public abstract 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.v2.Model.DataState data_state = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Model.DataState |
The dataState. |
getDataStateValue()
public abstract 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.v2.Model.DataState data_state = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for dataState. |
getDisplayName()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getFilteringOption()
public abstract RecommendationsFilteringOption getFilteringOption() Optional. If RECOMMENDATIONS_FILTERING_ENABLED, recommendation filtering
by attributes is enabled for the model.
.google.cloud.retail.v2.RecommendationsFilteringOption filtering_option = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
RecommendationsFilteringOption |
The filteringOption. |
getFilteringOptionValue()
public abstract int getFilteringOptionValue() Optional. If RECOMMENDATIONS_FILTERING_ENABLED, recommendation filtering
by attributes is enabled for the model.
.google.cloud.retail.v2.RecommendationsFilteringOption filtering_option = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for filteringOption. |
getLastTuneTime()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The lastTuneTime. |
getLastTuneTimeOrBuilder()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getName()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getOptimizationObjective()
public abstract 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
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];
| Returns | |
|---|---|
| Type | Description |
String |
The optimizationObjective. |
getOptimizationObjectiveBytes()
public abstract 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
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];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for optimizationObjective. |
getPeriodicTuningState()
public abstract 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.v2.Model.PeriodicTuningState periodic_tuning_state = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Model.PeriodicTuningState |
The periodicTuningState. |
getPeriodicTuningStateValue()
public abstract 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.v2.Model.PeriodicTuningState periodic_tuning_state = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for periodicTuningState. |
getServingConfigLists(int index)
public abstract Model.ServingConfigList getServingConfigLists(int index)Output only. The list of valid serving configs associated with the PageOptimizationConfig.
repeated .google.cloud.retail.v2.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Model.ServingConfigList |
|
getServingConfigListsCount()
public abstract int getServingConfigListsCount()Output only. The list of valid serving configs associated with the PageOptimizationConfig.
repeated .google.cloud.retail.v2.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
|
getServingConfigListsList()
public abstract List<Model.ServingConfigList> getServingConfigListsList()Output only. The list of valid serving configs associated with the PageOptimizationConfig.
repeated .google.cloud.retail.v2.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<ServingConfigList> |
|
getServingConfigListsOrBuilder(int index)
public abstract Model.ServingConfigListOrBuilder getServingConfigListsOrBuilder(int index)Output only. The list of valid serving configs associated with the PageOptimizationConfig.
repeated .google.cloud.retail.v2.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Model.ServingConfigListOrBuilder |
|
getServingConfigListsOrBuilderList()
public abstract List<? extends Model.ServingConfigListOrBuilder> getServingConfigListsOrBuilderList()Output only. The list of valid serving configs associated with the PageOptimizationConfig.
repeated .google.cloud.retail.v2.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.retail.v2.Model.ServingConfigListOrBuilder> |
|
getServingState()
public abstract Model.ServingState getServingState() Output only. The serving state of the model: ACTIVE, NOT_ACTIVE.
.google.cloud.retail.v2.Model.ServingState serving_state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Model.ServingState |
The servingState. |
getServingStateValue()
public abstract int getServingStateValue() Output only. The serving state of the model: ACTIVE, NOT_ACTIVE.
.google.cloud.retail.v2.Model.ServingState serving_state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for servingState. |
getTrainingState()
public abstract 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.v2.Model.TrainingState training_state = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Model.TrainingState |
The trainingState. |
getTrainingStateValue()
public abstract 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.v2.Model.TrainingState training_state = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for trainingState. |
getTuningOperation()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
String |
The tuningOperation. |
getTuningOperationBytes()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for tuningOperation. |
getType()
public abstract 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
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];
| Returns | |
|---|---|
| Type | Description |
String |
The type. |
getTypeBytes()
public abstract 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
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];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for type. |
getUpdateTime()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The updateTime. |
getUpdateTimeOrBuilder()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
hasCreateTime()
public abstract boolean hasCreateTime()Output only. Timestamp the Recommendation Model was created at.
.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the createTime field is set. |
hasLastTuneTime()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the lastTuneTime field is set. |
hasUpdateTime()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the updateTime field is set. |