Class ServingConfig.MediaConfig (0.50.0)

Version 0.50.0

• 0.51.0 (latest)
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public static final class ServingConfig.MediaConfig extends GeneratedMessageV3 implements ServingConfig.MediaConfigOrBuilder

Specifies the configurations needed for Media Discovery. Currently we support:

• demote_content_watched: Threshold for watched content demotion. Customers can specify if using watched content demotion or use viewed detail page. Using the content watched demotion, customers need to specify the watched minutes or percentage exceeds the threshold, the content will be demoted in the recommendation result.
• promote_fresh_content: cutoff days for fresh content promotion. Customers can specify if using content freshness promotion. If the content was published within the cutoff days, the content will be promoted in the recommendation result. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION.

Protobuf type google.cloud.discoveryengine.v1alpha.ServingConfig.MediaConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ServingConfig.MediaConfig

Implements

ServingConfig.MediaConfigOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CONTENT_FRESHNESS_CUTOFF_DAYS_FIELD_NUMBER

public static final int CONTENT_FRESHNESS_CUTOFF_DAYS_FIELD_NUMBER

Field Value
Type	Description
int

CONTENT_WATCHED_PERCENTAGE_THRESHOLD_FIELD_NUMBER

public static final int CONTENT_WATCHED_PERCENTAGE_THRESHOLD_FIELD_NUMBER

Field Value
Type	Description
int

CONTENT_WATCHED_SECONDS_THRESHOLD_FIELD_NUMBER

public static final int CONTENT_WATCHED_SECONDS_THRESHOLD_FIELD_NUMBER

Field Value
Type	Description
int

DEMOTION_EVENT_TYPE_FIELD_NUMBER

public static final int DEMOTION_EVENT_TYPE_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static ServingConfig.MediaConfig getDefaultInstance()

Returns
Type	Description
ServingConfig.MediaConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static ServingConfig.MediaConfig.Builder newBuilder()

Returns
Type	Description
ServingConfig.MediaConfig.Builder

newBuilder(ServingConfig.MediaConfig prototype)

public static ServingConfig.MediaConfig.Builder newBuilder(ServingConfig.MediaConfig prototype)

Parameter
Name	Description
prototype	ServingConfig.MediaConfig

Returns
Type	Description
ServingConfig.MediaConfig.Builder

parseDelimitedFrom(InputStream input)

public static ServingConfig.MediaConfig parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
ServingConfig.MediaConfig

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ServingConfig.MediaConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ServingConfig.MediaConfig

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static ServingConfig.MediaConfig parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
ServingConfig.MediaConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ServingConfig.MediaConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ServingConfig.MediaConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ServingConfig.MediaConfig parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
ServingConfig.MediaConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ServingConfig.MediaConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ServingConfig.MediaConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ServingConfig.MediaConfig parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
ServingConfig.MediaConfig

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ServingConfig.MediaConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ServingConfig.MediaConfig

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static ServingConfig.MediaConfig parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
ServingConfig.MediaConfig

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ServingConfig.MediaConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ServingConfig.MediaConfig

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static ServingConfig.MediaConfig parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
ServingConfig.MediaConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ServingConfig.MediaConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ServingConfig.MediaConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<ServingConfig.MediaConfig> parser()

Returns
Type	Description
Parser<MediaConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getContentFreshnessCutoffDays()

public int getContentFreshnessCutoffDays()

Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days.

int32 content_freshness_cutoff_days = 4;

Returns
Type	Description
int	The contentFreshnessCutoffDays.

getContentWatchedPercentageThreshold()

public float getContentWatchedPercentageThreshold()

Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.

float content_watched_percentage_threshold = 2;

Returns
Type	Description
float	The contentWatchedPercentageThreshold.

getContentWatchedSecondsThreshold()

public float getContentWatchedSecondsThreshold()

Specifies the content watched minutes threshold for demotion.

float content_watched_seconds_threshold = 5;

Returns
Type	Description
float	The contentWatchedSecondsThreshold.

getDefaultInstanceForType()

public ServingConfig.MediaConfig getDefaultInstanceForType()

Returns
Type	Description
ServingConfig.MediaConfig

getDemoteContentWatchedCase()

public ServingConfig.MediaConfig.DemoteContentWatchedCase getDemoteContentWatchedCase()

Returns
Type	Description
ServingConfig.MediaConfig.DemoteContentWatchedCase

getDemotionEventType()

public String getDemotionEventType()

Specifies the event type used for demoting recommendation result. Currently supported values:

• view-item: Item viewed.
• media-play: Start/resume watching a video, playing a song, etc.

• media-complete: Finished or stopped midway through a video, song, etc.

  If unset, watch history demotion will not be applied. Content freshness demotion will still be applied.

string demotion_event_type = 1;

Returns
Type	Description
String	The demotionEventType.

getDemotionEventTypeBytes()

public ByteString getDemotionEventTypeBytes()

Specifies the event type used for demoting recommendation result. Currently supported values:

• view-item: Item viewed.
• media-play: Start/resume watching a video, playing a song, etc.

• media-complete: Finished or stopped midway through a video, song, etc.

  If unset, watch history demotion will not be applied. Content freshness demotion will still be applied.

string demotion_event_type = 1;

Returns
Type	Description
ByteString	The bytes for demotionEventType.

getParserForType()

public Parser<ServingConfig.MediaConfig> getParserForType()

Returns
Type	Description
Parser<MediaConfig>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

hasContentWatchedPercentageThreshold()

public boolean hasContentWatchedPercentageThreshold()

Specifies the content watched percentage threshold for demotion. Threshold value must be between [0, 1.0] inclusive.

float content_watched_percentage_threshold = 2;

Returns
Type	Description
boolean	Whether the contentWatchedPercentageThreshold field is set.

hasContentWatchedSecondsThreshold()

public boolean hasContentWatchedSecondsThreshold()

Specifies the content watched minutes threshold for demotion.

float content_watched_seconds_threshold = 5;

Returns
Type	Description
boolean	Whether the contentWatchedSecondsThreshold field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public ServingConfig.MediaConfig.Builder newBuilderForType()

Returns
Type	Description
ServingConfig.MediaConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ServingConfig.MediaConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
ServingConfig.MediaConfig.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public ServingConfig.MediaConfig.Builder toBuilder()

Returns
Type	Description
ServingConfig.MediaConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException