- 0.74.0 (latest)
- 0.72.0
- 0.71.0
- 0.70.0
- 0.69.0
- 0.68.0
- 0.66.0
- 0.64.0
- 0.63.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public static interface Engine.MediaRecommendationEngineConfigOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getEngineFeaturesConfig()
public abstract Engine.MediaRecommendationEngineConfig.EngineFeaturesConfig getEngineFeaturesConfig()Optional. Additional engine features config.
.google.cloud.discoveryengine.v1.Engine.MediaRecommendationEngineConfig.EngineFeaturesConfig engine_features_config = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig.EngineFeaturesConfig |
The engineFeaturesConfig. |
getEngineFeaturesConfigOrBuilder()
public abstract Engine.MediaRecommendationEngineConfig.EngineFeaturesConfigOrBuilder getEngineFeaturesConfigOrBuilder()Optional. Additional engine features config.
.google.cloud.discoveryengine.v1.Engine.MediaRecommendationEngineConfig.EngineFeaturesConfig engine_features_config = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig.EngineFeaturesConfigOrBuilder |
|
getOptimizationObjective()
public abstract String getOptimizationObjective() The optimization objective. e.g., cvr.
This field together with optimization_objective describe engine metadata to use to control engine training and serving.
Currently supported
values: ctr, cvr.
If not specified, we choose default based on engine type. Default depends on type of recommendation:
recommended-for-you => ctr
others-you-may-like => ctr
string optimization_objective = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The optimizationObjective. |
getOptimizationObjectiveBytes()
public abstract ByteString getOptimizationObjectiveBytes() The optimization objective. e.g., cvr.
This field together with optimization_objective describe engine metadata to use to control engine training and serving.
Currently supported
values: ctr, cvr.
If not specified, we choose default based on engine type. Default depends on type of recommendation:
recommended-for-you => ctr
others-you-may-like => ctr
string optimization_objective = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for optimizationObjective. |
getOptimizationObjectiveConfig()
public abstract Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig getOptimizationObjectiveConfig() Name and value of the custom threshold for cvr optimization_objective.
For target_field watch-time, target_field_value must be an integer
value indicating the media progress time in seconds between (0, 86400]
(excludes 0, includes 86400) (e.g., 90).
For target_field watch-percentage, the target_field_value must be a
valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
0.5).
.google.cloud.discoveryengine.v1.Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig optimization_objective_config = 3;
| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig |
The optimizationObjectiveConfig. |
getOptimizationObjectiveConfigOrBuilder()
public abstract Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfigOrBuilder getOptimizationObjectiveConfigOrBuilder() Name and value of the custom threshold for cvr optimization_objective.
For target_field watch-time, target_field_value must be an integer
value indicating the media progress time in seconds between (0, 86400]
(excludes 0, includes 86400) (e.g., 90).
For target_field watch-percentage, the target_field_value must be a
valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
0.5).
.google.cloud.discoveryengine.v1.Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig optimization_objective_config = 3;
| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfigOrBuilder |
|
getTrainingState()
public abstract Engine.MediaRecommendationEngineConfig.TrainingState getTrainingState() The training state that the engine 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
engine in order to control cost. If not specified: the default value for
CreateEngine method is TRAINING. The default value for
UpdateEngine method is to keep the state the same as before.
.google.cloud.discoveryengine.v1.Engine.MediaRecommendationEngineConfig.TrainingState training_state = 4;
| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig.TrainingState |
The trainingState. |
getTrainingStateValue()
public abstract int getTrainingStateValue() The training state that the engine 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
engine in order to control cost. If not specified: the default value for
CreateEngine method is TRAINING. The default value for
UpdateEngine method is to keep the state the same as before.
.google.cloud.discoveryengine.v1.Engine.MediaRecommendationEngineConfig.TrainingState training_state = 4;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for trainingState. |
getType()
public abstract String getType() Required. The type of engine. e.g., recommended-for-you.
This field together with optimization_objective describe engine metadata to use to control engine training and serving.
Currently supported values: recommended-for-you, others-you-may-like,
more-like-this, most-popular-items.
string type = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The type. |
getTypeBytes()
public abstract ByteString getTypeBytes() Required. The type of engine. e.g., recommended-for-you.
This field together with optimization_objective describe engine metadata to use to control engine training and serving.
Currently supported values: recommended-for-you, others-you-may-like,
more-like-this, most-popular-items.
string type = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for type. |
hasEngineFeaturesConfig()
public abstract boolean hasEngineFeaturesConfig()Optional. Additional engine features config.
.google.cloud.discoveryengine.v1.Engine.MediaRecommendationEngineConfig.EngineFeaturesConfig engine_features_config = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the engineFeaturesConfig field is set. |
hasOptimizationObjectiveConfig()
public abstract boolean hasOptimizationObjectiveConfig() Name and value of the custom threshold for cvr optimization_objective.
For target_field watch-time, target_field_value must be an integer
value indicating the media progress time in seconds between (0, 86400]
(excludes 0, includes 86400) (e.g., 90).
For target_field watch-percentage, the target_field_value must be a
valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
0.5).
.google.cloud.discoveryengine.v1.Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig optimization_objective_config = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the optimizationObjectiveConfig field is set. |