DataConnectSettings

class DataConnectSettings


Settings that control the behavior of FirebaseDataConnect instances.

Safe for Concurrent Use

All methods and properties of DataConnectSettings are thread-safe and may be safely called and/or accessed concurrently from multiple threads and/or coroutines.

Summary

Public constructors

DataConnectSettings(host: String, sslEnabled: Boolean)

Public functions

open operator Boolean
equals(other: Any?)

Compares this object with another object for equality.

open Int

Calculates and returns the hash code for this object.

open String

Returns a string representation of this object, useful for debugging.

Public properties

String

The host of the Firebase Data Connect service to which to connect (e.g. "myproxy.foo.com", "myproxy.foo.com:9987").

Boolean

Whether to use SSL for the connection; if true, then the connection will be encrypted using SSL and, if false, the connection will not be encrypted and all network transmission will happen in plaintext.

Extension functions

DataConnectSettings
DataConnectSettings.copy(host: String, sslEnabled: Boolean)

Creates and returns a new DataConnectSettings instance with the given property values.

Public constructors

DataConnectSettings

DataConnectSettings(
    host: String = "firebasedataconnect.googleapis.com",
    sslEnabled: Boolean = true
)

Public functions

equals

open operator fun equals(other: Any?): Boolean

Compares this object with another object for equality.

Parameters
other: Any?

The object to compare to this for equality.

Returns
Boolean

true if, and only if, the other object is an instance of DataConnectSettings whose public properties compare equal using the == operator to the corresponding properties of this object.

hashCode

open fun hashCode(): Int

Calculates and returns the hash code for this object.

The hash code is not guaranteed to be stable across application restarts.

Returns
Int

the hash code for this object, that incorporates the values of this object's public properties.

toString

open fun toString(): String

Returns a string representation of this object, useful for debugging.

The string representation is not guaranteed to be stable and may change without notice at any time. Therefore, the only recommended usage of the returned string is debugging and/or logging. Namely, parsing the returned string or storing the returned string in non-volatile storage should generally be avoided in order to be robust in case that the string representation changes.

Returns
String

a string representation of this object, which includes the class name and the values of all public properties.

Public properties

host

val hostString

The host of the Firebase Data Connect service to which to connect (e.g. "myproxy.foo.com", "myproxy.foo.com:9987").

sslEnabled

val sslEnabledBoolean

Whether to use SSL for the connection; if true, then the connection will be encrypted using SSL and, if false, the connection will not be encrypted and all network transmission will happen in plaintext.

Extension functions

copy

fun DataConnectSettings.copy(
    host: String = this.host,
    sslEnabled: Boolean = this.sslEnabled
): DataConnectSettings

Creates and returns a new DataConnectSettings instance with the given property values.