FirebaseOptions
extends Object| java.lang.Object | |
| ↳ | com.google.firebase.FirebaseOptions |
Class Overview
Configurable Firebase options.
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| class | FirebaseOptions.Builder | Builder for constructing FirebaseOptions. |
|||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| static FirebaseOptions.Builder |
builder()
Creates an empty builder.
| ||||||||||
| int |
getConnectTimeout()
Returns the connect timeout in milliseconds, which is applied to outgoing REST calls
made by the SDK.
| ||||||||||
| Map<String, Object> |
getDatabaseAuthVariableOverride()
Returns the
auth variable to be used in Security Rules. | ||||||||||
| String |
getDatabaseUrl()
Returns the Realtime Database URL to use for data storage.
| ||||||||||
| HttpTransport |
getHttpTransport()
Returns the
HttpTransport used to call remote HTTP endpoints. | ||||||||||
| JsonFactory |
getJsonFactory()
Returns the
JsonFactory used to parse JSON when calling remote HTTP endpoints. | ||||||||||
| String |
getProjectId()
Returns the Google Cloud project ID.
| ||||||||||
| int |
getReadTimeout()
Returns the read timeout applied to outgoing REST calls in milliseconds.
| ||||||||||
| String |
getServiceAccountId()
Returns the client email address of the service account.
| ||||||||||
| String |
getStorageBucket()
Returns the name of the Google Cloud Storage bucket used for storing application data.
| ||||||||||
| int |
getWriteTimeout()
Returns the write timeout applied to outgoing REST calls in milliseconds.
| ||||||||||
| FirebaseOptions.Builder |
toBuilder()
Creates a new
Builder from the options object. | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Public Methods
public static FirebaseOptions.Builder builder ()
Creates an empty builder.
Returns
- A new builder instance.
public int getConnectTimeout ()
Returns the connect timeout in milliseconds, which is applied to outgoing REST calls made by the SDK.
Returns
- Connect timeout in milliseconds. 0 indicates an infinite timeout.
public Map<String, Object> getDatabaseAuthVariableOverride ()
Returns the auth variable to be used in Security Rules.
Returns
- The
authvariable supplied viasetDatabaseAuthVariableOverride(Map.
public String getDatabaseUrl ()
Returns the Realtime Database URL to use for data storage.
Returns
- The Realtime Database URL supplied via
setDatabaseUrl(String).
public HttpTransport getHttpTransport ()
Returns the HttpTransport used to call remote HTTP endpoints. This transport is
used by all services of the SDK, except for FirebaseDatabase.
Returns
- A Google API client
HttpTransportinstance.
public JsonFactory getJsonFactory ()
Returns the JsonFactory used to parse JSON when calling remote HTTP endpoints.
Returns
- A Google API client
JsonFactoryinstance.
public String getProjectId ()
Returns the Google Cloud project ID.
Returns
- The project ID set via
setProjectId(String)
public int getReadTimeout ()
Returns the read timeout applied to outgoing REST calls in milliseconds.
Returns
- Read timeout in milliseconds. 0 indicates an infinite timeout.
public String getServiceAccountId ()
Returns the client email address of the service account.
Returns
- The client email of the service account set via
setServiceAccountId(String)
public String getStorageBucket ()
Returns the name of the Google Cloud Storage bucket used for storing application data.
Returns
- The cloud storage bucket name set via
setStorageBucket(String)
public int getWriteTimeout ()
Returns the write timeout applied to outgoing REST calls in milliseconds.
Returns
- Write timeout in milliseconds. 0 indicates an infinite timeout.
public FirebaseOptions.Builder toBuilder ()
Creates a new Builder from the options object.
The new builder is not backed by this object's values; that is, changes made to the new builder don't change the values of the origin object.