package google.events.firebase.dataconnect.v1
Get desktop application:
View/edit binary Protocol Buffers messages
message
data.proto:104Settings for CloudSQL instance configuration.
Used in:
string instance = 1
Required. Name of the CloudSQL instance, in the format: ``` projects/{project}/locations/{location}/instances/{instance} ```
message
data.proto:157Connector consists of a set of operations, i.e. queries and mutations.
Used in:
string name = 1
Identifier. The relative resource name of the connector, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ```
optional create_time = 2
Output only. [Output only] Create time stamp.
optional update_time = 3
Output only. [Output only] Update time stamp.
map<string, string> labels = 4
Optional. Labels as key value pairs.
map<string, string> annotations = 5
Optional. Stores small amounts of arbitrary data.
optional source = 6
Required. The source files that comprise the connector.
string uid = 7
Output only. System-assigned, unique identifier.
bool reconciling = 8
Output only. A field that if true, indicates that the system is working to compile and deploy the connector.
string display_name = 9
Optional. Mutable human-readable name. 63 character limit.
string etag = 99
Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154)
message
events.proto:107The CloudEvent raised when a Connector is created.
optional data = 1
The data associated with the event.
message
events.proto:129The CloudEvent raised when a Connector is deleted.
optional data = 1
The data associated with the event.
message
data.proto:268The data within all Connector events.
Used in: , ,
optional payload = 1
Optional. The Connector event payload. Unset for deletion events.
message
events.proto:118The CloudEvent raised when a Connector is updated.
optional data = 1
The data associated with the event.
message
data.proto:69A data source that backs Firebase Data Connect services.
Used in:
oneof configuration
Settings and configurations of the underlying data source.
postgresql = 2
PostgreSQL configurations.
message
data.proto:203Individual files.
Used in:
string path = 1
Required. The file name including folder path, if applicable. The path should be relative to a local workspace (e.g. dataconnect/(schema|connector)/*.gql) and not an absolute path (e.g. /absolute/path/(schema|connector)/*.gql).
string content = 2
Required. The file's textual content.
message
data.proto:274GraphqlError contains the error information of a GraphQL query or mutation.
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` and `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
data.proto:306GraphqlErrorExtensions 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`.
message
data.proto:338Used in:
optional data = 1
The result of the execution of the requested operation. If an error was raised before execution begins, the data entry should not be present in the result. (a request error: https://spec.graphql.org/draft/#sec-Errors.Request-Errors) If an error was raised during the execution that prevented a valid response, the data entry in the response should be null. (a field error: https://spec.graphql.org/draft/#sec-Errors.Error-Result-Format)
optional variables = 3
Values for GraphQL variables provided in this request.
repeated errors = 2
Errors of this response. If the data entry in the response is not present, the errors entry must be present. It conforms to https://spec.graphql.org/draft/#sec-Errors.
message
data.proto:359The data within all Mutation events.
Used in:
optional payload = 1
message
events.proto:140The CloudEvent raised when a Mutation is executed.
optional data = 1
The data associated with the event.
message
data.proto:78Settings for PostgreSQL data source.
Used in:
oneof before_deploy
Configure the behavior before deploying this schema. Default to `schema_validation=STRICT` if not specified.
SqlSchemaValidation schema_validation = 3
Optional. Configure how much Postgresql schema validation to perform.
SqlSchemaMigration schema_migration = 5
Optional. Configure how to perform Postgresql schema migration.
oneof configuration
Settings and configurations of the underlying database.
bool unlinked = 4
No Postgres data source is linked. If set, don't allow `database` and `schema_validation` to be configured.
cloud_sql = 2
Cloud SQL configurations.
string database = 1
Required. Name of the PostgreSQL database.
message
data.proto:113The application schema of a Firebase Data Connect service.
Used in:
string name = 1
Identifier. The relative resource name of the schema, in the format: ``` projects/{project}/locations/{location}/services/{service}/schemas/{schema} ``` Right now, the only supported schema is "main".
optional create_time = 2
Output only. [Output only] Create time stamp.
optional update_time = 3
Output only. [Output only] Update time stamp.
map<string, string> labels = 4
Optional. Labels as key value pairs.
map<string, string> annotations = 5
Optional. Stores small amounts of arbitrary data.
repeated datasources = 11
Required. The data sources linked in the schema.
optional source = 7
Required. The source files that comprise the application schema.
string uid = 8
Output only. System-assigned, unique identifier.
bool reconciling = 9
Output only. A field that if true, indicates that the system is working to compile and deploy the schema.
string display_name = 10
Optional. Mutable human-readable name. 63 character limit.
string etag = 99
Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154)
message
events.proto:74The CloudEvent raised when a Schema is created.
optional data = 1
The data associated with the event.
message
events.proto:96The CloudEvent raised when a Schema is deleted.
optional data = 1
The data associated with the event.
message
data.proto:262The data within all Schema events.
Used in: , ,
optional payload = 1
Optional. The Schema event payload. Unset for deletion events.
message
events.proto:85The CloudEvent raised when a Schema is updated.
optional data = 1
The data associated with the event.
message
data.proto:28A Firebase Data Connect service.
Used in:
string name = 1
Identifier. The relative resource name of the Firebase Data Connect service, in the format: ``` projects/{project}/locations/{location}/services/{service} ``` Note that the service ID is specific to Firebase Data Connect and does not correspond to any of the instance IDs of the underlying data source connections.
optional create_time = 2
Output only. [Output only] Create time stamp.
optional update_time = 3
Output only. [Output only] Update time stamp.
map<string, string> labels = 4
Optional. Labels as key value pairs.
map<string, string> annotations = 5
Optional. Stores small amounts of arbitrary data.
string uid = 6
Output only. System-assigned, unique identifier.
bool reconciling = 7
Output only. A field that if true, indicates that the system is working update the service.
string display_name = 8
Optional. Mutable human-readable name. 63 character limit.
string etag = 99
Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. [AIP-154](https://google.aip.dev/154)
message
events.proto:44The CloudEvent raised when a Service is created.
optional data = 1
The data associated with the event.
message
events.proto:64The CloudEvent raised when a Service is deleted.
optional data = 1
The data associated with the event.
message
data.proto:256The data within all Service events.
Used in: , ,
optional payload = 1
Optional. The Service event payload. Unset for deletion events.
message
events.proto:54The CloudEvent raised when a Service is updated.
optional data = 1
The data associated with the event.
message
data.proto:197Used to represent a set of source files.
Used in: ,
repeated files = 1
Required. The files that comprise the source set.
message
data.proto:330SourceLocation 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.
Configure how to perform SQL Schema migration before deploying the Schema.
Used in:
SQL_SCHEMA_MIGRATION_UNSPECIFIED = 0
Unspecified SQL schema migration.
MIGRATE_COMPATIBLE = 1
Connect to the SQL database and identify any missing SQL resources used in the given Firebase Data Connect Schema. Automatically create necessary SQL resources (SQL table, column, etc) before deploying the schema. During migration steps, the SQL Schema must comply with the previous before_deploy setting in case the migration is interrupted. Therefore, the previous before_deploy setting must not be `schema_validation=STRICT`.
Configure how much SQL Schema to perform for the given schema.
Used in:
SQL_SCHEMA_VALIDATION_UNSPECIFIED = 0
Unspecified SQL schema validation. Default to STRICT.
NONE = 1
Skip no SQL schema validation. Use it with extreme caution. CreateSchema or UpdateSchema will succeed even if SQL database is unavailable or SQL schema is incompatible. Generated SQL may fail at execution time.
STRICT = 2
Connect to the SQL database and validate that the SQL DDL matches the schema exactly. Surface any discrepancies as `FAILED_PRECONDITION` with an `IncompatibleSqlSchemaError` error detail.
COMPATIBLE = 3
Connect to the SQL database and validate that the SQL DDL has all the SQL resources used in the given Firebase Data Connect Schema. Surface any missing resources as `FAILED_PRECONDITION` with an `IncompatibleSqlSchemaError` error detail. Succeed even if there are unknown tables and columns.