Package com.google.photos.types.proto
Class Album.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderType>
-
- com.google.protobuf.GeneratedMessageV3.Builder<Album.Builder>
-
- com.google.photos.types.proto.Album.Builder
-
- All Implemented Interfaces:
AlbumOrBuilder
,com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,java.lang.Cloneable
- Enclosing class:
- Album
public static final class Album.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Album.Builder> 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 typegoogle.photos.types.Album
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Album.Builder
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
Album
build()
Album
buildPartial()
Album.Builder
clear()
Album.Builder
clearCoverPhotoBaseUrl()
[Output only] A URL to the cover photo's bytes.Album.Builder
clearCoverPhotoMediaItemId()
[Output only] Identifier for the media item associated with the cover photo.Album.Builder
clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Album.Builder
clearId()
[Ouput only] Identifier for the album.Album.Builder
clearIsWriteable()
[Output only] True if you can create media items in this album.Album.Builder
clearMediaItemsCount()
[Output only] The number of media items in the album.Album.Builder
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Album.Builder
clearProductUrl()
[Output only] Google Photos URL for the album.Album.Builder
clearShareInfo()
[Output only] Information related to shared albums.Album.Builder
clearTitle()
Name of the album displayed to the user in their Google Photos account.Album.Builder
clone()
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()
[Output only] Identifier for the media item associated with the cover photo.com.google.protobuf.ByteString
getCoverPhotoMediaItemIdBytes()
[Output only] Identifier for the media item associated with the cover photo.Album
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
com.google.protobuf.Descriptors.Descriptor
getDescriptorForType()
java.lang.String
getId()
[Ouput only] Identifier for the album.com.google.protobuf.ByteString
getIdBytes()
[Ouput only] 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.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.ShareInfo
getShareInfo()
[Output only] Information related to shared albums.ShareInfo.Builder
getShareInfoBuilder()
[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.boolean
hasShareInfo()
[Output only] Information related to shared albums.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
Album.Builder
mergeFrom(Album other)
Album.Builder
mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Album.Builder
mergeFrom(com.google.protobuf.Message other)
Album.Builder
mergeShareInfo(ShareInfo value)
[Output only] Information related to shared albums.Album.Builder
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Album.Builder
setCoverPhotoBaseUrl(java.lang.String value)
[Output only] A URL to the cover photo's bytes.Album.Builder
setCoverPhotoBaseUrlBytes(com.google.protobuf.ByteString value)
[Output only] A URL to the cover photo's bytes.Album.Builder
setCoverPhotoMediaItemId(java.lang.String value)
[Output only] Identifier for the media item associated with the cover photo.Album.Builder
setCoverPhotoMediaItemIdBytes(com.google.protobuf.ByteString value)
[Output only] Identifier for the media item associated with the cover photo.Album.Builder
setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
Album.Builder
setId(java.lang.String value)
[Ouput only] Identifier for the album.Album.Builder
setIdBytes(com.google.protobuf.ByteString value)
[Ouput only] Identifier for the album.Album.Builder
setIsWriteable(boolean value)
[Output only] True if you can create media items in this album.Album.Builder
setMediaItemsCount(long value)
[Output only] The number of media items in the album.Album.Builder
setProductUrl(java.lang.String value)
[Output only] Google Photos URL for the album.Album.Builder
setProductUrlBytes(com.google.protobuf.ByteString value)
[Output only] Google Photos URL for the album.Album.Builder
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
Album.Builder
setShareInfo(ShareInfo value)
[Output only] Information related to shared albums.Album.Builder
setShareInfo(ShareInfo.Builder builderForValue)
[Output only] Information related to shared albums.Album.Builder
setTitle(java.lang.String value)
Name of the album displayed to the user in their Google Photos account.Album.Builder
setTitleBytes(com.google.protobuf.ByteString value)
Name of the album displayed to the user in their Google Photos account.Album.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, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3.Builder<Album.Builder>
-
clear
public Album.Builder clear()
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessageV3.Builder<Album.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessageV3.Builder<Album.Builder>
-
getDefaultInstanceForType
public Album getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
public Album build()
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public Album buildPartial()
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
clone
public Album.Builder clone()
- Specified by:
clone
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clone
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clone
in classcom.google.protobuf.GeneratedMessageV3.Builder<Album.Builder>
-
setField
public Album.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
- Specified by:
setField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Album.Builder>
-
clearField
public Album.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Album.Builder>
-
clearOneof
public Album.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneof
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearOneof
in classcom.google.protobuf.GeneratedMessageV3.Builder<Album.Builder>
-
setRepeatedField
public Album.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
- Specified by:
setRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Album.Builder>
-
addRepeatedField
public Album.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
- Specified by:
addRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
addRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<Album.Builder>
-
mergeFrom
public Album.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<Album.Builder>
-
mergeFrom
public Album.Builder mergeFrom(Album other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3.Builder<Album.Builder>
-
mergeFrom
public Album.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<Album.Builder>
- Throws:
java.io.IOException
-
getId
public java.lang.String getId()
[Ouput only] 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 interfaceAlbumOrBuilder
-
getIdBytes
public com.google.protobuf.ByteString getIdBytes()
[Ouput only] 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 interfaceAlbumOrBuilder
-
setId
public Album.Builder setId(java.lang.String value)
[Ouput only] Identifier for the album. This is a persistent identifier that can be used between sessions to identify this album.
string id = 1;
-
clearId
public Album.Builder clearId()
[Ouput only] Identifier for the album. This is a persistent identifier that can be used between sessions to identify this album.
string id = 1;
-
setIdBytes
public Album.Builder setIdBytes(com.google.protobuf.ByteString value)
[Ouput only] Identifier for the album. This is a persistent identifier that can be used between sessions to identify this album.
string id = 1;
-
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 interfaceAlbumOrBuilder
-
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 interfaceAlbumOrBuilder
-
setTitle
public Album.Builder setTitle(java.lang.String value)
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;
-
clearTitle
public Album.Builder clearTitle()
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;
-
setTitleBytes
public Album.Builder setTitleBytes(com.google.protobuf.ByteString value)
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;
-
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 interfaceAlbumOrBuilder
-
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 interfaceAlbumOrBuilder
-
setProductUrl
public Album.Builder setProductUrl(java.lang.String value)
[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;
-
clearProductUrl
public Album.Builder clearProductUrl()
[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;
-
setProductUrlBytes
public Album.Builder setProductUrlBytes(com.google.protobuf.ByteString value)
[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;
-
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 interfaceAlbumOrBuilder
-
setIsWriteable
public Album.Builder setIsWriteable(boolean value)
[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;
-
clearIsWriteable
public Album.Builder clearIsWriteable()
[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;
-
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 interfaceAlbumOrBuilder
-
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 interfaceAlbumOrBuilder
-
setShareInfo
public Album.Builder setShareInfo(ShareInfo value)
[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;
-
setShareInfo
public Album.Builder setShareInfo(ShareInfo.Builder builderForValue)
[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;
-
mergeShareInfo
public Album.Builder mergeShareInfo(ShareInfo value)
[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;
-
clearShareInfo
public Album.Builder clearShareInfo()
[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;
-
getShareInfoBuilder
public ShareInfo.Builder getShareInfoBuilder()
[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;
-
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 interfaceAlbumOrBuilder
-
getMediaItemsCount
public long getMediaItemsCount()
[Output only] The number of media items in the album.
int64 media_items_count = 6;
- Specified by:
getMediaItemsCount
in interfaceAlbumOrBuilder
-
setMediaItemsCount
public Album.Builder setMediaItemsCount(long value)
[Output only] The number of media items in the album.
int64 media_items_count = 6;
-
clearMediaItemsCount
public Album.Builder clearMediaItemsCount()
[Output only] The number of media items in the album.
int64 media_items_count = 6;
-
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 interfaceAlbumOrBuilder
-
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 interfaceAlbumOrBuilder
-
setCoverPhotoBaseUrl
public Album.Builder setCoverPhotoBaseUrl(java.lang.String value)
[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;
-
clearCoverPhotoBaseUrl
public Album.Builder clearCoverPhotoBaseUrl()
[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;
-
setCoverPhotoBaseUrlBytes
public Album.Builder setCoverPhotoBaseUrlBytes(com.google.protobuf.ByteString value)
[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;
-
getCoverPhotoMediaItemId
public java.lang.String getCoverPhotoMediaItemId()
[Output only] Identifier for the media item associated with the cover photo.
string cover_photo_media_item_id = 8;
- Specified by:
getCoverPhotoMediaItemId
in interfaceAlbumOrBuilder
-
getCoverPhotoMediaItemIdBytes
public com.google.protobuf.ByteString getCoverPhotoMediaItemIdBytes()
[Output only] Identifier for the media item associated with the cover photo.
string cover_photo_media_item_id = 8;
- Specified by:
getCoverPhotoMediaItemIdBytes
in interfaceAlbumOrBuilder
-
setCoverPhotoMediaItemId
public Album.Builder setCoverPhotoMediaItemId(java.lang.String value)
[Output only] Identifier for the media item associated with the cover photo.
string cover_photo_media_item_id = 8;
-
clearCoverPhotoMediaItemId
public Album.Builder clearCoverPhotoMediaItemId()
[Output only] Identifier for the media item associated with the cover photo.
string cover_photo_media_item_id = 8;
-
setCoverPhotoMediaItemIdBytes
public Album.Builder setCoverPhotoMediaItemIdBytes(com.google.protobuf.ByteString value)
[Output only] Identifier for the media item associated with the cover photo.
string cover_photo_media_item_id = 8;
-
setUnknownFields
public final Album.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<Album.Builder>
-
mergeUnknownFields
public final Album.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<Album.Builder>
-
-