com.google.cloud.discoveryengine.v1alpha

Class Engine.MediaRecommendationEngineConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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.GeneratedMessageV3
implements Engine.MediaRecommendationEngineConfigOrBuilder

 Additional config specs for a Media Recommendation engine.
 

Protobuf type google.cloud.discoveryengine.v1alpha.Engine.MediaRecommendationEngineConfig

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Engine.MediaRecommendationEngineConfig.Builder Additional config specs for a Media Recommendation engine.
static class	Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig Custom threshold for `cvr` optimization_objective.
static interface	Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfigOrBuilder
static class	Engine.MediaRecommendationEngineConfig.TrainingState The training state of the engine.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	OPTIMIZATION_OBJECTIVE_CONFIG_FIELD_NUMBER
static int	OPTIMIZATION_OBJECTIVE_FIELD_NUMBER
static int	TRAINING_STATE_FIELD_NUMBER
static int	TYPE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static Engine.MediaRecommendationEngineConfig	getDefaultInstance()
Engine.MediaRecommendationEngineConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getOptimizationObjective() The optimization objective. e.g., `cvr`.
com.google.protobuf.ByteString	getOptimizationObjectiveBytes() The optimization objective. e.g., `cvr`.
Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfig	getOptimizationObjectiveConfig() Name and value of the custom threshold for cvr optimization_objective.
Engine.MediaRecommendationEngineConfig.OptimizationObjectiveConfigOrBuilder	getOptimizationObjectiveConfigOrBuilder() Name and value of the custom threshold for cvr optimization_objective.
com.google.protobuf.Parser<Engine.MediaRecommendationEngineConfig>	getParserForType()
int	getSerializedSize()
Engine.MediaRecommendationEngineConfig.TrainingState	getTrainingState() The training state that the engine is in (e.g.
int	getTrainingStateValue() The training state that the engine is in (e.g.
String	getType() Required.
com.google.protobuf.ByteString	getTypeBytes() Required.
int	hashCode()
boolean	hasOptimizationObjectiveConfig() Name and value of the custom threshold for cvr optimization_objective.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Engine.MediaRecommendationEngineConfig.Builder	newBuilder()
static Engine.MediaRecommendationEngineConfig.Builder	newBuilder(Engine.MediaRecommendationEngineConfig prototype)
Engine.MediaRecommendationEngineConfig.Builder	newBuilderForType()
protected Engine.MediaRecommendationEngineConfig.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Engine.MediaRecommendationEngineConfig	parseDelimitedFrom(InputStream input)
static Engine.MediaRecommendationEngineConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Engine.MediaRecommendationEngineConfig	parseFrom(byte[] data)
static Engine.MediaRecommendationEngineConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Engine.MediaRecommendationEngineConfig	parseFrom(ByteBuffer data)
static Engine.MediaRecommendationEngineConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Engine.MediaRecommendationEngineConfig	parseFrom(com.google.protobuf.ByteString data)
static Engine.MediaRecommendationEngineConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Engine.MediaRecommendationEngineConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static Engine.MediaRecommendationEngineConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Engine.MediaRecommendationEngineConfig	parseFrom(InputStream input)
static Engine.MediaRecommendationEngineConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Engine.MediaRecommendationEngineConfig>	parser()
Engine.MediaRecommendationEngineConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

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, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER

See Also:

Constant Field Values

OPTIMIZATION_OBJECTIVE_FIELD_NUMBER

public static final int OPTIMIZATION_OBJECTIVE_FIELD_NUMBER

See Also:

Constant Field Values

OPTIMIZATION_OBJECTIVE_CONFIG_FIELD_NUMBER

public static final int OPTIMIZATION_OBJECTIVE_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

TRAINING_STATE_FIELD_NUMBER

public static final int TRAINING_STATE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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

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

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

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.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

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

getDefaultInstanceForType

public Engine.MediaRecommendationEngineConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder