Package com.google.cloud.discoveryengine.v1alpha

Class Engine.MediaRecommendationEngineConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig
All Implemented Interfaces:
Engine.MediaRecommendationEngineConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
Engine
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.v1alpha.Engine.MediaRecommendationEngineConfig
See Also:

  • Field Details

    • TYPE_FIELD_NUMBER

      public static final int TYPE_FIELD_NUMBER
      See Also:

    • OPTIMIZATION_OBJECTIVE_FIELD_NUMBER

      public static final int OPTIMIZATION_OBJECTIVE_FIELD_NUMBER
      See Also:

    • OPTIMIZATION_OBJECTIVE_CONFIG_FIELD_NUMBER

      public static final int OPTIMIZATION_OBJECTIVE_CONFIG_FIELD_NUMBER
      See Also:

    • TRAINING_STATE_FIELD_NUMBER

      public static final int TRAINING_STATE_FIELD_NUMBER
      See Also:

  • 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

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

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

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

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

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

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Engine.MediaRecommendationEngineConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Engine.MediaRecommendationEngineConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Engine.MediaRecommendationEngineConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Engine.MediaRecommendationEngineConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Engine.MediaRecommendationEngineConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Engine.MediaRecommendationEngineConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Engine.MediaRecommendationEngineConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Engine.MediaRecommendationEngineConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Engine.MediaRecommendationEngineConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Engine.MediaRecommendationEngineConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Engine.MediaRecommendationEngineConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Engine.MediaRecommendationEngineConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static Engine.MediaRecommendationEngineConfig.Builder newBuilder()

    • newBuilder

      public static Engine.MediaRecommendationEngineConfig.Builder newBuilder(Engine.MediaRecommendationEngineConfig prototype)

    • toBuilder

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

    • newBuilderForType

      protected Engine.MediaRecommendationEngineConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Engine.MediaRecommendationEngineConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Engine.MediaRecommendationEngineConfig> parser()

    • getParserForType

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

    • getDefaultInstanceForType

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