com.google.api.services.discoveryengine.v1.model

Class GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.discoveryengine.v1.model.GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig
extends com.google.api.client.json.GenericJson

Additional config specs for a Media Recommendation engine.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Discovery Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig	clone()
GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig	getEngineFeaturesConfig() Optional.
String	getOptimizationObjective() The optimization objective.
GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig	getOptimizationObjectiveConfig() Name and value of the custom threshold for cvr optimization_objective.
String	getTrainingState() The training state that the engine is in (e.g.
String	getType() Required.
GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig	setEngineFeaturesConfig(GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig engineFeaturesConfig) Optional.
GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig	setOptimizationObjective(String optimizationObjective) The optimization objective.
GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig	setOptimizationObjectiveConfig(GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig optimizationObjectiveConfig) Name and value of the custom threshold for cvr optimization_objective.
GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig	setTrainingState(String trainingState) The training state that the engine is in (e.g.
GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig	setType(String type) Required.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig

public GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig()

Method Detail

getEngineFeaturesConfig

public GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig getEngineFeaturesConfig()

Optional. Additional engine features config.

Returns:

value or null for none

setEngineFeaturesConfig

public GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig setEngineFeaturesConfig(GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigEngineFeaturesConfig engineFeaturesConfig)

Optional. Additional engine features config.

Parameters:

engineFeaturesConfig - engineFeaturesConfig or null for none

getOptimizationObjective

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

Returns:

value or null for none

setOptimizationObjective

public GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig setOptimizationObjective(String optimizationObjective)

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`

Parameters:

optimizationObjective - optimizationObjective or null for none

getOptimizationObjectiveConfig

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

Returns:

value or null for none

setOptimizationObjectiveConfig

public GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig setOptimizationObjectiveConfig(GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfigOptimizationObjectiveConfig optimizationObjectiveConfig)

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

Parameters:

optimizationObjectiveConfig - optimizationObjectiveConfig or null for none

getTrainingState

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

Returns:

value or null for none

setTrainingState

public GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig setTrainingState(String trainingState)

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.

Parameters:

trainingState - trainingState or null for none

getType

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

Returns:

value or null for none

setType

public GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig setType(String type)

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

Parameters:

type - type or null for none

set

public GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig set(String fieldName,
                                                                             Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public GoogleCloudDiscoveryengineV1EngineMediaRecommendationEngineConfig clone()

Overrides:

clone in class com.google.api.client.json.GenericJson