You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/firebasedataconnect_v1.projects.locations.html
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -135,7 +135,7 @@ <h3>Method Details</h3>
135
135
136
136
Args:
137
137
name: string, The resource that owns the locations collection, if applicable. (required)
138
-
extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
138
+
extraLocationTypes: string, Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. (repeated)
139
139
filter: string, 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).
140
140
pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
141
141
pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
<pclass="firstline">Impersonate a mutation defined on a Firebase Data 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.</p>
<pclass="firstline">Impersonate a query defined on a Firebase Data 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.</p>
<pre>Impersonate a mutation defined on a Firebase Data 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.
365
+
366
+
Args:
367
+
name: string, 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)
368
+
body: object, The request body.
369
+
The object takes the form of:
370
+
371
+
{ # The Impersonate request to Firebase Data Connect.
372
+
"extensions": { # GraphqlRequestExtensions contains additional information of `GraphqlRequest`. # Optional. Additional GraphQL request information.
373
+
"impersonate": { # Impersonation configures the Firebase Auth context to impersonate. # 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.
374
+
"authClaims": { # 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}
375
+
"a_key": "", # Properties of the object.
376
+
},
377
+
"includeDebugDetails": True or False, # Optional. If set, include debug details in GraphQL error extensions.
378
+
"unauthenticated": True or False, # Evaluate the auth policy as an unauthenticated request. Can only be set to true.
379
+
},
380
+
},
381
+
"operationName": "A 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.
382
+
"variables": { # Optional. Values for GraphQL variables provided in this request.
383
+
"a_key": "", # Properties of the object.
384
+
},
385
+
}
386
+
387
+
x__xgafv: string, V1 error format.
388
+
Allowed values
389
+
1 - v1 error format
390
+
2 - v2 error format
391
+
392
+
Returns:
393
+
An object of the form:
394
+
395
+
{ # The GraphQL response from Firebase Data Connect. It strives to match the GraphQL over HTTP spec. Note: Firebase Data Connect always responds with `Content-Type: application/json`. https://github.com/graphql/graphql-over-http/blob/main/spec/GraphQLOverHTTP.md#body
396
+
"data": { # 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)
397
+
"a_key": "", # Properties of the object.
398
+
},
399
+
"errors": [ # 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.
400
+
{ # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql` and `ExecuteGraphqlRead` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation` and `ExecuteQuery` all return Code.OK with a list of `GraphqlError` in response body.
401
+
"extensions": { # GraphqlErrorExtensions contains additional information of `GraphqlError`. # Additional error information.
402
+
"code": "A String", # Maps to canonical gRPC codes. If not specified, it represents `Code.INTERNAL`.
403
+
"debugDetails": "A String", # 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`.
404
+
"file": "A String", # The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`.
405
+
"resource": "A String", # Distinguish which schema or connector the error originates from. It should be set on errors from control plane APIs (e.g. `UpdateSchema`, `UpdateConnector`).
406
+
},
407
+
"locations": [ # 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`, `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.
408
+
{ # SourceLocation references a location in a GraphQL source.
409
+
"column": 42, # Column number starting at 1.
410
+
"line": 42, # Line number starting at 1.
411
+
},
412
+
],
413
+
"message": "A String", # The detailed error message. The message should help developer understand the underlying problem without leaking internal data.
414
+
"path": [ # 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.
<pre>Impersonate a query defined on a Firebase Data 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.
425
+
426
+
Args:
427
+
name: string, 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)
428
+
body: object, The request body.
429
+
The object takes the form of:
430
+
431
+
{ # The Impersonate request to Firebase Data Connect.
432
+
"extensions": { # GraphqlRequestExtensions contains additional information of `GraphqlRequest`. # Optional. Additional GraphQL request information.
433
+
"impersonate": { # Impersonation configures the Firebase Auth context to impersonate. # 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.
434
+
"authClaims": { # 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}
435
+
"a_key": "", # Properties of the object.
436
+
},
437
+
"includeDebugDetails": True or False, # Optional. If set, include debug details in GraphQL error extensions.
438
+
"unauthenticated": True or False, # Evaluate the auth policy as an unauthenticated request. Can only be set to true.
439
+
},
440
+
},
441
+
"operationName": "A 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.
442
+
"variables": { # Optional. Values for GraphQL variables provided in this request.
443
+
"a_key": "", # Properties of the object.
444
+
},
445
+
}
446
+
447
+
x__xgafv: string, V1 error format.
448
+
Allowed values
449
+
1 - v1 error format
450
+
2 - v2 error format
451
+
452
+
Returns:
453
+
An object of the form:
454
+
455
+
{ # The GraphQL response from Firebase Data Connect. It strives to match the GraphQL over HTTP spec. Note: Firebase Data Connect always responds with `Content-Type: application/json`. https://github.com/graphql/graphql-over-http/blob/main/spec/GraphQLOverHTTP.md#body
456
+
"data": { # 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)
457
+
"a_key": "", # Properties of the object.
458
+
},
459
+
"errors": [ # 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.
460
+
{ # GraphqlError conforms to the GraphQL error spec. https://spec.graphql.org/draft/#sec-Errors Firebase Data Connect API surfaces `GraphqlError` in various APIs: - Upon compile error, `UpdateSchema` and `UpdateConnector` return Code.Invalid_Argument with a list of `GraphqlError` in error details. - Upon query compile error, `ExecuteGraphql` and `ExecuteGraphqlRead` return Code.OK with a list of `GraphqlError` in response body. - Upon query execution error, `ExecuteGraphql`, `ExecuteGraphqlRead`, `ExecuteMutation` and `ExecuteQuery` all return Code.OK with a list of `GraphqlError` in response body.
461
+
"extensions": { # GraphqlErrorExtensions contains additional information of `GraphqlError`. # Additional error information.
462
+
"code": "A String", # Maps to canonical gRPC codes. If not specified, it represents `Code.INTERNAL`.
463
+
"debugDetails": "A String", # 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`.
464
+
"file": "A String", # The source file name where the error occurred. Included only for `UpdateSchema` and `UpdateConnector`, it corresponds to `File.path` of the provided `Source`.
465
+
"resource": "A String", # Distinguish which schema or connector the error originates from. It should be set on errors from control plane APIs (e.g. `UpdateSchema`, `UpdateConnector`).
466
+
},
467
+
"locations": [ # 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`, `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.
468
+
{ # SourceLocation references a location in a GraphQL source.
469
+
"column": 42, # Column number starting at 1.
470
+
"line": 42, # Line number starting at 1.
471
+
},
472
+
],
473
+
"message": "A String", # The detailed error message. The message should help developer understand the underlying problem without leaking internal data.
474
+
"path": [ # 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.
0 commit comments