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

Class ListAlbumsRequest

  • All Implemented Interfaces:
    ListAlbumsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable
    public final class ListAlbumsRequest
extends com.google.protobuf.GeneratedMessageV3
implements ListAlbumsRequestOrBuilder
     Request to retrieve the list of albums created by the user.
 This will return the list of albums corresponding to the user's 'Albums' tab
 in the Google Photos app.
    Protobuf type google.photos.library.v1.ListAlbumsRequest
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ListAlbumsRequest.Builder
      Request to retrieve the list of albums created by the user.

      • 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 EXCLUDE_NON_APP_CREATED_DATA_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 Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      static ListAlbumsRequest getDefaultInstance()  
      ListAlbumsRequest getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      boolean getExcludeNonAppCreatedData()
      If set, the results exclude media items that were not created by this app.
      int getPageSize()
      Maximum number of albums to return in the response.
      java.lang.String getPageToken()
      A continuation token to get the next page of the results.
      com.google.protobuf.ByteString getPageTokenBytes()
      A continuation token to get the next page of the results.
      com.google.protobuf.Parser<ListAlbumsRequest> getParserForType()  
      int getSerializedSize()  
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      int hashCode()  
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static ListAlbumsRequest.Builder newBuilder()  
      static ListAlbumsRequest.Builder newBuilder​(ListAlbumsRequest prototype)  
      ListAlbumsRequest.Builder newBuilderForType()  
      protected ListAlbumsRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static ListAlbumsRequest parseDelimitedFrom​(java.io.InputStream input)  
      static ListAlbumsRequest parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ListAlbumsRequest parseFrom​(byte[] data)  
      static ListAlbumsRequest parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ListAlbumsRequest parseFrom​(com.google.protobuf.ByteString data)  
      static ListAlbumsRequest parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ListAlbumsRequest parseFrom​(com.google.protobuf.CodedInputStream input)  
      static ListAlbumsRequest parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ListAlbumsRequest parseFrom​(java.io.InputStream input)  
      static ListAlbumsRequest parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ListAlbumsRequest parseFrom​(java.nio.ByteBuffer data)  
      static ListAlbumsRequest parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<ListAlbumsRequest> parser()  
      ListAlbumsRequest.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

      • PAGE_TOKEN_FIELD_NUMBER

        public static final int PAGE_TOKEN_FIELD_NUMBER
        See Also:
        Constant Field Values

      • EXCLUDE_NON_APP_CREATED_DATA_FIELD_NUMBER

        public static final int EXCLUDE_NON_APP_CREATED_DATA_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

      • getPageSize

        public int getPageSize()
         Maximum number of albums to return in the response. Fewer albums might be
 returned than the specified number. The default `pageSize` is 20, the
 maximum is 50.
        int32 page_size = 1;
        Specified by:
        getPageSize in interface ListAlbumsRequestOrBuilder
        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 `listAlbums` request.
        string page_token = 2;
        Specified by:
        getPageToken in interface ListAlbumsRequestOrBuilder
        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 `listAlbums` request.
        string page_token = 2;
        Specified by:
        getPageTokenBytes in interface ListAlbumsRequestOrBuilder
        Returns:
        The bytes for pageToken.

      • getExcludeNonAppCreatedData

        public boolean getExcludeNonAppCreatedData()
         If set, the results exclude media items that were not created by this app.
 Defaults to false (all albums are returned). This field is ignored if the
 photoslibrary.readonly.appcreateddata scope is used.
        bool exclude_non_app_created_data = 3;
        Specified by:
        getExcludeNonAppCreatedData in interface ListAlbumsRequestOrBuilder
        Returns:
        The excludeNonAppCreatedData.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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