Class Model.Builder (2.53.0) 

public static final class Model.Builder extends GeneratedMessageV3.Builder<Model.Builder> implements ModelOrBuilder

Metadata that describes the training and serving parameters of a Model. A Model can be associated with a ServingConfig and then queried through the Predict API.

Protobuf type google.cloud.retail.v2.Model

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Model.Builder

Implements

ModelOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllServingConfigLists(Iterable<? extends Model.ServingConfigList> values)

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.v2.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<? extends com.google.cloud.retail.v2.Model.ServingConfigList>
Returns
Type Description
Model.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Model.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Model.Builder
Overrides

addServingConfigLists(Model.ServingConfigList value)

public Model.Builder addServingConfigLists(Model.ServingConfigList value)

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
value Model.ServingConfigList
Returns
Type Description
Model.Builder

addServingConfigLists(Model.ServingConfigList.Builder builderForValue)

public Model.Builder addServingConfigLists(Model.ServingConfigList.Builder builderForValue)

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
builderForValue Model.ServingConfigList.Builder
Returns
Type Description
Model.Builder

addServingConfigLists(int index, Model.ServingConfigList value)

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.v2.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value Model.ServingConfigList
Returns
Type Description
Model.Builder

addServingConfigLists(int index, Model.ServingConfigList.Builder builderForValue)

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.v2.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue Model.ServingConfigList.Builder
Returns
Type Description
Model.Builder

addServingConfigListsBuilder()

public Model.ServingConfigList.Builder addServingConfigListsBuilder()

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
Model.ServingConfigList.Builder

addServingConfigListsBuilder(int index)

public Model.ServingConfigList.Builder addServingConfigListsBuilder(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.Builder

build()

public Model build()
Returns
Type Description
Model

buildPartial()

public Model buildPartial()
Returns
Type Description
Model

clear()

public Model.Builder clear()
Returns
Type Description
Model.Builder
Overrides

clearCreateTime()

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];

Returns
Type Description
Model.Builder

clearDataState()

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.v2.Model.DataState data_state = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Model.Builder

This builder for chaining.

clearDisplayName()

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];

Returns
Type Description
Model.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Model.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Model.Builder
Overrides

clearFilteringOption()

public Model.Builder clearFilteringOption()

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
Model.Builder

This builder for chaining.

clearLastTuneTime()

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];

Returns
Type Description
Model.Builder

clearModelFeaturesConfig()

public Model.Builder clearModelFeaturesConfig()

Optional. Additional model features config.

.google.cloud.retail.v2.Model.ModelFeaturesConfig model_features_config = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Model.Builder

clearName()

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];

Returns
Type Description
Model.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Model.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Model.Builder
Overrides

clearOptimizationObjective()

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 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
Model.Builder

This builder for chaining.

clearPeriodicTuningState()

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.v2.Model.PeriodicTuningState periodic_tuning_state = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Model.Builder

This builder for chaining.

clearServingConfigLists()

public Model.Builder clearServingConfigLists()

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
Model.Builder

clearServingState()

public Model.Builder clearServingState()

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.Builder

This builder for chaining.

clearTrainingState()

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.v2.Model.TrainingState training_state = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Model.Builder

This builder for chaining.

clearTuningOperation()

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];

Returns
Type Description
Model.Builder

This builder for chaining.

clearType()

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 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
Model.Builder

This builder for chaining.

clearUpdateTime()

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];

Returns
Type Description
Model.Builder

clone()

public Model.Builder clone()
Returns
Type Description
Model.Builder
Overrides

getCreateTime()

public 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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. Timestamp the Recommendation Model was created at.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public 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 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 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.

getDefaultInstanceForType()

public Model getDefaultInstanceForType()
Returns
Type Description
Model

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

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];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public 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 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 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 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.

getLastTuneTimeBuilder()

public 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];

Returns
Type Description
Builder

getLastTuneTimeOrBuilder()

public 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

getModelFeaturesConfig()

public Model.ModelFeaturesConfig getModelFeaturesConfig()

Optional. Additional model features config.

.google.cloud.retail.v2.Model.ModelFeaturesConfig model_features_config = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Model.ModelFeaturesConfig

The modelFeaturesConfig.

getModelFeaturesConfigBuilder()

public Model.ModelFeaturesConfig.Builder getModelFeaturesConfigBuilder()

Optional. Additional model features config.

.google.cloud.retail.v2.Model.ModelFeaturesConfig model_features_config = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Model.ModelFeaturesConfig.Builder

getModelFeaturesConfigOrBuilder()

public Model.ModelFeaturesConfigOrBuilder getModelFeaturesConfigOrBuilder()

Optional. Additional model features config.

.google.cloud.retail.v2.Model.ModelFeaturesConfig model_features_config = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Model.ModelFeaturesConfigOrBuilder

getName()

public 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 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 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 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 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 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 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

getServingConfigListsBuilder(int index)

public Model.ServingConfigList.Builder getServingConfigListsBuilder(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.Builder

getServingConfigListsBuilderList()

public List<Model.ServingConfigList.Builder> getServingConfigListsBuilderList()

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<Builder>

getServingConfigListsCount()

public 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 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 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 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 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 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 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 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 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 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 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 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 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.

getUpdateTimeBuilder()

public 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];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public 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 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 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.

hasModelFeaturesConfig()

public boolean hasModelFeaturesConfig()

Optional. Additional model features config.

.google.cloud.retail.v2.Model.ModelFeaturesConfig model_features_config = 22 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the modelFeaturesConfig field is set.

hasUpdateTime()

public 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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public Model.Builder mergeCreateTime(Timestamp value)

Output only. Timestamp the Recommendation Model was created at.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Model.Builder

mergeFrom(Model other)

public Model.Builder mergeFrom(Model other)
Parameter
Name Description
other Model
Returns
Type Description
Model.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Model.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Model.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Model.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Model.Builder
Overrides

mergeLastTuneTime(Timestamp value)

public Model.Builder mergeLastTuneTime(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];

Parameter
Name Description
value Timestamp
Returns
Type Description
Model.Builder

mergeModelFeaturesConfig(Model.ModelFeaturesConfig value)

public Model.Builder mergeModelFeaturesConfig(Model.ModelFeaturesConfig value)

Optional. Additional model features config.

.google.cloud.retail.v2.Model.ModelFeaturesConfig model_features_config = 22 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Model.ModelFeaturesConfig
Returns
Type Description
Model.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Model.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Model.Builder
Overrides

mergeUpdateTime(Timestamp value)

public Model.Builder mergeUpdateTime(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];

Parameter
Name Description
value Timestamp
Returns
Type Description
Model.Builder

removeServingConfigLists(int index)

public Model.Builder removeServingConfigLists(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.Builder

setCreateTime(Timestamp value)

public Model.Builder setCreateTime(Timestamp value)

Output only. Timestamp the Recommendation Model was created at.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Model.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Model.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. Timestamp the Recommendation Model was created at.

.google.protobuf.Timestamp create_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Model.Builder

setDataState(Model.DataState value)

public 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.v2.Model.DataState data_state = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Model.DataState

The dataState to set.
Returns
Type Description
Model.Builder

This builder for chaining.

setDataStateValue(int value)

public 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.v2.Model.DataState data_state = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for dataState to set.
Returns
Type Description
Model.Builder

This builder for chaining.

setDisplayName(String value)

public 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];

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
Model.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public Model.Builder setDisplayNameBytes(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];

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
Model.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Model.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Model.Builder
Overrides

setFilteringOption(RecommendationsFilteringOption value)

public Model.Builder setFilteringOption(RecommendationsFilteringOption value)

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];

Parameter
Name Description
value RecommendationsFilteringOption

The filteringOption to set.
Returns
Type Description
Model.Builder

This builder for chaining.

setFilteringOptionValue(int value)

public Model.Builder setFilteringOptionValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for filteringOption to set.
Returns
Type Description
Model.Builder

This builder for chaining.

setLastTuneTime(Timestamp value)

public Model.Builder setLastTuneTime(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];

Parameter
Name Description
value Timestamp
Returns
Type Description
Model.Builder

setLastTuneTime(Timestamp.Builder builderForValue)

public Model.Builder setLastTuneTime(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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Model.Builder

setModelFeaturesConfig(Model.ModelFeaturesConfig value)

public Model.Builder setModelFeaturesConfig(Model.ModelFeaturesConfig value)

Optional. Additional model features config.

.google.cloud.retail.v2.Model.ModelFeaturesConfig model_features_config = 22 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Model.ModelFeaturesConfig
Returns
Type Description
Model.Builder

setModelFeaturesConfig(Model.ModelFeaturesConfig.Builder builderForValue)

public Model.Builder setModelFeaturesConfig(Model.ModelFeaturesConfig.Builder builderForValue)

Optional. Additional model features config.

.google.cloud.retail.v2.Model.ModelFeaturesConfig model_features_config = 22 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Model.ModelFeaturesConfig.Builder
Returns
Type Description
Model.Builder

setName(String value)

public 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];

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Model.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Model.Builder setNameBytes(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];

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Model.Builder

This builder for chaining.

setOptimizationObjective(String value)

public 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 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];

Parameter
Name Description
value String

The optimizationObjective to set.
Returns
Type Description
Model.Builder

This builder for chaining.

setOptimizationObjectiveBytes(ByteString value)

public Model.Builder setOptimizationObjectiveBytes(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 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];

Parameter
Name Description
value ByteString

The bytes for optimizationObjective to set.
Returns
Type Description
Model.Builder

This builder for chaining.

setPeriodicTuningState(Model.PeriodicTuningState value)

public 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.v2.Model.PeriodicTuningState periodic_tuning_state = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Model.PeriodicTuningState

The periodicTuningState to set.
Returns
Type Description
Model.Builder

This builder for chaining.

setPeriodicTuningStateValue(int value)

public 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.v2.Model.PeriodicTuningState periodic_tuning_state = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for periodicTuningState to set.
Returns
Type Description
Model.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Model.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Model.Builder
Overrides

setServingConfigLists(int index, Model.ServingConfigList value)

public Model.Builder setServingConfigLists(int index, Model.ServingConfigList value)

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];

Parameters
Name Description
index int
value Model.ServingConfigList
Returns
Type Description
Model.Builder

setServingConfigLists(int index, Model.ServingConfigList.Builder builderForValue)

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.v2.Model.ServingConfigList serving_config_lists = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue Model.ServingConfigList.Builder
Returns
Type Description
Model.Builder

setServingState(Model.ServingState value)

public Model.Builder setServingState(Model.ServingState value)

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];

Parameter
Name Description
value Model.ServingState

The servingState to set.
Returns
Type Description
Model.Builder

This builder for chaining.

setServingStateValue(int value)

public Model.Builder setServingStateValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for servingState to set.
Returns
Type Description
Model.Builder

This builder for chaining.

setTrainingState(Model.TrainingState value)

public 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.v2.Model.TrainingState training_state = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Model.TrainingState

The trainingState to set.
Returns
Type Description
Model.Builder

This builder for chaining.

setTrainingStateValue(int value)

public 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.v2.Model.TrainingState training_state = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for trainingState to set.
Returns
Type Description
Model.Builder

This builder for chaining.

setTuningOperation(String value)

public 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];

Parameter
Name Description
value String

The tuningOperation to set.
Returns
Type Description
Model.Builder

This builder for chaining.

setTuningOperationBytes(ByteString value)

public Model.Builder setTuningOperationBytes(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];

Parameter
Name Description
value ByteString

The bytes for tuningOperation to set.
Returns
Type Description
Model.Builder

This builder for chaining.

setType(String value)

public 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 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];

Parameter
Name Description
value String

The type to set.
Returns
Type Description
Model.Builder

This builder for chaining.

setTypeBytes(ByteString value)

public Model.Builder setTypeBytes(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 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];

Parameter
Name Description
value ByteString

The bytes for type to set.
Returns
Type Description
Model.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Model.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Model.Builder
Overrides

setUpdateTime(Timestamp value)

public Model.Builder setUpdateTime(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];

Parameter
Name Description
value Timestamp
Returns
Type Description
Model.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Model.Builder setUpdateTime(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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Model.Builder