Package com.google.photos.library.v1.proto

Class SearchMediaItemsRequest

  • All Implemented Interfaces:
    SearchMediaItemsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class SearchMediaItemsRequest
extends com.google.protobuf.GeneratedMessageV3
implements SearchMediaItemsRequestOrBuilder
     Request to search for media items in a user's library.
 If the album id is specified, this call will return the list of media items
 in the album. If neither filters nor album id are
 specified, this call will return all media items in a user's Google Photos
 library.
 If filters are specified, this call will return all media items in
 the user's library that fulfill the filter criteria.
 Filters and album id must not both be set, as this will result in an
 invalid request.
    Protobuf type google.photos.library.v1.SearchMediaItemsRequest
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  SearchMediaItemsRequest.Builder
      Request to search for media items in a user's library.

      • 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

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ALBUM_ID_FIELD_NUMBER  
      static int FILTERS_FIELD_NUMBER  
      static int PAGE_SIZE_FIELD_NUMBER  
      static int PAGE_TOKEN_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 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

      • getAlbumId

        public 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;
        Specified by:
        getAlbumId in interface SearchMediaItemsRequestOrBuilder
        Returns:
        The albumId.

      • getAlbumIdBytes

        public com.google.protobuf.ByteString getAlbumIdBytes()
         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;
        Specified by:
        getAlbumIdBytes in interface SearchMediaItemsRequestOrBuilder
        Returns:
        The bytes for albumId.

      • getPageSize

        public int getPageSize()
         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;
        Specified by:
        getPageSize in interface SearchMediaItemsRequestOrBuilder
        Returns:
        The pageSize.

      • getPageToken

        public 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;
        Specified by:
        getPageToken in interface SearchMediaItemsRequestOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         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;
        Specified by:
        getPageTokenBytes in interface SearchMediaItemsRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • hasFilters

        public boolean hasFilters()
         Filters to apply to the request. Can't be set in conjunction with an
 `albumId`.
        .google.photos.library.v1.Filters filters = 4;
        Specified by:
        hasFilters in interface SearchMediaItemsRequestOrBuilder
        Returns:
        Whether the filters field is set.

      • getFilters

        public Filters getFilters()
         Filters to apply to the request. Can't be set in conjunction with an
 `albumId`.
        .google.photos.library.v1.Filters filters = 4;
        Specified by:
        getFilters in interface SearchMediaItemsRequestOrBuilder
        Returns:
        The filters.

      • 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 SearchMediaItemsRequest parseFrom​(java.nio.ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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