{ "documentationLink": "https://firebase.google.com/docs/data-connect", "canonicalName": "Firebase Data Connect", "schemas": { "ListServicesResponse": { "description": "Message for response to listing Services.", "type": "object", "id": "ListServicesResponse", "properties": { "services": { "type": "array", "description": "The list of Services.", "items": { "$ref": "Service" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "unreachable": { "type": "array", "description": "Locations that could not be reached.", "items": { "type": "string" } } } }, "ListConnectorsResponse": { "properties": { "connectors": { "description": "The list of Connectors.", "type": "array", "items": { "$ref": "Connector" } }, "nextPageToken": { "type": "string", "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages." }, "unreachable": { "description": "Locations that could not be reached.", "type": "array", "items": { "type": "string" } } }, "id": "ListConnectorsResponse", "type": "object", "description": "Message for response to listing Connectors. By default, `connectors.source` will not be included in the response. To specify the fields included in the response, the response field mask can be provided by using the query parameter `$fields` or the header `X-Goog-FieldMask`." }, "GraphqlRequest": { "id": "GraphqlRequest", "properties": { "extensions": { "description": "Optional. Additional GraphQL request information.", "$ref": "GraphqlRequestExtensions" }, "query": { "description": "Required. The GraphQL query document source.", "type": "string" }, "operationName": { "type": "string", "description": "Optional. The name of the GraphQL operation name. Required only if `query` contains multiple operations. See https://graphql.org/learn/queries/#operation-name." }, "variables": { "description": "Optional. Values for GraphQL variables provided in this request.", "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } } }, "description": "The GraphQL request to Firebase SQL Connect. It strives to match the GraphQL over HTTP spec. https://github.com/graphql/graphql-over-http/blob/main/spec/GraphQLOverHTTP.md#post", "type": "object" }, "ListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "type": "object", "id": "ListLocationsResponse", "properties": { "nextPageToken": { "type": "string", "description": "The standard List next-page token." }, "locations": { "description": "A list of locations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Location" } } } }, "ClientCache": { "properties": { "strictValidationEnabled": { "type": "boolean", "description": "Optional. A field that, if true, enables stricter validation on the connector source code to make sure the operation response shapes are suitable for client-side caching. This can include additional errors and warnings. For example, using the same alias for different fields is disallowed, as it may cause conflicts or confusion with normalized caching. (This field is off by default for compatibility, but enabling it is highly recommended to catch common caching pitfalls.)" }, "entityIdIncluded": { "description": "Optional. A field that, if true, means that responses served by this connector will include entityIds in GraphQL response extensions. This helps the client SDK cache responses in an improved way, known as \"normalized caching\", if caching is enabled on the client. Each entityId is a stable key based on primary key values. Therefore, this field should only be set to true if the primary keys of accessed tables do not contain sensitive information.", "type": "boolean" } }, "id": "ClientCache", "type": "object", "description": "Client caching settings of a connector." }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "id": "Operation", "properties": { "response": { "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "metadata": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any." }, "done": { "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", "type": "boolean" }, "name": { "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", "type": "string" }, "error": { "description": "The error result of the operation in case of failure or cancellation.", "$ref": "Status" } } }, "Impersonation": { "id": "Impersonation", "properties": { "unauthenticated": { "type": "boolean", "description": "Evaluate the auth policy as an unauthenticated request. Can only be set to true." }, "includeDebugDetails": { "type": "boolean", "description": "Optional. If set, include debug details in GraphQL error extensions." }, "authClaims": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Evaluate the auth policy with a customized JWT auth token. Should follow the Firebase Auth token format. https://firebase.google.com/docs/rules/rules-and-auth For example: a verified user may have auth_claims of {\"sub\": , \"email_verified\": true}" } }, "description": "Impersonation configures the Firebase Auth context to impersonate.", "type": "object" }, "Service": { "id": "Service", "properties": { "name": { "description": "Identifier. The relative resource name of the Firebase SQL Connect service, in the format: ``` projects/{project}/locations/{location}/services/{service} ``` Note that the service ID is specific to Firebase SQL Connect and does not correspond to any of the instance IDs of the underlying data source connections.", "type": "string" }, "updateTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. [Output only] Update time stamp." }, "reconciling": { "description": "Output only. A field that if true, indicates that the system is working update the service.", "readOnly": true, "type": "boolean" }, "labels": { "description": "Optional. Labels as key value pairs.", "type": "object", "additionalProperties": { "type": "string" } }, "createTime": { "format": "google-datetime", "description": "Output only. [Output only] Create time stamp.", "readOnly": true, "type": "string" }, "etag": { "readOnly": true, "type": "string", "description": "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)" }, "annotations": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. Stores small amounts of arbitrary data." }, "uid": { "description": "Output only. System-assigned, unique identifier.", "readOnly": true, "type": "string" }, "displayName": { "description": "Optional. Mutable human-readable name. 63 character limit.", "type": "string" } }, "description": "A Firebase SQL Connect service.", "type": "object" }, "ExecuteQueryResponse": { "type": "object", "description": "The ExecuteQuery response from Firebase SQL Connect.", "properties": { "data": { "description": "The result of executing the requested operation.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "errors": { "items": { "$ref": "GraphqlError" }, "type": "array", "description": "Errors of this response." }, "extensions": { "description": "Additional response information.", "$ref": "GraphqlResponseExtensions" } }, "id": "ExecuteQueryResponse" }, "ExecuteQueryRequest": { "id": "ExecuteQueryRequest", "properties": { "operationName": { "description": "Required. The name of the GraphQL operation name. Required because all Connector operations must be named. See https://graphql.org/learn/queries/#operation-name.", "type": "string" }, "variables": { "description": "Optional. Values for GraphQL variables provided in this request.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } }, "description": "The ExecuteQuery request to Firebase SQL Connect.", "type": "object" }, "File": { "id": "File", "properties": { "path": { "description": "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).", "type": "string" }, "content": { "type": "string", "description": "Required. The file's textual content." } }, "description": "Individual files.", "type": "object" }, "ExecuteMutationResponse": { "properties": { "extensions": { "description": "Additional response information.", "$ref": "GraphqlResponseExtensions" }, "data": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "The result of executing the requested operation." }, "errors": { "type": "array", "description": "Errors of this response.", "items": { "$ref": "GraphqlError" } } }, "id": "ExecuteMutationResponse", "type": "object", "description": "The ExecuteMutation response from Firebase SQL Connect." }, "ListOperationsResponse": { "properties": { "operations": { "type": "array", "description": "A list of operations that matches the specified filter in the request.", "items": { "$ref": "Operation" } }, "nextPageToken": { "type": "string", "description": "The standard List next-page token." }, "unreachable": { "items": { "type": "string" }, "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "type": "array" } }, "id": "ListOperationsResponse", "type": "object", "description": "The response message for Operations.ListOperations." }, "GraphqlResponseExtensions": { "description": "GraphqlResponseExtensions contains additional information of `GraphqlResponse` or `ExecuteQueryResponse`.", "type": "object", "id": "GraphqlResponseExtensions", "properties": { "dataConnect": { "items": { "$ref": "DataConnectProperties" }, "description": "SQL Connect specific GraphQL extension, a list of paths and properties.", "type": "array" } } }, "DataConnectProperties": { "description": "SQL Connect specific properties for a path under response.data.", "type": "object", "id": "DataConnectProperties", "properties": { "entityId": { "description": "A single Entity ID. Set if the path points to a single entity.", "type": "string" }, "path": { "items": { "type": "any" }, "description": "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 `[]`.", "type": "array" }, "entityIds": { "items": { "type": "string" }, "type": "array", "description": "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." }, "maxAge": { "description": "The server-suggested duration before data under path is considered stale.", "type": "string", "format": "google-duration" } } }, "GraphqlError": { "properties": { "extensions": { "description": "Additional error information.", "$ref": "GraphqlErrorExtensions" }, "message": { "description": "The detailed error message. The message should help developer understand the underlying problem without leaking internal data.", "type": "string" }, "locations": { "items": { "$ref": "SourceLocation" }, "type": "array", "description": "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." }, "path": { "items": { "type": "any" }, "type": "array", "description": "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." } }, "id": "GraphqlError", "type": "object", "description": "GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase SQL 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." }, "GraphqlResponse": { "id": "GraphqlResponse", "properties": { "extensions": { "description": "Additional response information. It conforms to https://spec.graphql.org/draft/#sec-Extensions .", "$ref": "GraphqlResponseExtensions" }, "data": { "description": "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)", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } }, "errors": { "description": "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 .", "type": "array", "items": { "$ref": "GraphqlError" } } }, "description": "The GraphQL response from Firebase SQL Connect. It strives to match the GraphQL over HTTP spec. Note: Firebase SQL Connect always responds with `Content-Type: application/json`. https://github.com/graphql/graphql-over-http/blob/main/spec/GraphQLOverHTTP.md#body", "type": "object" }, "CloudSqlInstance": { "id": "CloudSqlInstance", "properties": { "instance": { "description": "Required. Name of the CloudSQL instance, in the format: ``` projects/{project}/locations/{location}/instances/{instance} ```", "type": "string" } }, "description": "Settings for CloudSQL instance configuration.", "type": "object" }, "HttpGraphql": { "description": "Settings for HTTP GraphQL server webhook.", "type": "object", "id": "HttpGraphql", "properties": { "uri": { "type": "string", "description": "Required. The endpoint of the HTTP GraphQL server." }, "timeout": { "format": "google-duration", "description": "Optional. Timeout duration for the HTTP request.", "type": "string" } } }, "Location": { "properties": { "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}" }, "metadata": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "description": "Service-specific metadata. For example the available capacity at the given location." }, "locationId": { "type": "string", "description": "The canonical id for this location. For example: `\"us-east1\"`." }, "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "name": { "type": "string", "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`" } }, "id": "Location", "type": "object", "description": "A resource that represents a Google Cloud location." }, "SourceLocation": { "type": "object", "description": "SourceLocation references a location in a GraphQL source.", "properties": { "line": { "format": "int32", "type": "integer", "description": "Line number starting at 1." }, "column": { "description": "Column number starting at 1.", "type": "integer", "format": "int32" } }, "id": "SourceLocation" }, "GraphqlErrorExtensions": { "type": "object", "description": "GraphqlErrorExtensions contains additional information of `GraphqlError`.", "properties": { "debugDetails": { "description": "More detailed error message to assist debugging. It contains application business logic that are inappropriate to leak publicly. In the emulator, SQL 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`.", "type": "string" }, "file": { "type": "string", "description": "The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`." }, "workarounds": { "description": "Workarounds provide suggestions to address the compile errors or warnings.", "type": "array", "items": { "$ref": "Workaround" } }, "warningLevel": { "enumDescriptions": [ "Warning level is not specified.", "Display a warning without action needed.", "Request a confirmation in interactive deployment flow.", "Require an explicit confirmation in all deployment flows.", "Require --force in all deployment flows." ], "enum": [ "WARNING_LEVEL_UNKNOWN", "LOG_ONLY", "INTERACTIVE_ACK", "REQUIRE_ACK", "REQUIRE_FORCE" ], "description": "Warning level describes the severity and required action to suppress this warning when Firebase CLI run into it.", "type": "string" }, "code": { "type": "string", "description": "Maps to canonical gRPC codes. If not specified, it represents `Code.INTERNAL`.", "enumDescriptions": [ "Not an error; returned on success. HTTP Mapping: 200 OK", "The operation was cancelled, typically by the caller. HTTP Mapping: 499 Client Closed Request", "Unknown error. For example, this error may be returned when a `Status` value received from another address space belongs to an error space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error. HTTP Mapping: 500 Internal Server Error", "The client specified an invalid argument. Note that this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name). HTTP Mapping: 400 Bad Request", "The deadline expired before the operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. HTTP Mapping: 504 Gateway Timeout", "Some requested entity (e.g., file or directory) was not found. Note to server developers: if a request is denied for an entire class of users, such as gradual feature rollout or undocumented allowlist, `NOT_FOUND` may be used. If a request is denied for some users within a class of users, such as user-based access control, `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not Found", "The entity that a client attempted to create (e.g., file or directory) already exists. HTTP Mapping: 409 Conflict", "The caller does not have permission to execute the specified operation. `PERMISSION_DENIED` must not be used for rejections caused by exhausting some resource (use `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` must not be used if the caller can not be identified (use `UNAUTHENTICATED` instead for those errors). This error code does not imply the request is valid or the requested entity exists or satisfies other pre-conditions. HTTP Mapping: 403 Forbidden", "The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized", "Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests", "The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can retry just the failing call. (b) Use `ABORTED` if the client should retry at a higher level. For example, when a client-specified test-and-set fails, indicating the client should restart a read-modify-write sequence. (c) Use `FAILED_PRECONDITION` if the client should not retry until the system state has been explicitly fixed. For example, if an \"rmdir\" fails because the directory is non-empty, `FAILED_PRECONDITION` should be returned since the client should not retry unless the files are deleted from the directory. HTTP Mapping: 400 Bad Request", "The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict", "The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate `INVALID_ARGUMENT` if asked to read at an offset that is not in the range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read from an offset past the current file size. There is a fair bit of overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific error) when it applies so that callers who are iterating through a space can easily look for an `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 Bad Request", "The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented", "Internal errors. This means that some invariants expected by the underlying system have been broken. This error code is reserved for serious errors. HTTP Mapping: 500 Internal Server Error", "The service is currently unavailable. This is most likely a transient condition, which can be corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent operations. See the guidelines above for deciding between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 503 Service Unavailable", "Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal Server Error" ], "enum": [ "OK", "CANCELLED", "UNKNOWN", "INVALID_ARGUMENT", "DEADLINE_EXCEEDED", "NOT_FOUND", "ALREADY_EXISTS", "PERMISSION_DENIED", "UNAUTHENTICATED", "RESOURCE_EXHAUSTED", "FAILED_PRECONDITION", "ABORTED", "OUT_OF_RANGE", "UNIMPLEMENTED", "INTERNAL", "UNAVAILABLE", "DATA_LOSS" ] } }, "id": "GraphqlErrorExtensions" }, "Datasource": { "id": "Datasource", "properties": { "postgresql": { "description": "PostgreSQL configurations.", "$ref": "PostgreSql" }, "httpGraphql": { "description": "HTTP GraphQL server webhook configurations.", "$ref": "HttpGraphql" } }, "description": "A data source that backs Firebase SQL Connect services.", "type": "object" }, "GraphqlRequestExtensions": { "type": "object", "description": "GraphqlRequestExtensions contains additional information of `GraphqlRequest`.", "properties": { "impersonate": { "description": "Optional. If set, impersonate a request with given Firebase Auth context and evaluate the auth policies on the operation. If omitted, bypass any defined auth policies.", "$ref": "Impersonation" } }, "id": "GraphqlRequestExtensions" }, "CancelOperationRequest": { "properties": {}, "id": "CancelOperationRequest", "type": "object", "description": "The request message for Operations.CancelOperation." }, "Source": { "id": "Source", "properties": { "files": { "items": { "$ref": "File" }, "description": "Required. The files that comprise the source set.", "type": "array" } }, "description": "Used to represent a set of source files.", "type": "object" }, "Schema": { "properties": { "name": { "type": "string", "description": "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\"." }, "updateTime": { "description": "Output only. [Output only] Update time stamp.", "readOnly": true, "type": "string", "format": "google-datetime" }, "reconciling": { "description": "Output only. A field that if true, indicates that the system is working to compile and deploy the schema.", "readOnly": true, "type": "boolean" }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. Labels as key value pairs." }, "createTime": { "format": "google-datetime", "readOnly": true, "type": "string", "description": "Output only. [Output only] Create time stamp." }, "etag": { "description": "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)", "readOnly": true, "type": "string" }, "annotations": { "description": "Optional. Stores small amounts of arbitrary data.", "type": "object", "additionalProperties": { "type": "string" } }, "datasources": { "description": "Required. The data sources linked in the schema.", "type": "array", "items": { "$ref": "Datasource" } }, "source": { "description": "Required. The source files that comprise the application schema.", "$ref": "Source" }, "uid": { "readOnly": true, "type": "string", "description": "Output only. System-assigned, unique identifier." }, "displayName": { "type": "string", "description": "Optional. Mutable human-readable name. 63 character limit." } }, "id": "Schema", "type": "object", "description": "The application schema of a Firebase SQL Connect service." }, "ExecuteMutationRequest": { "type": "object", "description": "The ExecuteMutation request to Firebase SQL Connect.", "properties": { "operationName": { "type": "string", "description": "Required. The name of the GraphQL operation name. Required because all Connector operations must be named. See https://graphql.org/learn/queries/#operation-name." }, "variables": { "description": "Optional. Values for GraphQL variables provided in this request.", "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } } }, "id": "ExecuteMutationRequest" }, "Empty": { "type": "object", "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "properties": {}, "id": "Empty" }, "PostgreSql": { "type": "object", "description": "Settings for PostgreSQL data source.", "properties": { "schemaValidation": { "enumDescriptions": [ "Unspecified SQL schema validation. Default to STRICT.", "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.", "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.", "Connect to the SQL database and validate that the SQL DDL has all the SQL resources used in the given Firebase SQL Connect Schema. Surface any missing resources as `FAILED_PRECONDITION` with an `IncompatibleSqlSchemaError` error detail. Succeed even if there are unknown tables and columns." ], "enum": [ "SQL_SCHEMA_VALIDATION_UNSPECIFIED", "NONE", "STRICT", "COMPATIBLE" ], "description": "Optional. Configure how much Postgresql schema validation to perform.", "type": "string" }, "ephemeral": { "description": "Output only. Ephemeral is true if this SQL Connect service is served from temporary in-memory emulation of Postgres. While Cloud SQL is being provisioned, the SQL Connect service provides the ephemeral service to help developers get started. Once the Cloud SQL is provisioned, SQL Connect service will transfer its data on a best-effort basis to the Cloud SQL instance. WARNING: Ephemeral data sources will expire after 24 hour. The data will be lost if they aren't transferred to the Cloud SQL instance. WARNING: When `ephemeral=true`, mutations to the database are not guaranteed to be durably persisted, even if an OK status code is returned. All or parts of the data may be lost or reverted to earlier versions.", "readOnly": true, "type": "boolean" }, "database": { "type": "string", "description": "Required. Name of the PostgreSQL database." }, "cloudSql": { "description": "Cloud SQL configurations.", "$ref": "CloudSqlInstance" }, "schemaMigration": { "enumDescriptions": [ "Unspecified SQL schema migration.", "Connect to the SQL database and identify any missing SQL resources used in the given Firebase SQL 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`." ], "enum": [ "SQL_SCHEMA_MIGRATION_UNSPECIFIED", "MIGRATE_COMPATIBLE" ], "description": "Optional. Configure how to perform Postgresql schema migration.", "type": "string" }, "unlinked": { "deprecated": true, "description": "No Postgres data source is linked. If set, don't allow `database` and `schema_validation` to be configured.", "type": "boolean" }, "schema": { "description": "Optional. User-configured PostgreSQL schema. Defaults to \"public\" if not specified.", "type": "string" } }, "id": "PostgreSql" }, "Status": { "id": "Status", "properties": { "code": { "type": "integer", "description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32" }, "message": { "type": "string", "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client." }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "type": "array", "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } } } }, "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "type": "object" }, "Connector": { "description": "Connector consists of a set of operations, i.e. queries and mutations.", "type": "object", "id": "Connector", "properties": { "etag": { "description": "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)", "readOnly": true, "type": "string" }, "annotations": { "description": "Optional. Stores small amounts of arbitrary data.", "type": "object", "additionalProperties": { "type": "string" } }, "source": { "description": "Required. The source files that comprise the connector.", "$ref": "Source" }, "uid": { "readOnly": true, "type": "string", "description": "Output only. System-assigned, unique identifier." }, "displayName": { "type": "string", "description": "Optional. Mutable human-readable name. 63 character limit." }, "clientCache": { "description": "Optional. The client cache settings of the connector.", "$ref": "ClientCache" }, "name": { "type": "string", "description": "Identifier. The relative resource name of the connector, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ```" }, "updateTime": { "format": "google-datetime", "description": "Output only. [Output only] Update time stamp.", "readOnly": true, "type": "string" }, "reconciling": { "readOnly": true, "type": "boolean", "description": "Output only. A field that if true, indicates that the system is working to compile and deploy the connector." }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional. Labels as key value pairs." }, "createTime": { "format": "google-datetime", "description": "Output only. [Output only] Create time stamp.", "readOnly": true, "type": "string" } } }, "ListSchemasResponse": { "id": "ListSchemasResponse", "properties": { "schemas": { "type": "array", "description": "The list of Schemas.", "items": { "$ref": "Schema" } }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, "unreachable": { "type": "array", "description": "Locations that could not be reached.", "items": { "type": "string" } } }, "description": "Message for response to listing Schemas. By default, `schemas.source` will not be included in the response. To specify the fields included in the response, the response field mask can be provided by using the query parameter `$fields` or the header `X-Goog-FieldMask`.", "type": "object" }, "Workaround": { "description": "Workaround provides suggestions to address errors and warnings.", "type": "object", "id": "Workaround", "properties": { "reason": { "description": "Why would this workaround address the error and warning.", "type": "string" }, "description": { "description": "Description of this workaround.", "type": "string" }, "replace": { "type": "string", "description": "A suggested code snippet to fix the error and warning." } } }, "ImpersonateRequest": { "type": "object", "description": "The Impersonate request to Firebase SQL Connect.", "properties": { "extensions": { "description": "Optional. Additional GraphQL request information.", "$ref": "GraphqlRequestExtensions" }, "operationName": { "description": "Required. The name of the GraphQL operation name. Required because all Connector operations must be named. See https://graphql.org/learn/queries/#operation-name.", "type": "string" }, "variables": { "description": "Optional. Values for GraphQL variables provided in this request.", "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object." } } }, "id": "ImpersonateRequest" }, "OperationMetadata": { "id": "OperationMetadata", "properties": { "apiVersion": { "description": "Output only. API version used to start the operation.", "readOnly": true, "type": "string" }, "createTime": { "readOnly": true, "type": "string", "description": "Output only. The time the operation was created.", "format": "google-datetime" }, "statusMessage": { "readOnly": true, "type": "string", "description": "Output only. Human-readable status of the operation, if any." }, "endTime": { "readOnly": true, "type": "string", "description": "Output only. The time the operation finished running.", "format": "google-datetime" }, "target": { "description": "Output only. Server-defined resource path for the target of the operation.", "readOnly": true, "type": "string" }, "verb": { "description": "Output only. Name of the verb executed by the operation.", "readOnly": true, "type": "string" }, "requestedCancellation": { "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", "readOnly": true, "type": "boolean" } }, "description": "Represents the metadata of the long-running operation. Note: This message is auto-generated by CCFE. CCFE's storage, called Resource Metadata Store (RMS), holds metadata about long-running operations (i.e. OperationMetadata) and resources (i.e. ResourceMetadata). OperationMetadata documents the status of the operation. See [CCFE documentation for sidechannel data](https://g3doc.corp.google.com/cloud/control2/g3doc/dev/codelab_extras/sidechannel.md?cl=head#sidechannel-data) and yaqs/4289526912465764352.", "type": "object" } }, "resources": { "projects": { "resources": { "locations": { "methods": { "list": { "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", "response": { "$ref": "ListLocationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "parameterOrder": [ "name" ], "path": "v1/{+name}/locations", "id": "firebasedataconnect.projects.locations.list", "parameters": { "pageSize": { "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query", "type": "integer", "format": "int32" }, "extraLocationTypes": { "location": "query", "type": "string", "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.", "repeated": true }, "name": { "description": "The resource that owns the locations collection, if applicable.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+$" }, "filter": { "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).", "location": "query", "type": "string" }, "pageToken": { "location": "query", "type": "string", "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page." } } }, "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", "httpMethod": "GET", "response": { "$ref": "Location" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets information about a location.", "parameterOrder": [ "name" ], "path": "v1/{+name}", "id": "firebasedataconnect.projects.locations.get", "parameters": { "name": { "description": "Resource name for the location.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" } } } }, "resources": { "operations": { "methods": { "list": { "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation's parent resource.", "required": true }, "filter": { "location": "query", "type": "string", "description": "The standard list filter." }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" }, "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" } }, "path": "v1/{+name}/operations", "id": "firebasedataconnect.projects.locations.operations.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", "httpMethod": "GET", "response": { "$ref": "ListOperationsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`." }, "delete": { "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "description": "The name of the operation resource to be deleted.", "required": true } }, "id": "firebasedataconnect.projects.locations.operations.delete", "path": "v1/{+name}", "parameterOrder": [ "name" ] }, "cancel": { "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "id": "firebasedataconnect.projects.locations.operations.cancel", "path": "v1/{+name}:cancel", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation resource to be cancelled.", "required": true } }, "parameterOrder": [ "name" ], "request": { "$ref": "CancelOperationRequest" } }, "get": { "parameterOrder": [ "name" ], "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "description": "The name of the operation resource.", "required": true } }, "id": "firebasedataconnect.projects.locations.operations.get", "path": "v1/{+name}", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } }, "services": { "methods": { "patch": { "parameterOrder": [ "name" ], "request": { "$ref": "Service" }, "path": "v1/{+name}", "id": "firebasedataconnect.projects.locations.services.patch", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "location": "path", "type": "string", "description": "Identifier. The relative resource name of the Firebase SQL Connect service, in the format: ``` projects/{project}/locations/{location}/services/{service} ``` Note that the service ID is specific to Firebase SQL Connect and does not correspond to any of the instance IDs of the underlying data source connections.", "required": true }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "validateOnly": { "description": "Optional. If set, validate the request and preview the Service, but do not actually update it.", "location": "query", "type": "boolean" }, "allowMissing": { "description": "Optional. If true and the Service is not found, a new Service will be created. In this case, `update_mask` is ignored.", "location": "query", "type": "boolean" }, "updateMask": { "location": "query", "type": "string", "description": "Optional. Field mask is used to specify the fields to be overwritten in the Service resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", "format": "google-fieldmask" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}", "httpMethod": "PATCH", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the parameters of a single Service." }, "delete": { "parameterOrder": [ "name" ], "path": "v1/{+name}", "id": "firebasedataconnect.projects.locations.services.delete", "parameters": { "allowMissing": { "description": "Optional. If true and the Service is not found, the request will succeed but no action will be taken on the server.", "location": "query", "type": "boolean" }, "etag": { "description": "Optional. The etag of the Service. If this is provided, it must match the server's etag.", "location": "query", "type": "string" }, "force": { "location": "query", "type": "boolean", "description": "Optional. If set to true, any child resources (i.e. Schema, SchemaRevisions, Connectors, and ConnectorRevisions) will also be deleted. Otherwise, the request will only work if the Service has no child resources." }, "name": { "description": "Required. The name of the service to delete, in the format: ``` projects/{project}/locations/{location}/services/{service} ```", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$" }, "requestId": { "location": "query", "type": "string", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)." }, "validateOnly": { "description": "Optional. If set, validate the request and preview the Service, but do not actually delete it.", "location": "query", "type": "boolean" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}", "httpMethod": "DELETE", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a single Service." }, "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}", "httpMethod": "GET", "response": { "$ref": "Service" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single Service.", "parameterOrder": [ "name" ], "path": "v1/{+name}", "id": "firebasedataconnect.projects.locations.services.get", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "location": "path", "type": "string", "description": "Required. The name of the service to retrieve, in the format: ``` projects/{project}/locations/{location}/services/{service} ```", "required": true } } }, "introspectGraphql": { "description": "Execute introspection query against the Firebase SQL Connect's generated GraphQL schema. GraphQL introspection query provides metadata such as what tables the schema have, what queries and mutations can be performed on the schema, and so on. Read more at https://graphql.org/learn/introspection. IntrospectGraphql can read schema metadata but cannot read rows from Cloud SQL instance, which can be done via ExecuteGraphqlRead.", "response": { "$ref": "GraphqlResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:introspectGraphql", "parameters": { "name": { "description": "Required. The relative resource name of Firebase SQL Connect service, in the format: ``` projects/{project}/locations/{location}/services/{service} ```", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "location": "path", "type": "string" } }, "id": "firebasedataconnect.projects.locations.services.introspectGraphql", "path": "v1/{+name}:introspectGraphql", "parameterOrder": [ "name" ], "request": { "$ref": "GraphqlRequest" } }, "executeGraphql": { "description": "Execute any GraphQL query or mutation against the Firebase SQL Connect's generated GraphQL schema. Grants full read and write access to the connected data sources. Note: Use introspection query to explore the generated GraphQL schema.", "response": { "$ref": "GraphqlResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:executeGraphql", "id": "firebasedataconnect.projects.locations.services.executeGraphql", "path": "v1/{+name}:executeGraphql", "parameters": { "name": { "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "location": "path", "type": "string", "description": "Required. The relative resource name of Firebase SQL Connect service, in the format: ``` projects/{project}/locations/{location}/services/{service} ```", "required": true } }, "parameterOrder": [ "name" ], "request": { "$ref": "GraphqlRequest" } }, "list": { "response": { "$ref": "ListServicesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists Services in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services", "httpMethod": "GET", "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "type": "string", "description": "Required. Value of parent.", "required": true }, "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default." }, "orderBy": { "description": "Optional. Hint for how to order the results.", "location": "query", "type": "string" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. A page token, received from a previous `ListServices` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListServices` must match the call that provided the page token." }, "filter": { "location": "query", "type": "string", "description": "Optional. Filtering results." } }, "path": "v1/{+parent}/services", "id": "firebasedataconnect.projects.locations.services.list", "parameterOrder": [ "parent" ] }, "executeGraphqlRead": { "response": { "$ref": "GraphqlResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Execute any GraphQL query against the Firebase SQL Connect's generated GraphQL schema. Grants full read to the connected data sources. `ExecuteGraphqlRead` is identical to `ExecuteGraphql` except it only accepts read-only query.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:executeGraphqlRead", "httpMethod": "POST", "parameters": { "name": { "description": "Required. The relative resource name of Firebase SQL Connect service, in the format: ``` projects/{project}/locations/{location}/services/{service} ```", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$" } }, "path": "v1/{+name}:executeGraphqlRead", "id": "firebasedataconnect.projects.locations.services.executeGraphqlRead", "parameterOrder": [ "name" ], "request": { "$ref": "GraphqlRequest" } }, "create": { "parameterOrder": [ "parent" ], "request": { "$ref": "Service" }, "parameters": { "serviceId": { "description": "Required. The ID to use for the service, which will become the final component of the service's resource name.", "location": "query", "type": "string" }, "requestId": { "location": "query", "type": "string", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)." }, "validateOnly": { "location": "query", "type": "boolean", "description": "Optional. If set, validate the request and preview the Service, but do not actually create it." }, "parent": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", "description": "Required. Value of parent.", "required": true } }, "id": "firebasedataconnect.projects.locations.services.create", "path": "v1/{+parent}/services", "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services", "description": "Creates a new Service in a given project and location.", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { "schemas": { "methods": { "get": { "description": "Gets details of a single Schema.", "response": { "$ref": "Schema" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/schemas/{schemasId}", "id": "firebasedataconnect.projects.locations.services.schemas.get", "path": "v1/{+name}", "parameters": { "name": { "description": "Required. The name of the schema to retrieve, in the format: ``` projects/{project}/locations/{location}/services/{service}/schemas/{schema} ```", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/schemas/[^/]+$" } }, "parameterOrder": [ "name" ] }, "patch": { "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the parameters of a single Schema, and creates a new SchemaRevision with the updated Schema.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/schemas/{schemasId}", "httpMethod": "PATCH", "parameters": { "allowMissing": { "description": "Optional. If true and the Schema is not found, a new Schema will be created. In this case, `update_mask` is ignored.", "location": "query", "type": "boolean" }, "updateMask": { "location": "query", "type": "string", "description": "Optional. Field mask is used to specify the fields to be overwritten in the Schema resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", "format": "google-fieldmask" }, "name": { "description": "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\".", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/schemas/[^/]+$" }, "requestId": { "location": "query", "type": "string", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)." }, "validateOnly": { "description": "Optional. If set, validate the request and preview the Schema, but do not actually update it.", "location": "query", "type": "boolean" } }, "path": "v1/{+name}", "id": "firebasedataconnect.projects.locations.services.schemas.patch", "parameterOrder": [ "name" ], "request": { "$ref": "Schema" } }, "delete": { "id": "firebasedataconnect.projects.locations.services.schemas.delete", "path": "v1/{+name}", "parameters": { "allowMissing": { "description": "Optional. If true and the Schema is not found, the request will succeed but no action will be taken on the server.", "location": "query", "type": "boolean" }, "etag": { "location": "query", "type": "string", "description": "Optional. The etag of the Schema. If this is provided, it must match the server's etag." }, "force": { "description": "Optional. If set to true, any child resources (i.e. SchemaRevisions) will also be deleted.", "location": "query", "type": "boolean" }, "name": { "description": "Required. The name of the schema to delete, in the format: ``` projects/{project}/locations/{location}/services/{service}/schemas/{schema} ```", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/schemas/[^/]+$", "location": "path", "type": "string" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "validateOnly": { "location": "query", "type": "boolean", "description": "Optional. If set, validate the request and preview the Schema, but do not actually delete it." } }, "parameterOrder": [ "name" ], "description": "Deletes a single Schema. Because the schema and connectors must be compatible at all times, if this is called while any connectors are active, this will result in an error.", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "DELETE", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/schemas/{schemasId}" }, "create": { "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/schemas", "description": "Creates a new Schema in a given project and location. Only creation of `schemas/main` is supported and calling create with any other schema ID will result in an error.", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "request": { "$ref": "Schema" }, "parameters": { "parent": { "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "location": "path", "type": "string", "description": "Required. Value for parent.", "required": true }, "schemaId": { "description": "Required. The ID to use for the schema, which will become the final component of the schema's resource name. Currently, only `main` is supported and any other schema ID will result in an error.", "location": "query", "type": "string" }, "requestId": { "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, "validateOnly": { "description": "Optional. If set, validate the request and preview the Schema, but do not actually update it.", "location": "query", "type": "boolean" } }, "id": "firebasedataconnect.projects.locations.services.schemas.create", "path": "v1/{+parent}/schemas" }, "list": { "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/schemas", "description": "Lists Schemas in a given project and location.", "response": { "$ref": "ListSchemasResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "id": "firebasedataconnect.projects.locations.services.schemas.list", "path": "v1/{+parent}/schemas", "parameters": { "parent": { "description": "Required. Value of parent.", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$" }, "pageSize": { "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", "location": "query", "type": "integer", "format": "int32" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. A page token, received from a previous `ListSchemas` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSchemas` must match the call that provided the page token." }, "filter": { "description": "Optional. Filtering results.", "location": "query", "type": "string" }, "orderBy": { "description": "Optional. Hint for how to order the results.", "location": "query", "type": "string" } } } } }, "connectors": { "methods": { "patch": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/connectors/{connectorsId}", "httpMethod": "PATCH", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates the parameters of a single Connector, and creates a new ConnectorRevision with the updated Connector. The operations are validated against and must be compatible with the live schema. If the operations and schema are not compatible or if the schema is not present, this will result in an error.", "parameterOrder": [ "name" ], "request": { "$ref": "Connector" }, "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/connectors/[^/]+$", "description": "Identifier. The relative resource name of the connector, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ```", "required": true }, "requestId": { "location": "query", "type": "string", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)." }, "validateOnly": { "description": "Optional. If set, validate the request and preview the Connector, but do not actually update it.", "location": "query", "type": "boolean" }, "updateMask": { "description": "Optional. Field mask is used to specify the fields to be overwritten in the Connector resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", "location": "query", "type": "string", "format": "google-fieldmask" }, "allowMissing": { "location": "query", "type": "boolean", "description": "Optional. If true and the Connector is not found, a new Connector will be created. In this case, `update_mask` is ignored." } }, "path": "v1/{+name}", "id": "firebasedataconnect.projects.locations.services.connectors.patch" }, "get": { "response": { "$ref": "Connector" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Gets details of a single Connector.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/connectors/{connectorsId}", "httpMethod": "GET", "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/connectors/[^/]+$", "description": "Required. The name of the connector to retrieve, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ```", "required": true } }, "path": "v1/{+name}", "id": "firebasedataconnect.projects.locations.services.connectors.get", "parameterOrder": [ "name" ] }, "executeMutation": { "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/connectors/[^/]+$", "description": "Required. The resource name of the connector to find the predefined mutation, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ```", "required": true } }, "path": "v1/{+name}:executeMutation", "id": "firebasedataconnect.projects.locations.services.connectors.executeMutation", "parameterOrder": [ "name" ], "request": { "$ref": "ExecuteMutationRequest" }, "response": { "$ref": "ExecuteMutationResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Execute a predefined mutation in a Connector.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/connectors/{connectorsId}:executeMutation", "httpMethod": "POST" }, "list": { "parameterOrder": [ "parent" ], "parameters": { "parent": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "description": "Required. Value of parent.", "required": true }, "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default." }, "orderBy": { "location": "query", "type": "string", "description": "Optional. Hint for how to order the results." }, "pageToken": { "description": "Optional. A page token, received from a previous `ListConnectors` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnectors` must match the call that provided the page token.", "location": "query", "type": "string" }, "filter": { "location": "query", "type": "string", "description": "Optional. Filtering results." } }, "path": "v1/{+parent}/connectors", "id": "firebasedataconnect.projects.locations.services.connectors.list", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/connectors", "httpMethod": "GET", "response": { "$ref": "ListConnectorsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists Connectors in a given project and location." }, "executeQuery": { "parameters": { "name": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/connectors/[^/]+$", "description": "Required. The resource name of the connector to find the predefined query, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ```", "required": true } }, "path": "v1/{+name}:executeQuery", "id": "firebasedataconnect.projects.locations.services.connectors.executeQuery", "parameterOrder": [ "name" ], "request": { "$ref": "ExecuteQueryRequest" }, "response": { "$ref": "ExecuteQueryResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Execute a predefined query in a Connector.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/connectors/{connectorsId}:executeQuery", "httpMethod": "POST" }, "create": { "description": "Creates a new Connector in a given project and location. The operations are validated against and must be compatible with the active schema. If the operations and schema are not compatible or if the schema is not present, this will result in an error.", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/connectors", "id": "firebasedataconnect.projects.locations.services.connectors.create", "path": "v1/{+parent}/connectors", "parameters": { "parent": { "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+$", "description": "Required. Value for parent.", "required": true }, "requestId": { "location": "query", "type": "string", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)." }, "validateOnly": { "description": "Optional. If set, validate the request and preview the Connector, but do not actually create it.", "location": "query", "type": "boolean" }, "connectorId": { "description": "Required. The ID to use for the connector, which will become the final component of the connector's resource name.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "request": { "$ref": "Connector" } }, "delete": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/connectors/{connectorsId}", "httpMethod": "DELETE", "response": { "$ref": "Operation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Deletes a single Connector.", "parameterOrder": [ "name" ], "parameters": { "allowMissing": { "location": "query", "type": "boolean", "description": "Optional. If true and the Connector is not found, the request will succeed but no action will be taken on the server." }, "etag": { "description": "Optional. The etag of the Connector. If this is provided, it must match the server's etag.", "location": "query", "type": "string" }, "force": { "description": "Optional. If set to true, any child resources (i.e. ConnectorRevisions) will also be deleted. Otherwise, the request will only work if the Connector has no child resources.", "location": "query", "type": "boolean" }, "name": { "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/connectors/[^/]+$", "location": "path", "type": "string", "description": "Required. The name of the connector to delete, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ```", "required": true }, "requestId": { "location": "query", "type": "string", "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)." }, "validateOnly": { "description": "Optional. If set, validate the request and preview the Connector, but do not actually delete it.", "location": "query", "type": "boolean" } }, "path": "v1/{+name}", "id": "firebasedataconnect.projects.locations.services.connectors.delete" }, "impersonateQuery": { "description": "Impersonate a query defined on a Firebase SQL Connect connector. It grants the admin SDK access to queries defined in the given connector. The caller can choose to impersonate a particular Firebase Auth user, or skip @auth completely.", "response": { "$ref": "GraphqlResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/connectors/{connectorsId}:impersonateQuery", "id": "firebasedataconnect.projects.locations.services.connectors.impersonateQuery", "path": "v1/{+name}:impersonateQuery", "parameters": { "name": { "description": "Required. The resource name of the connector to find the predefined query/mutation, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ```", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/connectors/[^/]+$" } }, "parameterOrder": [ "name" ], "request": { "$ref": "ImpersonateRequest" } }, "impersonateMutation": { "parameterOrder": [ "name" ], "request": { "$ref": "ImpersonateRequest" }, "id": "firebasedataconnect.projects.locations.services.connectors.impersonateMutation", "path": "v1/{+name}:impersonateMutation", "parameters": { "name": { "description": "Required. The resource name of the connector to find the predefined query/mutation, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ```", "required": true, "location": "path", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/connectors/[^/]+$" } }, "httpMethod": "POST", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/connectors/{connectorsId}:impersonateMutation", "description": "Impersonate a mutation defined on a Firebase SQL Connect connector. It grants the admin SDK access to mutations defined in the given connector. The caller can choose to impersonate a particular Firebase Auth user, or skip @auth completely.", "response": { "$ref": "GraphqlResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } } } } } } } } } }, "discoveryVersion": "v1", "version_module": true, "servicePath": "", "ownerName": "Google", "name": "firebasedataconnect", "basePath": "", "version": "v1", "protocol": "rest", "rootUrl": "https://firebasedataconnect.googleapis.com/", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "ownerDomain": "google.com", "parameters": { "alt": { "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "default": "json", "description": "Data format for response.", "type": "string", "location": "query" }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "type": "string", "location": "query" }, "quotaUser": { "type": "string", "location": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, "$.xgafv": { "type": "string", "location": "query", "description": "V1 error format.", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ] }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string", "location": "query" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "type": "string", "location": "query" }, "access_token": { "description": "OAuth access token.", "type": "string", "location": "query" }, "upload_protocol": { "type": "string", "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "callback": { "type": "string", "location": "query", "description": "JSONP" }, "key": { "type": "string", "location": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "type": "boolean", "location": "query", "default": "true" } }, "mtlsRootUrl": "https://firebasedataconnect.mtls.googleapis.com/", "description": "Firebase SQL Connect is a relational database service for mobile and web apps that lets you build and scale using a fully-managed PostgreSQL database powered by Cloud SQL. The REST API lets developers manage the connections to their database, change the schema of their database, and query the database.", "title": "Firebase Data Connect API", "batchPath": "batch", "revision": "20260426", "fullyEncodeReservedExpansion": true, "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "id": "firebasedataconnect:v1", "baseUrl": "https://firebasedataconnect.googleapis.com/", "kind": "discovery#restDescription" }