public static final class Engine.MediaRecommendationEngineConfig extends com.google.protobuf.GeneratedMessage implements Engine.MediaRecommendationEngineConfigOrBuilder
Additional config specs for a Media Recommendation engine.Protobuf type
google.cloud.discoveryengine.v1.Engine.MediaRecommendationEngineConfigcom.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
ENGINE_FEATURES_CONFIG_FIELD_NUMBER |
static int |
OPTIMIZATION_OBJECTIVE_CONFIG_FIELD_NUMBER |
static int |
OPTIMIZATION_OBJECTIVE_FIELD_NUMBER |
static int |
TRAINING_STATE_FIELD_NUMBER |
static int |
TYPE_FIELD_NUMBER |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashFields, toStringaddAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int TYPE_FIELD_NUMBER
public static final int OPTIMIZATION_OBJECTIVE_FIELD_NUMBER
public static final int OPTIMIZATION_OBJECTIVE_CONFIG_FIELD_NUMBER
public static final int TRAINING_STATE_FIELD_NUMBER
public static final int ENGINE_FEATURES_CONFIG_FIELD_NUMBER
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessagepublic String getType()
Required. The type of engine. e.g., `recommended-for-you`. This field together with [optimization_objective][google.cloud.discoveryengine.v1.Engine.MediaRecommendationEngineConfig.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];getType in interface Engine.MediaRecommendationEngineConfigOrBuilderpublic com.google.protobuf.ByteString getTypeBytes()
Required. The type of engine. e.g., `recommended-for-you`. This field together with [optimization_objective][google.cloud.discoveryengine.v1.Engine.MediaRecommendationEngineConfig.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];getTypeBytes in interface Engine.MediaRecommendationEngineConfigOrBuilderpublic String getOptimizationObjective()
The optimization objective. e.g., `cvr`. This field together with [optimization_objective][google.cloud.discoveryengine.v1.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;getOptimizationObjective in interface Engine.MediaRecommendationEngineConfigOrBuilderpublic com.google.protobuf.ByteString getOptimizationObjectiveBytes()
The optimization objective. e.g., `cvr`. This field together with [optimization_objective][google.cloud.discoveryengine.v1.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;getOptimizationObjectiveBytes in interface Engine.MediaRecommendationEngineConfigOrBuilderpublic 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;
hasOptimizationObjectiveConfig in interface Engine.MediaRecommendationEngineConfigOrBuilderpublic 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;
getOptimizationObjectiveConfig in interface Engine.MediaRecommendationEngineConfigOrBuilderpublic 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;
getOptimizationObjectiveConfigOrBuilder in interface Engine.MediaRecommendationEngineConfigOrBuilderpublic 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;
getTrainingStateValue in interface Engine.MediaRecommendationEngineConfigOrBuilderpublic 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;
getTrainingState in interface Engine.MediaRecommendationEngineConfigOrBuilderpublic boolean hasEngineFeaturesConfig()
Optional. Additional engine features config.
.google.cloud.discoveryengine.v1.Engine.MediaRecommendationEngineConfig.EngineFeaturesConfig engine_features_config = 5 [(.google.api.field_behavior) = OPTIONAL];
hasEngineFeaturesConfig in interface Engine.MediaRecommendationEngineConfigOrBuilderpublic 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];
getEngineFeaturesConfig in interface Engine.MediaRecommendationEngineConfigOrBuilderpublic 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];
getEngineFeaturesConfigOrBuilder in interface Engine.MediaRecommendationEngineConfigOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessagepublic void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageIOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessagepublic boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Engine.MediaRecommendationEngineConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Engine.MediaRecommendationEngineConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Engine.MediaRecommendationEngineConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Engine.MediaRecommendationEngineConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Engine.MediaRecommendationEngineConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Engine.MediaRecommendationEngineConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Engine.MediaRecommendationEngineConfig parseFrom(InputStream input) throws IOException
IOExceptionpublic static Engine.MediaRecommendationEngineConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Engine.MediaRecommendationEngineConfig parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Engine.MediaRecommendationEngineConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Engine.MediaRecommendationEngineConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Engine.MediaRecommendationEngineConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Engine.MediaRecommendationEngineConfig.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Engine.MediaRecommendationEngineConfig.Builder newBuilder()
public static Engine.MediaRecommendationEngineConfig.Builder newBuilder(Engine.MediaRecommendationEngineConfig prototype)
public Engine.MediaRecommendationEngineConfig.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Engine.MediaRecommendationEngineConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
newBuilderForType in class com.google.protobuf.AbstractMessagepublic static Engine.MediaRecommendationEngineConfig getDefaultInstance()
public static com.google.protobuf.Parser<Engine.MediaRecommendationEngineConfig> parser()
public com.google.protobuf.Parser<Engine.MediaRecommendationEngineConfig> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessagepublic Engine.MediaRecommendationEngineConfig getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2026 Google LLC. All rights reserved.