Package com.google.photos.types.proto

Class Album

  • All Implemented Interfaces:
    AlbumOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class Album
extends com.google.protobuf.GeneratedMessageV3
implements AlbumOrBuilder
     Representation of an album in Google Photos.
 Albums are containers for media items. If an album has been shared by the
 application, it contains an extra `shareInfo` property.
    Protobuf type google.photos.types.Album
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Album.Builder
      Representation of an album in Google Photos.

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

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.String getCoverPhotoBaseUrl()
      [Output only] A URL to the cover photo's bytes.
      com.google.protobuf.ByteString getCoverPhotoBaseUrlBytes()
      [Output only] A URL to the cover photo's bytes.
      java.lang.String getCoverPhotoMediaItemId()
      Identifier for the media item associated with the cover photo.
      com.google.protobuf.ByteString getCoverPhotoMediaItemIdBytes()
      Identifier for the media item associated with the cover photo.
      static Album getDefaultInstance()  
      Album getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      java.lang.String getId()
      Identifier for the album.
      com.google.protobuf.ByteString getIdBytes()
      Identifier for the album.
      boolean getIsWriteable()
      [Output only] True if you can create media items in this album.
      long getMediaItemsCount()
      [Output only] The number of media items in the album.
      com.google.protobuf.Parser<Album> getParserForType()  
      java.lang.String getProductUrl()
      [Output only] Google Photos URL for the album.
      com.google.protobuf.ByteString getProductUrlBytes()
      [Output only] Google Photos URL for the album.
      int getSerializedSize()  
      ShareInfo getShareInfo()
      [Output only] Information related to shared albums.
      ShareInfoOrBuilder getShareInfoOrBuilder()
      [Output only] Information related to shared albums.
      java.lang.String getTitle()
      Name of the album displayed to the user in their Google Photos account.
      com.google.protobuf.ByteString getTitleBytes()
      Name of the album displayed to the user in their Google Photos account.
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      int hashCode()  
      boolean hasShareInfo()
      [Output only] Information related to shared albums.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static Album.Builder newBuilder()  
      static Album.Builder newBuilder​(Album prototype)  
      Album.Builder newBuilderForType()  
      protected Album.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static Album parseDelimitedFrom​(java.io.InputStream input)  
      static Album parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Album parseFrom​(byte[] data)  
      static Album parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Album parseFrom​(com.google.protobuf.ByteString data)  
      static Album parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Album parseFrom​(com.google.protobuf.CodedInputStream input)  
      static Album parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Album parseFrom​(java.io.InputStream input)  
      static Album parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Album parseFrom​(java.nio.ByteBuffer data)  
      static Album parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Album> parser()  
      Album.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, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, 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 class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

      • 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, hasField, hasOneof

    • Field Detail

      • PRODUCT_URL_FIELD_NUMBER

        public static final int PRODUCT_URL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • IS_WRITEABLE_FIELD_NUMBER

        public static final int IS_WRITEABLE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SHARE_INFO_FIELD_NUMBER

        public static final int SHARE_INFO_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MEDIA_ITEMS_COUNT_FIELD_NUMBER

        public static final int MEDIA_ITEMS_COUNT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • COVER_PHOTO_BASE_URL_FIELD_NUMBER

        public static final int COVER_PHOTO_BASE_URL_FIELD_NUMBER
        See Also:
        Constant Field Values

      • COVER_PHOTO_MEDIA_ITEM_ID_FIELD_NUMBER

        public static final int COVER_PHOTO_MEDIA_ITEM_ID_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

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

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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

      • getId

        public java.lang.String getId()
         Identifier for the album. This is a persistent identifier that
 can be used between sessions to identify this album.
        string id = 1;
        Specified by:
        getId in interface AlbumOrBuilder
        Returns:
        The id.

      • getIdBytes

        public com.google.protobuf.ByteString getIdBytes()
         Identifier for the album. This is a persistent identifier that
 can be used between sessions to identify this album.
        string id = 1;
        Specified by:
        getIdBytes in interface AlbumOrBuilder
        Returns:
        The bytes for id.

      • getTitle

        public java.lang.String getTitle()
         Name of the album displayed to the user in their Google Photos account.
 This string shouldn't be more than 500 characters.
        string title = 2;
        Specified by:
        getTitle in interface AlbumOrBuilder
        Returns:
        The title.

      • getTitleBytes

        public com.google.protobuf.ByteString getTitleBytes()
         Name of the album displayed to the user in their Google Photos account.
 This string shouldn't be more than 500 characters.
        string title = 2;
        Specified by:
        getTitleBytes in interface AlbumOrBuilder
        Returns:
        The bytes for title.

      • getProductUrl

        public java.lang.String getProductUrl()
         [Output only] Google Photos URL for the album. The user needs to be signed
 in to their Google Photos account to access this link.
        string product_url = 3;
        Specified by:
        getProductUrl in interface AlbumOrBuilder
        Returns:
        The productUrl.

      • getProductUrlBytes

        public com.google.protobuf.ByteString getProductUrlBytes()
         [Output only] Google Photos URL for the album. The user needs to be signed
 in to their Google Photos account to access this link.
        string product_url = 3;
        Specified by:
        getProductUrlBytes in interface AlbumOrBuilder
        Returns:
        The bytes for productUrl.

      • getIsWriteable

        public boolean getIsWriteable()
         [Output only] True if you can create media items in this album.
 This field is based on the scopes granted and permissions of the album. If
 the scopes are changed or permissions of the album are changed, this field
 is updated.
        bool is_writeable = 4;
        Specified by:
        getIsWriteable in interface AlbumOrBuilder
        Returns:
        The isWriteable.

      • hasShareInfo

        public boolean hasShareInfo()
         [Output only] Information related to shared albums.
 This field is only populated if the album is a shared album, the
 developer created the album and the user has granted the
 `photoslibrary.sharing` scope.
        .google.photos.types.ShareInfo share_info = 5;
        Specified by:
        hasShareInfo in interface AlbumOrBuilder
        Returns:
        Whether the shareInfo field is set.

      • getShareInfo

        public ShareInfo getShareInfo()
         [Output only] Information related to shared albums.
 This field is only populated if the album is a shared album, the
 developer created the album and the user has granted the
 `photoslibrary.sharing` scope.
        .google.photos.types.ShareInfo share_info = 5;
        Specified by:
        getShareInfo in interface AlbumOrBuilder
        Returns:
        The shareInfo.

      • getShareInfoOrBuilder

        public ShareInfoOrBuilder getShareInfoOrBuilder()
         [Output only] Information related to shared albums.
 This field is only populated if the album is a shared album, the
 developer created the album and the user has granted the
 `photoslibrary.sharing` scope.
        .google.photos.types.ShareInfo share_info = 5;
        Specified by:
        getShareInfoOrBuilder in interface AlbumOrBuilder

      • getMediaItemsCount

        public long getMediaItemsCount()
         [Output only] The number of media items in the album.
        int64 media_items_count = 6;
        Specified by:
        getMediaItemsCount in interface AlbumOrBuilder
        Returns:
        The mediaItemsCount.

      • getCoverPhotoBaseUrl

        public java.lang.String getCoverPhotoBaseUrl()
         [Output only] A URL to the cover photo's bytes. This shouldn't be used as
 is. Parameters should be appended to this URL before use. See the
 [developer
 documentation](https://developers.google.com/photos/library/guides/access-media-items#base-urls)
 for a complete list of supported parameters. For example,
 `'=w2048-h1024'` sets the dimensions of the cover photo to have a width of
 2048 px and height of 1024 px.
        string cover_photo_base_url = 7;
        Specified by:
        getCoverPhotoBaseUrl in interface AlbumOrBuilder
        Returns:
        The coverPhotoBaseUrl.

      • getCoverPhotoBaseUrlBytes

        public com.google.protobuf.ByteString getCoverPhotoBaseUrlBytes()
         [Output only] A URL to the cover photo's bytes. This shouldn't be used as
 is. Parameters should be appended to this URL before use. See the
 [developer
 documentation](https://developers.google.com/photos/library/guides/access-media-items#base-urls)
 for a complete list of supported parameters. For example,
 `'=w2048-h1024'` sets the dimensions of the cover photo to have a width of
 2048 px and height of 1024 px.
        string cover_photo_base_url = 7;
        Specified by:
        getCoverPhotoBaseUrlBytes in interface AlbumOrBuilder
        Returns:
        The bytes for coverPhotoBaseUrl.

      • getCoverPhotoMediaItemId

        public java.lang.String getCoverPhotoMediaItemId()
         Identifier for the media item associated with the cover photo.
        string cover_photo_media_item_id = 8;
        Specified by:
        getCoverPhotoMediaItemId in interface AlbumOrBuilder
        Returns:
        The coverPhotoMediaItemId.

      • getCoverPhotoMediaItemIdBytes

        public com.google.protobuf.ByteString getCoverPhotoMediaItemIdBytes()
         Identifier for the media item associated with the cover photo.
        string cover_photo_media_item_id = 8;
        Specified by:
        getCoverPhotoMediaItemIdBytes in interface AlbumOrBuilder
        Returns:
        The bytes for coverPhotoMediaItemId.

      • 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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.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​(java.lang.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 Album parseFrom​(java.nio.ByteBuffer data)
                       throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static Album parseFrom​(java.io.InputStream input)
                       throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Album parseFrom​(java.io.InputStream input,
                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                       throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static Album parseDelimitedFrom​(java.io.InputStream input)
                                throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static Album parseDelimitedFrom​(java.io.InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static Album parseFrom​(com.google.protobuf.CodedInputStream input)
                       throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Album getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<Album> 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 Album getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder