com.google.photos.library.v1.proto.AlbumOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-photos-library-client Show documentation
Google Photos Library API Client Library for Java
There is a newer version: 1.7.3
Show newest version
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/photos/library/v1/photos_library.proto

package com.google.photos.library.v1.proto;

public interface AlbumOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.photos.library.v1.Album)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * [Ouput only] Identifier for the album. This is a persistent identifier that
   * can be used between sessions to identify this album.
   * 
   *
   * string id = 1;
   */
  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;
   */
  com.google.protobuf.ByteString getIdBytes();

  /**
   *
   *
   *    * 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;
   */
  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;
   */
  com.google.protobuf.ByteString getTitleBytes();

  /**
   *
   *
   *    * [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;
   */
  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;
   */
  com.google.protobuf.ByteString getProductUrlBytes();

  /**
   *
   *
   *    * [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;
   */
  boolean getIsWriteable();

  /**
   *
   *
   *    * [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.library.v1.ShareInfo share_info = 5;
   */
  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.library.v1.ShareInfo share_info = 5;
   */
  com.google.photos.library.v1.proto.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.library.v1.ShareInfo share_info = 5;
   */
  com.google.photos.library.v1.proto.ShareInfoOrBuilder getShareInfoOrBuilder();

  /**
   *
   *
   *    * [Output only] The number of media items in the album.
   * 
   *
   * int64 media_items_count = 6;
   */
  long getMediaItemsCount();

  /**
   *
   *
   *    * [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. 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;
   */
  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. 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;
   */
  com.google.protobuf.ByteString getCoverPhotoBaseUrlBytes();

  /**
   *
   *
   *    * [Output only] Identifier for the media item associated with the cover
   * photo.
   * 
   *
   * string cover_photo_media_item_id = 8;
   */
  java.lang.String getCoverPhotoMediaItemId();
  /**
   *
   *
   *    * [Output only] Identifier for the media item associated with the cover
   * photo.
   * 
   *
   * string cover_photo_media_item_id = 8;
   */
  com.google.protobuf.ByteString getCoverPhotoMediaItemIdBytes();
}