com.google.api.services.discoveryengine.v1.model

Class GoogleCloudDiscoveryengineV1ServingConfigMediaConfig

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.discoveryengine.v1.model.GoogleCloudDiscoveryengineV1ServingConfigMediaConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleCloudDiscoveryengineV1ServingConfigMediaConfig
extends com.google.api.client.json.GenericJson

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.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Discovery Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GoogleCloudDiscoveryengineV1ServingConfigMediaConfig()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1ServingConfigMediaConfig	clone()
Integer	getContentFreshnessCutoffDays() Specifies the content freshness used for recommendation result.
Float	getContentWatchedPercentageThreshold() Specifies the content watched percentage threshold for demotion.
Float	getContentWatchedSecondsThreshold() Specifies the content watched minutes threshold for demotion.
Integer	getDemoteContentWatchedPastDays() Optional.
String	getDemotionEventType() Specifies the event type used for demoting recommendation result.
GoogleCloudDiscoveryengineV1ServingConfigMediaConfig	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1ServingConfigMediaConfig	setContentFreshnessCutoffDays(Integer contentFreshnessCutoffDays) Specifies the content freshness used for recommendation result.
GoogleCloudDiscoveryengineV1ServingConfigMediaConfig	setContentWatchedPercentageThreshold(Float contentWatchedPercentageThreshold) Specifies the content watched percentage threshold for demotion.
GoogleCloudDiscoveryengineV1ServingConfigMediaConfig	setContentWatchedSecondsThreshold(Float contentWatchedSecondsThreshold) Specifies the content watched minutes threshold for demotion.
GoogleCloudDiscoveryengineV1ServingConfigMediaConfig	setDemoteContentWatchedPastDays(Integer demoteContentWatchedPastDays) Optional.
GoogleCloudDiscoveryengineV1ServingConfigMediaConfig	setDemotionEventType(String demotionEventType) Specifies the event type used for demoting recommendation result.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GoogleCloudDiscoveryengineV1ServingConfigMediaConfig

public GoogleCloudDiscoveryengineV1ServingConfigMediaConfig()

Method Detail

getContentFreshnessCutoffDays

public Integer getContentFreshnessCutoffDays()

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

Returns:

value or null for none

setContentFreshnessCutoffDays

public GoogleCloudDiscoveryengineV1ServingConfigMediaConfig setContentFreshnessCutoffDays(Integer contentFreshnessCutoffDays)

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

Parameters:

contentFreshnessCutoffDays - contentFreshnessCutoffDays or null for none

getContentWatchedPercentageThreshold

public Float getContentWatchedPercentageThreshold()

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

Returns:

value or null for none

setContentWatchedPercentageThreshold

public GoogleCloudDiscoveryengineV1ServingConfigMediaConfig setContentWatchedPercentageThreshold(Float contentWatchedPercentageThreshold)

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

Parameters:

contentWatchedPercentageThreshold - contentWatchedPercentageThreshold or null for none

getContentWatchedSecondsThreshold

public Float getContentWatchedSecondsThreshold()

Specifies the content watched minutes threshold for demotion.

Returns:

value or null for none

setContentWatchedSecondsThreshold

public GoogleCloudDiscoveryengineV1ServingConfigMediaConfig setContentWatchedSecondsThreshold(Float contentWatchedSecondsThreshold)

Specifies the content watched minutes threshold for demotion.

Parameters:

contentWatchedSecondsThreshold - contentWatchedSecondsThreshold or null for none

getDemoteContentWatchedPastDays

public Integer getDemoteContentWatchedPastDays()

Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days.

Returns:

value or null for none

setDemoteContentWatchedPastDays

public GoogleCloudDiscoveryengineV1ServingConfigMediaConfig setDemoteContentWatchedPastDays(Integer demoteContentWatchedPastDays)

Optional. Specifies the number of days to look back for demoting watched content. If set to zero or unset, defaults to the maximum of 365 days.

Parameters:

demoteContentWatchedPastDays - demoteContentWatchedPastDays or null for none

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.

Returns:

value or null for none

setDemotionEventType

public GoogleCloudDiscoveryengineV1ServingConfigMediaConfig setDemotionEventType(String demotionEventType)

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.

Parameters:

demotionEventType - demotionEventType or null for none

set

public GoogleCloudDiscoveryengineV1ServingConfigMediaConfig set(String fieldName,
                                                                Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public GoogleCloudDiscoveryengineV1ServingConfigMediaConfig clone()

Overrides:

clone in class com.google.api.client.json.GenericJson