# GeneratedConnector

# GeneratedConnector


```
interface GeneratedConnector<T : GeneratedConnector<T>>
```

<br />

*** ** * ** ***

The interface to be implemented by the over-arching "connector" classes that are generated by the Firebase CLI code generation.

### Safe for concurrent use

All methods and properties of `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/generated/GeneratedConnector` are thread-safe and may be safely called and/or accessed concurrently from multiple threads and/or coroutines.

### Stable for inheritance

The `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/generated/GeneratedConnector` interface *is* stable for inheritance in third-party libraries, as new methods will not be added to this interface and contracts of the existing methods will not be changed, except possibly during major version number changes.

## Summary

| ### Public functions |
|---|---|
| `T` | `@https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/ExperimentalFirebaseDataConnect https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/generated/GeneratedConnector#copy(com.google.firebase.dataconnect.FirebaseDataConnect)(dataConnect: https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/FirebaseDataConnect)` Creates and returns a new object that is a *copy* of this object, but with the properties whose names corresponding to the given arguments changed to the respective argument's value. |
| `operator https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/generated/GeneratedConnector#equals(kotlin.Any)(other: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html?)` Compares this object with another object for equality. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/generated/GeneratedConnector#hashCode()()` Calculates and returns the hash code for this object. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/generated/GeneratedMutation<T, *, *>>` | `@https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/ExperimentalFirebaseDataConnect https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/generated/GeneratedConnector#mutations()()` Returns a list containing all `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/generated/GeneratedMutation` objects defined as properties in this object in an unspecified order. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/generated/GeneratedOperation<T, *, *>>` | `@https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/ExperimentalFirebaseDataConnect https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/generated/GeneratedConnector#operations()()` Returns a list containing all `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/generated/GeneratedQuery` and `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/generated/GeneratedMutation` objects defined as properties in this object, in an unspecified order.. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/generated/GeneratedQuery<T, *, *>>` | `@https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/ExperimentalFirebaseDataConnect https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/generated/GeneratedConnector#queries()()` Returns a list containing all `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/generated/GeneratedQuery` objects defined as properties in this object in an unspecified order. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html` | `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/generated/GeneratedConnector#toString()()` Returns a string representation of this object, useful for debugging. |

| ### Public properties |
|---|---|
| `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/FirebaseDataConnect` | `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/generated/GeneratedConnector#dataConnect()` The `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/FirebaseDataConnect` instance used by this object. |

## Public functions

### copy

```
@ExperimentalFirebaseDataConnect
fun copy(dataConnect: FirebaseDataConnect = this.dataConnect): T
```

Creates and returns a new object that is a *copy* of this object, but with the properties whose names corresponding to the given arguments changed to the respective argument's value.

This function is essentially the same as the `copy()` method that is generated by the Kotlin compiler for `data class` classes.

### equals

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

Compares this object with another object for equality.

If this methods returns `true` then invoking any method or accessing any property on `this` should have the same side effects as accessing the same property or invoking the same method with the same arguments on `other`, respectively. The implementation checks for *logical* equality, rather than *referential* equality. A likely implementation looks like this:

```kotlin
override fun equals(other: Any?): Boolean =
  other is DemoGeneratedConnectorImpl &&
  other.dataConnect == dataConnect
```

| Parameters |
|---|---|
| `other: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html?` | The object to compare to this for equality. |

| Returns |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | `true` if, and only if, the given object is logically "equal" to this object. |

### hashCode

```
fun hashCode(): Int
```

Calculates and returns the hash code for this object.

| Returns |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html` | the hash code for this object. |

### mutations

```
@ExperimentalFirebaseDataConnect
fun mutations(): List<GeneratedMutation<T, *, *>>
```

Returns a list containing all `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/generated/GeneratedMutation` objects defined as properties in this object in an unspecified order.

| See also |
|---|---|
| `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/generated/GeneratedConnector#operations()` |   |
| `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/generated/GeneratedConnector#queries()` |   |

### operations

```
@ExperimentalFirebaseDataConnect
fun operations(): List<GeneratedOperation<T, *, *>>
```

Returns a list containing all `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/generated/GeneratedQuery` and `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/generated/GeneratedMutation` objects defined as properties in this object, in an unspecified order..

Namely, the returned list will contain exactly the elements returned from `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/generated/GeneratedConnector#queries()` and `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/generated/GeneratedConnector#mutations()`.

| See also |
|---|---|
| `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/generated/GeneratedConnector#queries()` |   |
| `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/generated/GeneratedConnector#mutations()` |   |

### queries

```
@ExperimentalFirebaseDataConnect
fun queries(): List<GeneratedQuery<T, *, *>>
```

Returns a list containing all `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/generated/GeneratedQuery` objects defined as properties in this object in an unspecified order.

| See also |
|---|---|
| `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/generated/GeneratedConnector#operations()` |   |
| `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/generated/GeneratedConnector#mutations()` |   |

### toString

```
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 |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html` | a string representation of this object. |

## Public properties

### dataConnect

```
val dataConnect: FirebaseDataConnect
```

The `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/dataconnect/FirebaseDataConnect` instance used by this object.