Class ServingConfig.MediaConfig.Builder (0.41.0)

public static final class ServingConfig.MediaConfig.Builder extends GeneratedMessageV3.Builder<ServingConfig.MediaConfig.Builder> 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.v1beta.ServingConfig.MediaConfig

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ServingConfig.MediaConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ServingConfig.MediaConfig.Builder
Overrides

build()

public ServingConfig.MediaConfig build()
Returns
Type Description
ServingConfig.MediaConfig

buildPartial()

public ServingConfig.MediaConfig buildPartial()
Returns
Type Description
ServingConfig.MediaConfig

clear()

public ServingConfig.MediaConfig.Builder clear()
Returns
Type Description
ServingConfig.MediaConfig.Builder
Overrides

clearContentFreshnessCutoffDays()

public ServingConfig.MediaConfig.Builder clearContentFreshnessCutoffDays()

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
ServingConfig.MediaConfig.Builder

This builder for chaining.

clearContentWatchedPercentageThreshold()

public ServingConfig.MediaConfig.Builder clearContentWatchedPercentageThreshold()

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
ServingConfig.MediaConfig.Builder

This builder for chaining.

clearContentWatchedSecondsThreshold()

public ServingConfig.MediaConfig.Builder clearContentWatchedSecondsThreshold()

Specifies the content watched minutes threshold for demotion.

float content_watched_seconds_threshold = 5;

Returns
Type Description
ServingConfig.MediaConfig.Builder

This builder for chaining.

clearDemoteContentWatched()

public ServingConfig.MediaConfig.Builder clearDemoteContentWatched()
Returns
Type Description
ServingConfig.MediaConfig.Builder

clearDemotionEventType()

public ServingConfig.MediaConfig.Builder clearDemotionEventType()

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
ServingConfig.MediaConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ServingConfig.MediaConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ServingConfig.MediaConfig.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ServingConfig.MediaConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ServingConfig.MediaConfig.Builder
Overrides

clone()

public ServingConfig.MediaConfig.Builder clone()
Returns
Type Description
ServingConfig.MediaConfig.Builder
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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ServingConfig.MediaConfig other)

public ServingConfig.MediaConfig.Builder mergeFrom(ServingConfig.MediaConfig other)
Parameter
Name Description
other ServingConfig.MediaConfig
Returns
Type Description
ServingConfig.MediaConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ServingConfig.MediaConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ServingConfig.MediaConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ServingConfig.MediaConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ServingConfig.MediaConfig.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ServingConfig.MediaConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ServingConfig.MediaConfig.Builder
Overrides

setContentFreshnessCutoffDays(int value)

public ServingConfig.MediaConfig.Builder setContentFreshnessCutoffDays(int value)

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;

Parameter
Name Description
value int

The contentFreshnessCutoffDays to set.

Returns
Type Description
ServingConfig.MediaConfig.Builder

This builder for chaining.

setContentWatchedPercentageThreshold(float value)

public ServingConfig.MediaConfig.Builder setContentWatchedPercentageThreshold(float value)

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

float content_watched_percentage_threshold = 2;

Parameter
Name Description
value float

The contentWatchedPercentageThreshold to set.

Returns
Type Description
ServingConfig.MediaConfig.Builder

This builder for chaining.

setContentWatchedSecondsThreshold(float value)

public ServingConfig.MediaConfig.Builder setContentWatchedSecondsThreshold(float value)

Specifies the content watched minutes threshold for demotion.

float content_watched_seconds_threshold = 5;

Parameter
Name Description
value float

The contentWatchedSecondsThreshold to set.

Returns
Type Description
ServingConfig.MediaConfig.Builder

This builder for chaining.

setDemotionEventType(String value)

public ServingConfig.MediaConfig.Builder setDemotionEventType(String value)

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;

Parameter
Name Description
value String

The demotionEventType to set.

Returns
Type Description
ServingConfig.MediaConfig.Builder

This builder for chaining.

setDemotionEventTypeBytes(ByteString value)

public ServingConfig.MediaConfig.Builder setDemotionEventTypeBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for demotionEventType to set.

Returns
Type Description
ServingConfig.MediaConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ServingConfig.MediaConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ServingConfig.MediaConfig.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ServingConfig.MediaConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ServingConfig.MediaConfig.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ServingConfig.MediaConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ServingConfig.MediaConfig.Builder
Overrides