Package com.google.cloud.discoveryengine.v1alpha

Class Engine.MediaRecommendationEngineConfig.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Engine.MediaRecommendationEngineConfig.Builder>
com.google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig.Builder
All Implemented Interfaces:
Engine.MediaRecommendationEngineConfigOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Engine.MediaRecommendationEngineConfig
public static final class Engine.MediaRecommendationEngineConfig.Builder extends com.google.protobuf.GeneratedMessage.Builder<Engine.MediaRecommendationEngineConfig.Builder> implements Engine.MediaRecommendationEngineConfigOrBuilder
 Additional config specs for a Media Recommendation engine.
Protobuf type google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Engine.MediaRecommendationEngineConfig.Builder>

    • clear

      public Engine.MediaRecommendationEngineConfig.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<Engine.MediaRecommendationEngineConfig.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Engine.MediaRecommendationEngineConfig.Builder>

    • getDefaultInstanceForType

      public Engine.MediaRecommendationEngineConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public Engine.MediaRecommendationEngineConfig build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public Engine.MediaRecommendationEngineConfig buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public Engine.MediaRecommendationEngineConfig.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Engine.MediaRecommendationEngineConfig.Builder>

    • mergeFrom

      public Engine.MediaRecommendationEngineConfig.Builder mergeFrom(Engine.MediaRecommendationEngineConfig other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Engine.MediaRecommendationEngineConfig.Builder>

    • mergeFrom

      public Engine.MediaRecommendationEngineConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Engine.MediaRecommendationEngineConfig.Builder>
      Throws:
      IOException

    • getType

      public 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];
      Specified by:
      getType in interface Engine.MediaRecommendationEngineConfigOrBuilder
      Returns:
      The type.

    • getTypeBytes

      public 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];
      Specified by:
      getTypeBytes in interface Engine.MediaRecommendationEngineConfigOrBuilder
      Returns:
      The bytes for type.

    • setType

      public 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];
      Parameters:
      value - The type to set.
      Returns:
      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][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:
      This builder for chaining.

    • setTypeBytes

      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];
      Parameters:
      value - The bytes for type to set.
      Returns:
      This builder for chaining.

    • getOptimizationObjective

      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;
      Specified by:
      getOptimizationObjective in interface Engine.MediaRecommendationEngineConfigOrBuilder
      Returns:
      The optimizationObjective.

    • getOptimizationObjectiveBytes

      public 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;
      Specified by:
      getOptimizationObjectiveBytes in interface Engine.MediaRecommendationEngineConfigOrBuilder
      Returns:
      The bytes for optimizationObjective.

    • setOptimizationObjective

      public 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;
      Parameters:
      value - The optimizationObjective to set.
      Returns:
      This builder for chaining.

    • clearOptimizationObjective

      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;
      Returns:
      This builder for chaining.

    • setOptimizationObjectiveBytes

      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;
      Parameters:
      value - The bytes for optimizationObjective to set.
      Returns:
      This builder for chaining.

    • 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;
      Specified by:
      hasOptimizationObjectiveConfig in interface Engine.MediaRecommendationEngineConfigOrBuilder
      Returns:
      Whether the optimizationObjectiveConfig field is set.

    • 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;
      Specified by:
      getOptimizationObjectiveConfig in interface Engine.MediaRecommendationEngineConfigOrBuilder
      Returns:
      The optimizationObjectiveConfig.

    • setOptimizationObjectiveConfig

      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;

    • setOptimizationObjectiveConfig

      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;

    • mergeOptimizationObjectiveConfig

      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;

    • 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;

    • 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;

    • 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;
      Specified by:
      getOptimizationObjectiveConfigOrBuilder in interface Engine.MediaRecommendationEngineConfigOrBuilder

    • 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;
      Specified by:
      getTrainingStateValue in interface Engine.MediaRecommendationEngineConfigOrBuilder
      Returns:
      The enum numeric value on the wire for trainingState.

    • setTrainingStateValue

      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;
      Parameters:
      value - The enum numeric value on the wire for trainingState to set.
      Returns:
      This builder for chaining.

    • 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;
      Specified by:
      getTrainingState in interface Engine.MediaRecommendationEngineConfigOrBuilder
      Returns:
      The trainingState.

    • setTrainingState

      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;
      Parameters:
      value - The trainingState to set.
      Returns:
      This builder for chaining.

    • 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:
      This builder for chaining.