main.java.com.cloudant.client.api.views.AllDocsRequestBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cloudant-client Show documentation

Official Cloudant client for Java

There is a newer version: 2.20.1

/*
 * Copyright (c) 2015 IBM Corp. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the
 * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */

package com.cloudant.client.api.views;

/**
 * Interface for building an unpaginated _all_docs request.
 * 
 * Example usage:
 * 
 *  * {@code
 *
 * AllDocsRequest allDocsRequest =
 * //get a request builder for the "_all_docs" endpoint
 * db.getAllDocsRequestBuilder()
 *
 *   //set any other required parameters e.g. doc id of "foo" or "bar"
 *   .keys("foo", "bar")
 *
 *   //build the request
 *   .build();
 * }
 * 
 * Example to list all the document IDs in a database:
 *  *  {@code
 *  List allDocIds = db.getAllDocsRequestBuilder().build().getResponse().getDocIds();
 *  }
 *  
 * 
 * Example to fetch all the documents in the database:
 * 
 *  *  {@code
 *  List allFoos = db.getAllDocsRequestBuilder().includeDocs(true).build()
 *          .getRepsonse().getDocsAs(Foo.class);
 *  }
 *  
 * 
 * Example to fetch multiple documents, with the specified document IDs from the database:
 * 
 *  *  {@code
 *   String[] docIds = new String[]{"doc-id-1", "doc-id-2"};
 *   List foosWithIds = db.getAllDocsRequestBuilder().keys(docIds).includeDocs(true).build()
 *           .getRepsonse().getDocsAs(Foo.class);
 *  }
 *
 *  
 *
 * @see AllDocsRequest
 * @see AllDocsResponse
 * @since 2.0.0
 */
public interface AllDocsRequestBuilder extends RequestBuilder,
        SettableViewParameters.Unpaginated {

    /**
     * @return the built AllDocsRequest
     * @since 2.0.0
     */
    AllDocsRequest build();
}