public static final class Engine.MediaRecommendationEngineConfig.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Engine.MediaRecommendationEngineConfig.Builder> implements Engine.MediaRecommendationEngineConfigOrBuilder
Additional config specs for a Media Recommendation engine.Protobuf type
google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfiggetAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Engine.MediaRecommendationEngineConfig.Builder>public Engine.MediaRecommendationEngineConfig.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<Engine.MediaRecommendationEngineConfig.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Engine.MediaRecommendationEngineConfig.Builder>public Engine.MediaRecommendationEngineConfig getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic Engine.MediaRecommendationEngineConfig build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic Engine.MediaRecommendationEngineConfig buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic Engine.MediaRecommendationEngineConfig.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<Engine.MediaRecommendationEngineConfig.Builder>public Engine.MediaRecommendationEngineConfig.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<Engine.MediaRecommendationEngineConfig.Builder>public Engine.MediaRecommendationEngineConfig.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<Engine.MediaRecommendationEngineConfig.Builder>public Engine.MediaRecommendationEngineConfig.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Engine.MediaRecommendationEngineConfig.Builder>public Engine.MediaRecommendationEngineConfig.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Engine.MediaRecommendationEngineConfig.Builder>public Engine.MediaRecommendationEngineConfig.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Engine.MediaRecommendationEngineConfig.Builder>public Engine.MediaRecommendationEngineConfig.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Engine.MediaRecommendationEngineConfig.Builder>public Engine.MediaRecommendationEngineConfig.Builder mergeFrom(Engine.MediaRecommendationEngineConfig other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Engine.MediaRecommendationEngineConfig.Builder>public Engine.MediaRecommendationEngineConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Engine.MediaRecommendationEngineConfig.Builder>IOExceptionpublic 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];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][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];getTypeBytes in interface Engine.MediaRecommendationEngineConfigOrBuilderpublic Engine.MediaRecommendationEngineConfig.Builder setType(String value)
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];value - The type to set.public Engine.MediaRecommendationEngineConfig.Builder clearType()
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];public Engine.MediaRecommendationEngineConfig.Builder setTypeBytes(com.google.protobuf.ByteString value)
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];value - The bytes for type to set.public 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;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.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;getOptimizationObjectiveBytes in interface Engine.MediaRecommendationEngineConfigOrBuilderpublic Engine.MediaRecommendationEngineConfig.Builder setOptimizationObjective(String value)
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;value - The optimizationObjective to set.public Engine.MediaRecommendationEngineConfig.Builder clearOptimizationObjective()
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;public Engine.MediaRecommendationEngineConfig.Builder setOptimizationObjectiveBytes(com.google.protobuf.ByteString value)
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;value - The bytes for optimizationObjective to set.public 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;
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.v1alpha.Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig optimization_objective_config = 3;
getOptimizationObjectiveConfig in interface Engine.MediaRecommendationEngineConfigOrBuilderpublic Engine.MediaRecommendationEngineConfig.Builder setOptimizationObjectiveConfig(Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig value)
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;
public Engine.MediaRecommendationEngineConfig.Builder setOptimizationObjectiveConfig(Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig.Builder builderForValue)
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;
public Engine.MediaRecommendationEngineConfig.Builder mergeOptimizationObjectiveConfig(Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig value)
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;
public Engine.MediaRecommendationEngineConfig.Builder clearOptimizationObjectiveConfig()
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;
public Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig.Builder getOptimizationObjectiveConfigBuilder()
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;
public 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;
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.v1alpha.Engine.MediaRecommendationEngineConfig.TrainingState training_state = 4;
getTrainingStateValue in interface Engine.MediaRecommendationEngineConfigOrBuilderpublic Engine.MediaRecommendationEngineConfig.Builder setTrainingStateValue(int value)
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;
value - The enum numeric value on the wire for trainingState to set.public 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;
getTrainingState in interface Engine.MediaRecommendationEngineConfigOrBuilderpublic Engine.MediaRecommendationEngineConfig.Builder setTrainingState(Engine.MediaRecommendationEngineConfig.TrainingState value)
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;
value - The trainingState to set.public Engine.MediaRecommendationEngineConfig.Builder clearTrainingState()
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;
public final Engine.MediaRecommendationEngineConfig.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Engine.MediaRecommendationEngineConfig.Builder>public final Engine.MediaRecommendationEngineConfig.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Engine.MediaRecommendationEngineConfig.Builder>Copyright © 2024 Google LLC. All rights reserved.