public static final class Engine.MediaRecommendationEngineConfig.Builder extends GeneratedMessageV3.Builder<Engine.MediaRecommendationEngineConfig.Builder> implements Engine.MediaRecommendationEngineConfigOrBuilderAdditional config specs for a Media Recommendation engine.
Protobuf type
google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Engine.MediaRecommendationEngineConfig.BuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Engine.MediaRecommendationEngineConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig.Builder |
|
build()
public Engine.MediaRecommendationEngineConfig build()| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig |
|
buildPartial()
public Engine.MediaRecommendationEngineConfig buildPartial()| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig |
|
clear()
public Engine.MediaRecommendationEngineConfig.Builder clear()| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public Engine.MediaRecommendationEngineConfig.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public Engine.MediaRecommendationEngineConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig.Builder |
|
clearOptimizationObjective()
public Engine.MediaRecommendationEngineConfig.Builder clearOptimizationObjective() 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 |
Engine.MediaRecommendationEngineConfig.Builder |
This builder for chaining. |
clearOptimizationObjectiveConfig()
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;
| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig.Builder |
|
clearTrainingState()
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;
| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig.Builder |
This builder for chaining. |
clearType()
public Engine.MediaRecommendationEngineConfig.Builder clearType() 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 |
Engine.MediaRecommendationEngineConfig.Builder |
This builder for chaining. |
clone()
public Engine.MediaRecommendationEngineConfig.Builder clone()| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig.Builder |
|
getDefaultInstanceForType()
public Engine.MediaRecommendationEngineConfig getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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
string optimization_objective = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The optimizationObjective. |
getOptimizationObjectiveBytes()
public 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 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 | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig |
The optimizationObjectiveConfig. |
getOptimizationObjectiveConfigBuilder()
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;
| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig.Builder |
|
getOptimizationObjectiveConfigOrBuilder()
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;
| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfigOrBuilder |
|
getTrainingState()
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;
| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig.TrainingState |
The trainingState. |
getTrainingStateValue()
public 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 | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for trainingState. |
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.
string type = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The type. |
getTypeBytes()
public 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. |
hasOptimizationObjectiveConfig()
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;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the optimizationObjectiveConfig field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(Engine.MediaRecommendationEngineConfig other)
public Engine.MediaRecommendationEngineConfig.Builder mergeFrom(Engine.MediaRecommendationEngineConfig other)| Parameter | |
|---|---|
| Name | Description |
other |
Engine.MediaRecommendationEngineConfig |
| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Engine.MediaRecommendationEngineConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Engine.MediaRecommendationEngineConfig.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig.Builder |
|
mergeOptimizationObjectiveConfig(Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig value)
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;
| Parameter | |
|---|---|
| Name | Description |
value |
Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig |
| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Engine.MediaRecommendationEngineConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public Engine.MediaRecommendationEngineConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig.Builder |
|
setOptimizationObjective(String value)
public Engine.MediaRecommendationEngineConfig.Builder setOptimizationObjective(String value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe optimizationObjective to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig.Builder |
This builder for chaining. |
setOptimizationObjectiveBytes(ByteString value)
public Engine.MediaRecommendationEngineConfig.Builder setOptimizationObjectiveBytes(ByteString value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for optimizationObjective to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig.Builder |
This builder for chaining. |
setOptimizationObjectiveConfig(Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig value)
public 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;
| Parameter | |
|---|---|
| Name | Description |
value |
Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig |
| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig.Builder |
|
setOptimizationObjectiveConfig(Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig.Builder builderForValue)
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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig.Builder |
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Engine.MediaRecommendationEngineConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig.Builder |
|
setTrainingState(Engine.MediaRecommendationEngineConfig.TrainingState value)
public 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;
| Parameter | |
|---|---|
| Name | Description |
value |
Engine.MediaRecommendationEngineConfig.TrainingStateThe trainingState to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig.Builder |
This builder for chaining. |
setTrainingStateValue(int value)
public 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;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for trainingState to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig.Builder |
This builder for chaining. |
setType(String value)
public Engine.MediaRecommendationEngineConfig.Builder setType(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe type to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig.Builder |
This builder for chaining. |
setTypeBytes(ByteString value)
public Engine.MediaRecommendationEngineConfig.Builder setTypeBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for type to set. |
| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Engine.MediaRecommendationEngineConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Engine.MediaRecommendationEngineConfig.Builder |
|