Method: projects.locations.services.connectors.executeQuery
Stay organized with collections
Save and categorize content based on your preferences.
Execute a predefined query in a Connector.
HTTP request
POST https://firebasedataconnect.googleapis.com/v1beta/{name=projects/*/locations/*/services/*/connectors/*}:executeQuery
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. The resource name of the connector to find the predefined query, in the format:
projects/{project}/locations/{location}/services/{service}/connectors/{connector}
|
Request body
The request body contains data with the following structure:
| JSON representation |
{
"operationName": string,
"variables": {
object
}
} |
| Fields |
operationName |
string
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 |
object (Struct format)
Optional. Values for GraphQL variables provided in this request.
|
Response body
The connectors.executeQuery response from Firebase Data Connect.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"data": {
object
},
"errors": [
{
object (GraphqlError)
}
]
} |
| Fields |
data |
object (Struct format)
The result of executing the requested operation.
|
errors[] |
object (GraphqlError)
Errors of this response.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-20 UTC.
[null,null,["Last updated 2024-09-20 UTC."],[],[],null,["# Method: projects.locations.services.connectors.executeQuery\n\nExecute a predefined query in a Connector.\n\n### HTTP request\n\n`POST https://firebasedataconnect.googleapis.com/v1beta/{name=projects/*/locations/*/services/*/connectors/*}:executeQuery`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The resource name of the connector to find the predefined query, in the format: projects/{project}/locations/{location}/services/{service}/connectors/{connector} |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------|\n| ``` { \"operationName\": string, \"variables\": { object } } ``` |\n\n| Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `operationName` | `string` Required. The name of the GraphQL operation name. Required because all Connector operations must be named. See \u003chttps://graphql.org/learn/queries/#operation-name\u003e. |\n| `variables` | `object (`[Struct](https://protobuf.dev/reference/protobuf/google.protobuf/#struct)` format)` Optional. Values for GraphQL variables provided in this request. |\n\n### Response body\n\nThe connectors.executeQuery response from Firebase Data Connect.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------|\n| ``` { \"data\": { object }, \"errors\": [ { object (/docs/reference/data-connect/rest/v1beta/GraphqlError) } ] } ``` |\n\n| Fields ||\n|------------|------------------------------------------------------------------------------------------------------------------------------------------------|\n| `data` | `object (`[Struct](https://protobuf.dev/reference/protobuf/google.protobuf/#struct)` format)` The result of executing the requested operation. |\n| `errors[]` | `object (`[GraphqlError](/docs/reference/data-connect/rest/v1beta/GraphqlError)`)` Errors of this response. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/)."]]
