com.google.cloud.discoveryengine.v1alpha

Class ServingConfig.MediaConfig.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<ServingConfig.MediaConfig.Builder>

com.google.cloud.discoveryengine.v1alpha.ServingConfig.MediaConfig.Builder

All Implemented Interfaces:

ServingConfig.MediaConfigOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

ServingConfig.MediaConfig

public static final class ServingConfig.MediaConfig.Builder
extends com.google.protobuf.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][google.cloud.discoveryengine.v1alpha.SolutionType] is
 [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION].
 

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

Method Summary

Modifier and Type	Method and Description
ServingConfig.MediaConfig.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ServingConfig.MediaConfig	build()
ServingConfig.MediaConfig	buildPartial()
ServingConfig.MediaConfig.Builder	clear()
ServingConfig.MediaConfig.Builder	clearContentFreshnessCutoffDays() Specifies the content freshness used for recommendation result.
ServingConfig.MediaConfig.Builder	clearContentWatchedPercentageThreshold() Specifies the content watched percentage threshold for demotion.
ServingConfig.MediaConfig.Builder	clearContentWatchedSecondsThreshold() Specifies the content watched minutes threshold for demotion.
ServingConfig.MediaConfig.Builder	clearDemoteContentWatched()
ServingConfig.MediaConfig.Builder	clearDemotionEventType() Specifies the event type used for demoting recommendation result.
ServingConfig.MediaConfig.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
ServingConfig.MediaConfig.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
ServingConfig.MediaConfig.Builder	clone()
int	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.
ServingConfig.MediaConfig	getDefaultInstanceForType()
ServingConfig.MediaConfig.DemoteContentWatchedCase	getDemoteContentWatchedCase()
String	getDemotionEventType() Specifies the event type used for demoting recommendation result.
com.google.protobuf.ByteString	getDemotionEventTypeBytes() Specifies the event type used for demoting recommendation result.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
boolean	hasContentWatchedPercentageThreshold() Specifies the content watched percentage threshold for demotion.
boolean	hasContentWatchedSecondsThreshold() Specifies the content watched minutes threshold for demotion.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ServingConfig.MediaConfig.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ServingConfig.MediaConfig.Builder	mergeFrom(com.google.protobuf.Message other)
ServingConfig.MediaConfig.Builder	mergeFrom(ServingConfig.MediaConfig other)
ServingConfig.MediaConfig.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
ServingConfig.MediaConfig.Builder	setContentFreshnessCutoffDays(int value) Specifies the content freshness used for recommendation result.
ServingConfig.MediaConfig.Builder	setContentWatchedPercentageThreshold(float value) Specifies the content watched percentage threshold for demotion.
ServingConfig.MediaConfig.Builder	setContentWatchedSecondsThreshold(float value) Specifies the content watched minutes threshold for demotion.
ServingConfig.MediaConfig.Builder	setDemotionEventType(String value) Specifies the event type used for demoting recommendation result.
ServingConfig.MediaConfig.Builder	setDemotionEventTypeBytes(com.google.protobuf.ByteString value) Specifies the event type used for demoting recommendation result.
ServingConfig.MediaConfig.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
ServingConfig.MediaConfig.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
ServingConfig.MediaConfig.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ServingConfig.MediaConfig.Builder>

clear

public ServingConfig.MediaConfig.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<ServingConfig.MediaConfig.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ServingConfig.MediaConfig.Builder>

getDefaultInstanceForType

public ServingConfig.MediaConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public ServingConfig.MediaConfig build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public ServingConfig.MediaConfig buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public ServingConfig.MediaConfig.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<ServingConfig.MediaConfig.Builder>

setField

public ServingConfig.MediaConfig.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<ServingConfig.MediaConfig.Builder>

clearField

public ServingConfig.MediaConfig.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ServingConfig.MediaConfig.Builder>

clearOneof

public ServingConfig.MediaConfig.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ServingConfig.MediaConfig.Builder>

setRepeatedField

public ServingConfig.MediaConfig.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                          int index,
                                                          Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ServingConfig.MediaConfig.Builder>

addRepeatedField

public ServingConfig.MediaConfig.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                          Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ServingConfig.MediaConfig.Builder>

mergeFrom

public ServingConfig.MediaConfig.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ServingConfig.MediaConfig.Builder>

mergeFrom

public ServingConfig.MediaConfig.Builder mergeFrom(ServingConfig.MediaConfig other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ServingConfig.MediaConfig.Builder>

mergeFrom

public ServingConfig.MediaConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ServingConfig.MediaConfig.Builder>

Throws:

IOException

getDemoteContentWatchedCase

public ServingConfig.MediaConfig.DemoteContentWatchedCase getDemoteContentWatchedCase()

Specified by:

getDemoteContentWatchedCase in interface ServingConfig.MediaConfigOrBuilder

clearDemoteContentWatched

public ServingConfig.MediaConfig.Builder clearDemoteContentWatched()

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;

Specified by:

hasContentWatchedPercentageThreshold in interface ServingConfig.MediaConfigOrBuilder

Returns:

Whether the contentWatchedPercentageThreshold field is set.

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;

Specified by:

getContentWatchedPercentageThreshold in interface ServingConfig.MediaConfigOrBuilder

Returns:

The contentWatchedPercentageThreshold.

setContentWatchedPercentageThreshold

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;

Parameters:

value - The contentWatchedPercentageThreshold to set.

Returns:

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:

This builder for chaining.

hasContentWatchedSecondsThreshold

public boolean hasContentWatchedSecondsThreshold()

 Specifies the content watched minutes threshold for demotion.
 

float content_watched_seconds_threshold = 5;

Specified by:

hasContentWatchedSecondsThreshold in interface ServingConfig.MediaConfigOrBuilder

Returns:

Whether the contentWatchedSecondsThreshold field is set.

getContentWatchedSecondsThreshold

public float getContentWatchedSecondsThreshold()

 Specifies the content watched minutes threshold for demotion.
 

float content_watched_seconds_threshold = 5;

Specified by:

getContentWatchedSecondsThreshold in interface ServingConfig.MediaConfigOrBuilder

Returns:

The contentWatchedSecondsThreshold.

setContentWatchedSecondsThreshold

public ServingConfig.MediaConfig.Builder setContentWatchedSecondsThreshold(float value)

 Specifies the content watched minutes threshold for demotion.
 

float content_watched_seconds_threshold = 5;

Parameters:

value - The contentWatchedSecondsThreshold to set.

Returns:

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:

This builder for chaining.

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;

Specified by:

getDemotionEventType in interface ServingConfig.MediaConfigOrBuilder

Returns:

The demotionEventType.

getDemotionEventTypeBytes

public com.google.protobuf.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;

Specified by:

getDemotionEventTypeBytes in interface ServingConfig.MediaConfigOrBuilder

Returns:

The bytes for demotionEventType.

setDemotionEventType

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;

Parameters:

value - The demotionEventType to set.

Returns:

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:

This builder for chaining.

setDemotionEventTypeBytes

public ServingConfig.MediaConfig.Builder setDemotionEventTypeBytes(com.google.protobuf.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;

Parameters:

value - The bytes for demotionEventType to set.

Returns:

This builder for chaining.

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;

Specified by:

getContentFreshnessCutoffDays in interface ServingConfig.MediaConfigOrBuilder

Returns:

The contentFreshnessCutoffDays.

setContentFreshnessCutoffDays

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;

Parameters:

value - The contentFreshnessCutoffDays to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setUnknownFields

public final ServingConfig.MediaConfig.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ServingConfig.MediaConfig.Builder>

mergeUnknownFields

public final ServingConfig.MediaConfig.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ServingConfig.MediaConfig.Builder>