Class MediaInfo (0.35.0)

public final class MediaInfo extends GeneratedMessageV3 implements MediaInfoOrBuilder

Media-specific user event information.

Protobuf type google.cloud.discoveryengine.v1alpha.MediaInfo

Implements

MediaInfoOrBuilder

Static Fields

MEDIA_PROGRESS_DURATION_FIELD_NUMBER

public static final int MEDIA_PROGRESS_DURATION_FIELD_NUMBER
Field Value
TypeDescription
int

MEDIA_PROGRESS_PERCENTAGE_FIELD_NUMBER

public static final int MEDIA_PROGRESS_PERCENTAGE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static MediaInfo getDefaultInstance()
Returns
TypeDescription
MediaInfo

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static MediaInfo.Builder newBuilder()
Returns
TypeDescription
MediaInfo.Builder

newBuilder(MediaInfo prototype)

public static MediaInfo.Builder newBuilder(MediaInfo prototype)
Parameter
NameDescription
prototypeMediaInfo
Returns
TypeDescription
MediaInfo.Builder

parseDelimitedFrom(InputStream input)

public static MediaInfo parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
MediaInfo
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MediaInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MediaInfo
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static MediaInfo parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
MediaInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static MediaInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MediaInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static MediaInfo parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
MediaInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static MediaInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MediaInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static MediaInfo parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
MediaInfo
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static MediaInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MediaInfo
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static MediaInfo parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
MediaInfo
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static MediaInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MediaInfo
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static MediaInfo parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
MediaInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static MediaInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
MediaInfo
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<MediaInfo> parser()
Returns
TypeDescription
Parser<MediaInfo>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public MediaInfo getDefaultInstanceForType()
Returns
TypeDescription
MediaInfo

getMediaProgressDuration()

public Duration getMediaProgressDuration()

The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90.

.google.protobuf.Duration media_progress_duration = 1;

Returns
TypeDescription
Duration

The mediaProgressDuration.

getMediaProgressDurationOrBuilder()

public DurationOrBuilder getMediaProgressDurationOrBuilder()

The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90.

.google.protobuf.Duration media_progress_duration = 1;

Returns
TypeDescription
DurationOrBuilder

getMediaProgressPercentage()

public float getMediaProgressPercentage()

Media progress should be computed using only the media_progress_duration relative to the media total length.

This value must be between [0, 1.0] inclusive.

If this is not a playback or the progress cannot be computed (e.g. ongoing livestream), this field should be unset.

optional float media_progress_percentage = 2;

Returns
TypeDescription
float

The mediaProgressPercentage.

getParserForType()

public Parser<MediaInfo> getParserForType()
Returns
TypeDescription
Parser<MediaInfo>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasMediaProgressDuration()

public boolean hasMediaProgressDuration()

The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90.

.google.protobuf.Duration media_progress_duration = 1;

Returns
TypeDescription
boolean

Whether the mediaProgressDuration field is set.

hasMediaProgressPercentage()

public boolean hasMediaProgressPercentage()

Media progress should be computed using only the media_progress_duration relative to the media total length.

This value must be between [0, 1.0] inclusive.

If this is not a playback or the progress cannot be computed (e.g. ongoing livestream), this field should be unset.

optional float media_progress_percentage = 2;

Returns
TypeDescription
boolean

Whether the mediaProgressPercentage field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public MediaInfo.Builder newBuilderForType()
Returns
TypeDescription
MediaInfo.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected MediaInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
MediaInfo.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public MediaInfo.Builder toBuilder()
Returns
TypeDescription
MediaInfo.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException