Class ListAlbumsRequest.Builder

  • All Implemented Interfaces:
    ListAlbumsRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable
    Enclosing class:
    ListAlbumsRequest

    public static final class ListAlbumsRequest.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<ListAlbumsRequest.Builder>
    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
    • Method Detail

      • 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.Builder<ListAlbumsRequest.Builder>
      • clear

        public ListAlbumsRequest.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<ListAlbumsRequest.Builder>
      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ListAlbumsRequest.Builder>
      • getDefaultInstanceForType

        public ListAlbumsRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
      • build

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

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

        public ListAlbumsRequest.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<ListAlbumsRequest.Builder>
      • setField

        public ListAlbumsRequest.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  java.lang.Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<ListAlbumsRequest.Builder>
      • clearField

        public ListAlbumsRequest.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ListAlbumsRequest.Builder>
      • clearOneof

        public ListAlbumsRequest.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ListAlbumsRequest.Builder>
      • setRepeatedField

        public ListAlbumsRequest.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                          int index,
                                                          java.lang.Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListAlbumsRequest.Builder>
      • addRepeatedField

        public ListAlbumsRequest.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                          java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ListAlbumsRequest.Builder>
      • mergeFrom

        public ListAlbumsRequest.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListAlbumsRequest.Builder>
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ListAlbumsRequest.Builder>
      • mergeFrom

        public ListAlbumsRequest.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListAlbumsRequest.Builder>
        Throws:
        java.io.IOException
      • 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.
      • setPageSize

        public ListAlbumsRequest.Builder setPageSize​(int value)
         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;
        Parameters:
        value - The pageSize to set.
        Returns:
        This builder for chaining.
      • clearPageSize

        public ListAlbumsRequest.Builder clearPageSize()
         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;
        Returns:
        This builder for chaining.
      • 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.
      • setPageToken

        public ListAlbumsRequest.Builder setPageToken​(java.lang.String value)
         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;
        Parameters:
        value - The pageToken to set.
        Returns:
        This builder for chaining.
      • clearPageToken

        public ListAlbumsRequest.Builder clearPageToken()
         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;
        Returns:
        This builder for chaining.
      • setPageTokenBytes

        public ListAlbumsRequest.Builder setPageTokenBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for pageToken to set.
        Returns:
        This builder for chaining.
      • 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.
      • setExcludeNonAppCreatedData

        public ListAlbumsRequest.Builder setExcludeNonAppCreatedData​(boolean value)
         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;
        Parameters:
        value - The excludeNonAppCreatedData to set.
        Returns:
        This builder for chaining.
      • clearExcludeNonAppCreatedData

        public ListAlbumsRequest.Builder clearExcludeNonAppCreatedData()
         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;
        Returns:
        This builder for chaining.
      • setUnknownFields

        public final ListAlbumsRequest.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListAlbumsRequest.Builder>
      • mergeUnknownFields

        public final ListAlbumsRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ListAlbumsRequest.Builder>