Class ServingConfig.MediaConfig.Builder (0.50.0)

Version latest

• 0.50.0 (latest)
• 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.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

Inheritance

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

Implements

ServingConfig.MediaConfigOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

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

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

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

clearDemoteContentWatchedPastDays()

public ServingConfig.MediaConfig.Builder clearDemoteContentWatchedPastDays()

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.

int32 demote_content_watched_past_days = 37 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ServingConfig.MediaConfig.Builder	This builder for chaining.

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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public ServingConfig.MediaConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
ServingConfig.MediaConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clone()

public ServingConfig.MediaConfig.Builder clone()

Returns
Type	Description
ServingConfig.MediaConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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

getDemoteContentWatchedPastDays()

public int 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.

int32 demote_content_watched_past_days = 37 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The demoteContentWatchedPastDays.

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

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ServingConfig.MediaConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
ServingConfig.MediaConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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.

setDemoteContentWatchedPastDays(int value)

public ServingConfig.MediaConfig.Builder setDemoteContentWatchedPastDays(int value)

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.

int32 demote_content_watched_past_days = 37 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	int The demoteContentWatchedPastDays 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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final ServingConfig.MediaConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
ServingConfig.MediaConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)