Skip to content

Updated Firestore and GCS docs #93

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 2, 2017
Merged

Updated Firestore and GCS docs #93

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions src/main/java/com/google/firebase/cloud/FirestoreClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
import com.google.firebase.internal.NonNull;

/**
* FirestoreClient provides access to Google Cloud Firestore. Use this API to obtain a
* <code>com.google.cloud.firestore.Firestore</code> instance, which provides methods for
* updating and querying data in Firestore.
* {@code FirestoreClient} provides access to Google Cloud Firestore. Use this API to obtain a
* <a href="https://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/com/google/cloud/firestore/Firestore.html">{@code Firestore}</a>
* instance, which provides methods for updating and querying data in Firestore.
*
* <p>A Google Cloud project ID is required to access Firestore. FirestoreClient determines the
* project ID from the {@link com.google.firebase.FirebaseOptions} used to initialize the underlying
Expand Down Expand Up @@ -44,7 +44,8 @@ private FirestoreClient(FirebaseApp app) {
/**
* Returns the Firestore instance associated with the default Firebase app.
*
* @return A non-null <code>com.google.cloud.firestore.Firestore</code> instance.
* @return A non-null <a href="https://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/com/google/cloud/firestore/Firestore.html">{@code Firestore}</a>
* instance.
*/
@NonNull
public static Firestore getFirestore() {
Expand All @@ -55,7 +56,8 @@ public static Firestore getFirestore() {
* Returns the Firestore instance associated with the specified Firebase app.
*
* @param app A non-null {@link FirebaseApp}.
* @return A non-null <code>com.google.cloud.firestore.Firestore</code> instance.
* @return A non-null <a href="https://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/com/google/cloud/firestore/Firestore.html">{@code Firestore}</a>
* instance.
*/
@NonNull
public static Firestore getFirestore(FirebaseApp app) {
Expand Down
6 changes: 4 additions & 2 deletions src/main/java/com/google/firebase/cloud/StorageClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,8 @@ public static synchronized StorageClient getInstance(FirebaseApp app) {
* configured via {@link com.google.firebase.FirebaseOptions} when initializing the app. If
* no bucket was configured via options, this method throws an exception.
*
* @return a cloud storage Bucket instance, or null if the configured bucket does not exist.
* @return a cloud storage <a href="https://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/com/google/cloud/storage/Bucket.html">{@code Bucket}</a>
* instance.
* @throws IllegalArgumentException If no bucket is configured via <code>FirebaseOptions</code>,
* or if the bucket does not exist.
*/
Expand All @@ -79,7 +80,8 @@ public Bucket bucket() {
* Returns a cloud storage Bucket instance for the specified bucket name.
*
* @param name a non-null, non-empty bucket name.
* @return a cloud storage Bucket instance, or null if the specified bucket does not exist.
* @return a cloud storage <a href="https://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/com/google/cloud/storage/Bucket.html">{@code Bucket}</a>
* instance.
* @throws IllegalArgumentException If the bucket name is null, empty, or if the specified
* bucket does not exist.
*/
Expand Down