com.google.cloud.discoveryengine.v1alpha

Interface Engine.MediaRecommendationEngineConfigOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Engine.MediaRecommendationEngineConfig, Engine.MediaRecommendationEngineConfig.Builder

Enclosing class:

Engine

public static interface Engine.MediaRecommendationEngineConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getOptimizationObjective() The optimization objective. e.g., `cvr`.
com.google.protobuf.ByteString	getOptimizationObjectiveBytes() The optimization objective. e.g., `cvr`.
Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig	getOptimizationObjectiveConfig() Name and value of the custom threshold for cvr optimization_objective.
Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfigOrBuilder	getOptimizationObjectiveConfigOrBuilder() Name and value of the custom threshold for cvr optimization_objective.
Engine.MediaRecommendationEngineConfig.TrainingState	getTrainingState() The training state that the engine is in (e.g.
int	getTrainingStateValue() The training state that the engine is in (e.g.
String	getType() Required.
com.google.protobuf.ByteString	getTypeBytes() Required.
boolean	hasOptimizationObjectiveConfig() Name and value of the custom threshold for cvr optimization_objective.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getType

String getType()

 Required. The type of engine. e.g., `recommended-for-you`.

 This field together with
 [optimization_objective][Engine.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:

The type.

getTypeBytes

com.google.protobuf.ByteString getTypeBytes()

 Required. The type of engine. e.g., `recommended-for-you`.

 This field together with
 [optimization_objective][Engine.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:

The bytes for type.

getOptimizationObjective

String getOptimizationObjective()

 The optimization objective. e.g., `cvr`.

 This field together with
 [optimization_objective][google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig.type]
 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:

The optimizationObjective.

getOptimizationObjectiveBytes

com.google.protobuf.ByteString getOptimizationObjectiveBytes()

 The optimization objective. e.g., `cvr`.

 This field together with
 [optimization_objective][google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig.type]
 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:

The bytes for optimizationObjective.

hasOptimizationObjectiveConfig

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.v1alpha.Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig optimization_objective_config = 3;

Returns:

Whether the optimizationObjectiveConfig field is set.

getOptimizationObjectiveConfig

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.v1alpha.Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig optimization_objective_config = 3;

Returns:

The optimizationObjectiveConfig.

getOptimizationObjectiveConfigOrBuilder

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.v1alpha.Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig optimization_objective_config = 3;

getTrainingStateValue

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.v1alpha.Engine.MediaRecommendationEngineConfig.TrainingState training_state = 4;

Returns:

The enum numeric value on the wire for trainingState.

getTrainingState

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.v1alpha.Engine.MediaRecommendationEngineConfig.TrainingState training_state = 4;

Returns:

The trainingState.