package google.firebase.dataconnect.v1
Get desktop application:
View/edit binary Protocol Buffers messages
Firebase Data Connect provides means to deploy a set of predefined GraphQL operations (queries and mutations) as a Connector. Firebase developers can build mobile and web apps that uses Connectors to access Data Sources directly. Connectors allow operations without admin credentials and help Firebase customers control the API exposure. Note: `ConnectorService` doesn't check IAM permissions and instead developers must define auth policies on each pre-defined operation to secure this connector. The auth policies typically define rules on the Firebase Auth token.
Execute a predefined mutation in a Connector.
message
connector_service.proto:71The ExecuteMutation request to Firebase Data Connect.
string name = 1
The resource name of the connector to find the predefined mutation, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ```
string operation_name = 2
The name of the GraphQL operation name. Required because all Connector operations must be named. See https://graphql.org/learn/queries/#operation-name. (-- api-linter: core::0122::name-suffix=disabled aip.dev/not-precedent: Must conform to GraphQL HTTP spec standard. --)
optional variables = 3
Values for GraphQL variables provided in this request.
message
connector_service.proto:101The ExecuteMutation response from Firebase Data Connect.
optional data = 1
The result of executing the requested operation.
repeated errors = 2
Errors of this response.
optional extensions = 3
Additional response information.
Execute a predefined query in a Connector.
message
connector_service.proto:51The ExecuteQuery request to Firebase Data Connect.
string name = 1
The resource name of the connector to find the predefined query, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ```
string operation_name = 2
The name of the GraphQL operation name. Required because all Connector operations must be named. See https://graphql.org/learn/queries/#operation-name. (-- api-linter: core::0122::name-suffix=disabled aip.dev/not-precedent: Must conform to GraphQL HTTP spec standard. --)
optional variables = 3
Values for GraphQL variables provided in this request.
message
connector_service.proto:91The ExecuteQuery response from Firebase Data Connect.
optional data = 1
The result of executing the requested operation.
repeated errors = 2
Errors of this response.
optional extensions = 3
Additional response information.
ConnectorStreamService provides bi-directional streaming APIs to use with Firebase Data Connect connectors.
rpc Connect (stream , stream )
connector_stream_service.proto:43Connect establishes a bi-directional connection to the server. The client can send new requests, resume requests, and receive realtime updates. The connection may last for hours, the Data Connect SDK should refresh Firebase auth token to avoid revoked query subscriptions. (-- api-linter: core::0136::verb-noun=disabled aip.dev/not-precedent: Connect is a general purpose streaming API. --)
StreamRequest defines the request of Data Connect's bi-directional streaming API. It supports 4 different request kinds: - Subscribe: Subscribe to the result of a Data Connect query. - Execute: Execute a Data Connect query or mutation. - Resume: Resume a query or part of it. - Cancel: Signal that the client is no longer interested in the result of this operation.
string name = 1
The resource name of the connector to find the predefined query, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ``` Only needed for the first request of rpc Stream.
map<string, string> headers = 10
The HTTP headers to use for the request. (-- See go/fdc-realtime-headers --)
string request_id = 2
The request id used to identify a request within the stream. It only needs to be unique within the stream, commonly a monotonically increasing sequence number per stream. (-- api-linter: core::0155::request-id-format=disabled aip.dev/not-precedent: request_id is only unique within the stream. --)
oneof request_kind
The kind of request.
subscribe = 3
Subscribe to the result of a Data Connect query. Watch for any subsequent changes until it’s cancelled by either client or backend. Must provide a new stream request id.
execute = 4
Execute a Data Connect query or mutation. Must provide a new stream request id.
resume = 5
Resume a query or part of it. Prefer an existing stream request id. Though it can send a new request if the connection was interrupted.
cancel = 6
Signal that the client is no longer interested in the result of this operation.
string data_etag = 8
A server-provided ETag for the data payload. To save bandwidth, include this ETag in subsequent requests to prevent the server from resending data that has not changed.
StreamResponse defines the response of Data Connect's bi-directional streaming API.
string request_id = 1
Identify which request this response is for. (-- api-linter: core::0155::request-id-format=disabled aip.dev/not-precedent: request_id is only unique within the stream. --)
optional data = 2
The result of executing the requested operation.
string data_etag = 4
The backend may return a data_etag, computed based on the data JSON payload. To save bandwidth, the Data Connect SDK should include data_etag of cached data in subsequent requests, so the backend can avoid sending redundant data already in SDK cache.
repeated errors = 3
Errors of this response.
bool cancelled = 5
The backend can no longer serve this operation. For example, it may become invalid after schema change.
optional extensions = 6
Additional response information.
Action indicates the operation type on the entity.
Used in:
ACTION_UNSPECIFIED = 0
GET = 1
LIST = 2
CREATE = 3
UPDATE = 4
UPSERT = 5
DELETE = 6
Data Connect specific properties for a path under response.data. (-- Design doc: http://go/fdc-caching-wire-protocol --)
Used in:
optional path = 1
The path under response.data where the rest of the fields apply. Each element may be a string (field name) or number (array index). The root of response.data is denoted by the empty list `[]`. (-- To simplify client logic, the server should never set this to null. i.e. Use `[]` if the properties below apply to everything in data. --)
string entity_id = 2
A single Entity ID. Set if the path points to a single entity.
repeated string entity_ids = 3
A list of Entity IDs. Set if the path points to an array of entities. An ID is present for each element of the array at the corresponding index.
Action action = 5
Indicates the action performed on the entity in this path.
optional max_age = 4
The server-suggested duration before data under path is considered stale. (-- Right now, this field is never set. For future plans, see http://go/fdc-sdk-caching-config#heading=h.rmvncy2rao3g --)
ExecuteRequest defines the request to execute a Data Connect query or mutation.
Used in:
string operation_name = 2
The name of the GraphQL operation name. Required because all connector operations must be named. See https://graphql.org/learn/queries/#operation-name. (-- api-linter: core::0122::name-suffix=disabled aip.dev/not-precedent: Must conform to GraphQL HTTP spec standard. --)
optional variables = 3
Values for GraphQL variables provided in this request.
message
graphql_error.proto:41GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql`, `ExecuteGraphqlRead` and `IntrospectGraphql` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation`, `ExecuteQuery`, `IntrospectGraphql`, `ImpersonateQuery` and `ImpersonateMutation` all return Code.OK with a list of `GraphqlError` in response body.
Used in: , ,
string message = 1
The detailed error message. The message should help developer understand the underlying problem without leaking internal data.
repeated locations = 2
The source locations where the error occurred. Locations should help developers and toolings identify the source of error quickly. Included in admin endpoints (`ExecuteGraphql`, `ExecuteGraphqlRead`, `IntrospectGraphql`, `ImpersonateQuery`, `ImpersonateMutation`, `UpdateSchema` and `UpdateConnector`) to reference the provided GraphQL GQL document. Omitted in `ExecuteMutation` and `ExecuteQuery` since the caller shouldn't have access access the underlying GQL source.
optional path = 3
The result field which could not be populated due to error. Clients can use path to identify whether a null result is intentional or caused by a runtime error. It should be a list of string or index from the root of GraphQL query document.
optional extensions = 4
Additional error information.
message
graphql_error.proto:73GraphqlErrorExtensions contains additional information of `GraphqlError`.
Used in:
string file = 1
The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`.
rpc.Code code = 2
Maps to canonical gRPC codes. If not specified, it represents `Code.INTERNAL`.
string debug_details = 3
More detailed error message to assist debugging. It contains application business logic that are inappropriate to leak publicly. In the emulator, Data Connect API always includes it to assist local development and debugging. In the backend, ConnectorService always hides it. GraphqlService without impersonation always include it. GraphqlService with impersonation includes it only if explicitly opted-in with `include_debug_details` in `GraphqlRequestExtensions`.
string resource = 4
Distinguish which schema or connector the error originates from. It should be set on errors from control plane APIs (e.g. `UpdateSchema`, `UpdateConnector`).
WarningLevel warning_level = 5
Warning level describes the severity and required action to suppress this warning when Firebase CLI run into it.
repeated workarounds = 6
Workarounds provide suggestions to address warnings.
GraphqlResponseExtensions contains additional information of `GraphqlResponse` or `ExecuteQueryResponse`.
Used in: , ,
repeated data_connect = 1
Data Connect specific GraphQL extension, a list of paths and properties. (-- Future fields should go inside to avoid name conflicts with other GQL extensions in the wild unless we're implementing a common 3P pattern in extensions such as versioning and telemetry. --)
ResumeRequest defines the request to resume a query or part of it.
Used in:
(message has no fields)
message
graphql_error.proto:118SourceLocation references a location in a GraphQL source.
Used in:
int32 line = 1
Line number starting at 1.
int32 column = 2
Column number starting at 1.
WarningLevel describes the severity and required action to suppress this warning when Firebase CLI run into it.
Used in:
WARNING_LEVEL_UNKNOWN = 0
Warning level is not specified.
LOG_ONLY = 1
Display a warning without action needed.
INTERACTIVE_ACK = 2
Request a confirmation in interactive deployment flow.
REQUIRE_ACK = 3
Require an explicit confirmation in all deployment flows.
REQUIRE_FORCE = 4
Require --force in all deployment flows.
message
graphql_error.proto:108Workaround provides suggestions to address errors and warnings.
Used in:
string description = 1
Description of this workaround.
string reason = 2
Why would this workaround address the error and warning.
string replace = 3
A suggested code snippet to fix the error and warning.