Package com.google.cloud.discoveryengine.v1

Class MediaInfo

  • All Implemented Interfaces:
    MediaInfoOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class MediaInfo
extends com.google.protobuf.GeneratedMessageV3
implements MediaInfoOrBuilder
     Media-specific user event information.
    Protobuf type google.cloud.discoveryengine.v1.MediaInfo
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  MediaInfo.Builder
      Media-specific user event information.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int MEDIA_PROGRESS_DURATION_FIELD_NUMBER  
      static int MEDIA_PROGRESS_PERCENTAGE_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      static MediaInfo getDefaultInstance()  
      MediaInfo getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Duration getMediaProgressDuration()
      The media progress time in seconds, if applicable.
      com.google.protobuf.DurationOrBuilder getMediaProgressDurationOrBuilder()
      The media progress time in seconds, if applicable.
      float getMediaProgressPercentage()
      Media progress should be computed using only the [media_progress_duration][google.cloud.discoveryengine.v1.MediaInfo.media_progress_duration] relative to the media total length.
      com.google.protobuf.Parser<MediaInfo> getParserForType()  
      int getSerializedSize()  
      int hashCode()  
      boolean hasMediaProgressDuration()
      The media progress time in seconds, if applicable.
      boolean hasMediaProgressPercentage()
      Media progress should be computed using only the [media_progress_duration][google.cloud.discoveryengine.v1.MediaInfo.media_progress_duration] relative to the media total length.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static MediaInfo.Builder newBuilder()  
      static MediaInfo.Builder newBuilder​(MediaInfo prototype)  
      MediaInfo.Builder newBuilderForType()  
      protected MediaInfo.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static MediaInfo parseDelimitedFrom​(InputStream input)  
      static MediaInfo parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static MediaInfo parseFrom​(byte[] data)  
      static MediaInfo parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static MediaInfo parseFrom​(com.google.protobuf.ByteString data)  
      static MediaInfo parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static MediaInfo parseFrom​(com.google.protobuf.CodedInputStream input)  
      static MediaInfo parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static MediaInfo parseFrom​(InputStream input)  
      static MediaInfo parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static MediaInfo parseFrom​(ByteBuffer data)  
      static MediaInfo parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<MediaInfo> parser()  
      MediaInfo.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

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

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

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

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

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

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Field Detail

      • MEDIA_PROGRESS_DURATION_FIELD_NUMBER

        public static final int MEDIA_PROGRESS_DURATION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MEDIA_PROGRESS_PERCENTAGE_FIELD_NUMBER

        public static final int MEDIA_PROGRESS_PERCENTAGE_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • 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

      • 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][google.protobuf.Duration.seconds]
 should be set to 90.
        .google.protobuf.Duration media_progress_duration = 1;
        Specified by:
        hasMediaProgressDuration in interface MediaInfoOrBuilder
        Returns:
        Whether the mediaProgressDuration field is set.

      • getMediaProgressDuration

        public com.google.protobuf.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][google.protobuf.Duration.seconds]
 should be set to 90.
        .google.protobuf.Duration media_progress_duration = 1;
        Specified by:
        getMediaProgressDuration in interface MediaInfoOrBuilder
        Returns:
        The mediaProgressDuration.

      • getMediaProgressDurationOrBuilder

        public com.google.protobuf.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][google.protobuf.Duration.seconds]
 should be set to 90.
        .google.protobuf.Duration media_progress_duration = 1;
        Specified by:
        getMediaProgressDurationOrBuilder in interface MediaInfoOrBuilder

      • hasMediaProgressPercentage

        public boolean hasMediaProgressPercentage()
         Media progress should be computed using only the
 [media_progress_duration][google.cloud.discoveryengine.v1.MediaInfo.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;
        Specified by:
        hasMediaProgressPercentage in interface MediaInfoOrBuilder
        Returns:
        Whether the mediaProgressPercentage field is set.

      • getMediaProgressPercentage

        public float getMediaProgressPercentage()
         Media progress should be computed using only the
 [media_progress_duration][google.cloud.discoveryengine.v1.MediaInfo.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;
        Specified by:
        getMediaProgressPercentage in interface MediaInfoOrBuilder
        Returns:
        The mediaProgressPercentage.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static MediaInfo parseFrom​(ByteBuffer data)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MediaInfo parseFrom​(ByteBuffer data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MediaInfo parseFrom​(com.google.protobuf.ByteString data)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MediaInfo parseFrom​(com.google.protobuf.ByteString data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MediaInfo parseFrom​(byte[] data)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MediaInfo parseFrom​(byte[] data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static MediaInfo parseFrom​(com.google.protobuf.CodedInputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException
        Throws:
        IOException

      • newBuilderForType

        public MediaInfo.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public MediaInfo.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected MediaInfo.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static MediaInfo getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<MediaInfo> parser()

      • getParserForType

        public com.google.protobuf.Parser<MediaInfo> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public MediaInfo getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder