# RealtimeDatabaseAuditMetadata

- [JSON representation](https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata#SCHEMA_REPRESENTATION)
- [RealtimeDatabaseAuditMetadata.QueryMetadata](https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata#RealtimeDatabaseAuditMetadata.QueryMetadata)
  - [JSON representation](https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata#RealtimeDatabaseAuditMetadata.QueryMetadata.SCHEMA_REPRESENTATION)
- [RealtimeDatabaseAuditMetadata.QueryMetadata.Bound](https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata#RealtimeDatabaseAuditMetadata.QueryMetadata.Bound)
  - [JSON representation](https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata#RealtimeDatabaseAuditMetadata.QueryMetadata.Bound.SCHEMA_REPRESENTATION)
- [RealtimeDatabaseAuditMetadata.WriteMetadata](https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata#RealtimeDatabaseAuditMetadata.WriteMetadata)
  - [JSON representation](https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata#RealtimeDatabaseAuditMetadata.WriteMetadata.SCHEMA_REPRESENTATION)
- [RealtimeDatabaseAuditMetadata.RestMetadata](https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata#RealtimeDatabaseAuditMetadata.RestMetadata)
  - [JSON representation](https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata#RealtimeDatabaseAuditMetadata.RestMetadata.SCHEMA_REPRESENTATION)
- [RealtimeDatabaseAuditMetadata.Precondition](https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata#RealtimeDatabaseAuditMetadata.Precondition)
  - [JSON representation](https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata#RealtimeDatabaseAuditMetadata.Precondition.SCHEMA_REPRESENTATION)

`FirebaseRealtimeDatabaseAuditMetaData` is exposed as part of the new `protoPayload.metadata` messages.

| JSON representation |
|---|
| ``` { "requestType": enum (`https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata.RequestType`), "protocol": enum (`https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata.Protocol`), "restMetadata": { object (`https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata#RealtimeDatabaseAuditMetadata.RestMetadata`) }, "precondition": { object (`https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata#RealtimeDatabaseAuditMetadata.Precondition`) }, "executeDuration": https://developers.google.com/protocol-buffers/docs/reference/google.protobuf?db=markarndt-one-plat-ref-docs-techdebt#google.protobuf.Duration, "pendingDuration": https://developers.google.com/protocol-buffers/docs/reference/google.protobuf?db=markarndt-one-plat-ref-docs-techdebt#google.protobuf.Duration, "path": string, // Union field `operation_metadata` can be only one of the following: "queryMetadata": { object (`https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata#RealtimeDatabaseAuditMetadata.QueryMetadata`) }, "writeMetadata": { object (`https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata#RealtimeDatabaseAuditMetadata.WriteMetadata`) } // End of list of possible types for union field `operation_metadata`. "estimatedPayloadSizeBytes": https://developers.google.com/discovery/v1/type-format?db=markarndt-one-plat-ref-docs-techdebt } ``` |

| Fields ||
|---|---|
| `requestType` | ``enum (`https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata.RequestType`)`` Preserve the distinction between realtime and REST operations. Unlike RTDB profiler output, Cloud Audit Data Access Logs for RTDB collapse `realtime-*` and `rest-*` operations into `Read`, `Write`, and `Update` methods. |
| `protocol` | ``enum (`https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata.Protocol`)`` Store what protocol was used. |
| `restMetadata` | ``object (`https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata#RealtimeDatabaseAuditMetadata.RestMetadata`)`` Details relevant only to REST requests. |
| `precondition` | ``object (`https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata#RealtimeDatabaseAuditMetadata.Precondition`)`` An optional precondition for an `Update`. Not present for any other methods. |
| `executeDuration` | `` `https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration` `` RTDB server business execution time. Not present for: `Connect`, `Disconnect`, or `Unlisten`. |
| `pendingDuration` | `` `https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Duration` `` RTDB server queueing time before execution begins. Not present for: `Unlisten` initiated by the server or `RunOnDisconnect`. |
| `path` | `string` The data path that was accessed. Not present for: `Connect`, `Disconnect`, or `RunOnDisconnect`. |
| Union field `operation_metadata`. More details about `Listen`s, `Read`s, or `Update`s. `operation_metadata` can be only one of the following: ||
| `queryMetadata` | ``object (`https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata#RealtimeDatabaseAuditMetadata.QueryMetadata`)`` Metadata information for a `Listen` or `Read`. |
| `writeMetadata` | ``object (`https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata#RealtimeDatabaseAuditMetadata.WriteMetadata`)`` Metadata information for an `Update`. |
| `estimatedPayloadSizeBytes` | `https://developers.google.com/discovery/v1/type-format` The estimated response size of the audited operation in bytes. Do not use for billing purposes. Not present for: `Connect`, `Disconnect`, `Unlisten`, or `OnDisconnectCancel`. |

## RealtimeDatabaseAuditMetadata.QueryMetadata

`QueryMetadata` includes additional details about queries sent for `Listen`s or `Read`s.

| JSON representation |
|---|
| ``` { "orderBy": string, "direction": enum (`https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata.QueryMetadata.Direction`), "startAt": { object (`https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata#RealtimeDatabaseAuditMetadata.QueryMetadata.Bound`) }, "endAt": { object (`https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata#RealtimeDatabaseAuditMetadata.QueryMetadata.Bound`) }, "equalTo": { object (`https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata#RealtimeDatabaseAuditMetadata.QueryMetadata.Bound`) }, "unindexed": boolean, "limit": integer } ``` |

| Fields ||
|---|---|
| `orderBy` | `string` How is the query ordered? Possible values: `$key`, `$priority`, `$value`, `<path>`. |
| `direction` | ``enum (`https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata.QueryMetadata.Direction`)`` If `limitToLast` is used, `ASCENDING`. If `limitToFirst` is used, `DESCENDING`. If neither is used, but `startAt` or `startAfter` is used, `DESCENDING`. In all other cases, `ASCENDING`. |
| `startAt` | ``object (`https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata#RealtimeDatabaseAuditMetadata.QueryMetadata.Bound`)`` The query start point. |
| `endAt` | ``object (`https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata#RealtimeDatabaseAuditMetadata.QueryMetadata.Bound`)`` The query end point. |
| `equalTo` | ``object (`https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata#RealtimeDatabaseAuditMetadata.QueryMetadata.Bound`)`` If specified, query results only include children that match the specified value. |
| `unindexed` | `boolean` If true, RTDB is not using a server-side index to serve data for the query. This means that RTDB may be sending more data than the query selects. Otherwise, not present. |
| `limit` | `integer` The query was limited to either the first or last `limit` number of children. Not present when neither `limitToLast` nor `limitToFirst` is used. |

## RealtimeDatabaseAuditMetadata.QueryMetadata.Bound

A `Bound` is a query endpoint with a fallback key.

| JSON representation |
|---|
| ``` { "value": value, "key": string, "exclusive": boolean } ``` |

| Fields ||
|---|---|
| `value` | ``value (`https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.Value` format)`` A value from the database instance. |
| `key` | `string` The fallback key. If ordering by `$key` this field is omitted because its contents are stored in `value` instead. |
| `exclusive` | `boolean` True if `startAfter` or `endBefore` were used. In this case, the query results will not contain the endpoint values. |

## RealtimeDatabaseAuditMetadata.WriteMetadata

`WriteMetadata` includes additional details about `Update`s.

| JSON representation |
|---|
| ``` { "paths": { string: string, ... } } ``` |

| Fields ||
|---|---|
| `paths` | `map (key: string, value: https://developers.google.com/discovery/v1/type-format)` The paths modified in a multi-path update along with size of the data written at each path. |

## RealtimeDatabaseAuditMetadata.RestMetadata

`RestMetadata` contains details relevant only to REST requests.

| JSON representation |
|---|
| ``` { "requestUri": string, "requestMethod": enum (`https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata.RestMetadata.Method`) } ``` |

| Fields ||
|---|---|
| `requestUri` | `string` The full database URL, including the path: `https://[NAMESPACE].us-central1.firebasedatabase.app/a/b/c.json`. |
| `requestMethod` | ``enum (`https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata.RestMetadata.Method`)`` For REST requests, what method was used. Left unspecified for non-REST requests or if a method was not available. |

## RealtimeDatabaseAuditMetadata.Precondition

`Precondition` describes the precondition, if any, that was used for an `Update`. `Update`s with preconditions known more commonly in RTDB as transactions.

| JSON representation |
|---|
| ``` { "preconditionType": enum (`https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata.Precondition.PreconditionType`), "hash": string } ``` |

| Fields ||
|---|---|
| `preconditionType` | ``enum (`https://firebase.google.com/docs/reference/database/cal/rest/Shared.Types/RealtimeDatabaseAuditMetadata.Precondition.PreconditionType`)`` The type of precondition used. |
| `hash` | `string` A SHA1 hash of the data the client expects to be at `path`. For REST requests, this value is sent in an ETAG header. |