Class ServingConfig.MediaConfig (0.40.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

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

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

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
Exceptions
Type Description
IOException