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

Go to download
// 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 SearchMediaItemsRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.photos.library.v1.SearchMediaItemsRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Identifier of an album. If populated, lists all media items in
   * specified album. Can't set in conjunction with any filters.
   * 
   *
   * string album_id = 1;
   *
   * @return The albumId.
   */
  java.lang.String getAlbumId();
  /**
   *
   *
   *    * Identifier of an album. If populated, lists all media items in
   * specified album. Can't set in conjunction with any filters.
   * 
   *
   * string album_id = 1;
   *
   * @return The bytes for albumId.
   */
  com.google.protobuf.ByteString getAlbumIdBytes();

  /**
   *
   *
   *    * Maximum number of media items to return in the response. Fewer media items
   * might be returned than the specified number. The default `pageSize` is 25,
   * the maximum is 100.
   * 
   *
   * int32 page_size = 2;
   *
   * @return The pageSize.
   */
  int getPageSize();

  /**
   *
   *
   *    * A continuation token to get the next page of the results. Adding this to
   * the request returns the rows after the `pageToken`. The `pageToken` should
   * be the value returned in the `nextPageToken` parameter in the response to
   * the `searchMediaItems` request.
   * 
   *
   * string page_token = 3;
   *
   * @return The pageToken.
   */
  java.lang.String getPageToken();
  /**
   *
   *
   *    * A continuation token to get the next page of the results. Adding this to
   * the request returns the rows after the `pageToken`. The `pageToken` should
   * be the value returned in the `nextPageToken` parameter in the response to
   * the `searchMediaItems` request.
   * 
   *
   * string page_token = 3;
   *
   * @return The bytes for pageToken.
   */
  com.google.protobuf.ByteString getPageTokenBytes();

  /**
   *
   *
   *    * Filters to apply to the request. Can't be set in conjunction with an
   * `albumId`.
   * 
   *
   * .google.photos.library.v1.Filters filters = 4;
   *
   * @return Whether the filters field is set.
   */
  boolean hasFilters();
  /**
   *
   *
   *    * Filters to apply to the request. Can't be set in conjunction with an
   * `albumId`.
   * 
   *
   * .google.photos.library.v1.Filters filters = 4;
   *
   * @return The filters.
   */
  com.google.photos.library.v1.proto.Filters getFilters();
  /**
   *
   *
   *    * Filters to apply to the request. Can't be set in conjunction with an
   * `albumId`.
   * 
   *
   * .google.photos.library.v1.Filters filters = 4;
   */
  com.google.photos.library.v1.proto.FiltersOrBuilder getFiltersOrBuilder();

  /**
   *
   *
   *    * An optional field to specify the sort order of the search results. The
   * `orderBy` field only works when a
   * [dateFilter][google.photos.library.v1.DateFilter] is used. When this
   * field is not specified, results are displayed newest first, oldest last by
   * their [creationTime][google.photos.types.MediaMetadata.creation_time].
   * Providing `MediaMetadata.creation_time` displays search results in
   * the opposite order, oldest first then newest last.
   * To display results newest first then oldest last, include the `desc`
   * argument as follows: `MediaMetadata.creation_time desc`.
   * The only additional filters that can be used with this parameter are
   * [includeArchivedMedia][google.photos.library.v1.Filters.include_archived_media]
   * and
   * [excludeNonAppCreatedData][google.photos.library.v1.Filters.exclude_non_app_created_data].
   * No other filters are supported.
   * 
   *
   * string order_by = 5;
   *
   * @return The orderBy.
   */
  java.lang.String getOrderBy();
  /**
   *
   *
   *    * An optional field to specify the sort order of the search results. The
   * `orderBy` field only works when a
   * [dateFilter][google.photos.library.v1.DateFilter] is used. When this
   * field is not specified, results are displayed newest first, oldest last by
   * their [creationTime][google.photos.types.MediaMetadata.creation_time].
   * Providing `MediaMetadata.creation_time` displays search results in
   * the opposite order, oldest first then newest last.
   * To display results newest first then oldest last, include the `desc`
   * argument as follows: `MediaMetadata.creation_time desc`.
   * The only additional filters that can be used with this parameter are
   * [includeArchivedMedia][google.photos.library.v1.Filters.include_archived_media]
   * and
   * [excludeNonAppCreatedData][google.photos.library.v1.Filters.exclude_non_app_created_data].
   * No other filters are supported.
   * 
   *
   * string order_by = 5;
   *
   * @return The bytes for orderBy.
   */
  com.google.protobuf.ByteString getOrderByBytes();
}