Firebase Data Connect API (firebasedataconnect:v1beta)

2024-09-26

25 new methods | New API

Additions

    Methods
  • firebasedataconnect.projects.locations.list

      Path: v1beta/{+name}/locations

      Flat Path: v1beta/projects/{projectsId}/locations

      HTTP Method: GET

      Parameters:

        name

          Description: The resource that owns the locations collection, if applicable.

          Pattern: ^projects/[^/]+$

          Location: path

          Required: Yes

          Type: string

        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

        pageSize

          Description: The maximum number of results to return. If not set, the service selects a default.

          Location: query

          Type: integer

          Format: int32

        pageToken

          Description: A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.

          Location: query

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Lists information about the supported locations for this service.

  • firebasedataconnect.projects.locations.get

      Path: v1beta/{+name}

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}

      HTTP Method: GET

      Parameters:

        name

          Description: Resource name for the location.

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Gets information about a location.

  • firebasedataconnect.projects.locations.operations.list

      Path: v1beta/{+name}/operations

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/operations

      HTTP Method: GET

      Parameters:

        name

          Description: The name of the operation's parent resource.

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Location: path

          Required: Yes

          Type: string

        filter

          Description: The standard list filter.

          Location: query

          Type: string

        pageSize

          Description: The standard list page size.

          Location: query

          Type: integer

          Format: int32

        pageToken

          Description: The standard list page token.

          Location: query

          Type: string

      Parameter Order: name

      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`.

  • firebasedataconnect.projects.locations.operations.get

      Path: v1beta/{+name}

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

      HTTP Method: GET

      Parameters:

        name

          Description: The name of the operation resource.

          Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      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.

  • firebasedataconnect.projects.locations.operations.delete

      Path: v1beta/{+name}

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}

      HTTP Method: DELETE

      Parameters:

        name

          Description: The name of the operation resource to be deleted.

          Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      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`.

  • firebasedataconnect.projects.locations.operations.cancel

      Path: v1beta/{+name}:cancel

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel

      HTTP Method: POST

      Parameters:

        name

          Description: The name of the operation resource to be cancelled.

          Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      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`.

  • firebasedataconnect.projects.locations.services.executeGraphql

      Path: v1beta/{+name}:executeGraphql

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:executeGraphql

      HTTP Method: POST

      Parameters:

        name

          Description: Required. The relative resource name of Firebase Data Connect service, in the format: ``` projects/{project}/locations/{location}/services/{service} ```

          Pattern: ^projects/[^/]+/locations/[^/]+/services/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Execute any GraphQL query and mutation against the Firebase Data 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.

  • firebasedataconnect.projects.locations.services.executeGraphqlRead

      Path: v1beta/{+name}:executeGraphqlRead

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}:executeGraphqlRead

      HTTP Method: POST

      Parameters:

        name

          Description: Required. The relative resource name of Firebase Data Connect service, in the format: ``` projects/{project}/locations/{location}/services/{service} ```

          Pattern: ^projects/[^/]+/locations/[^/]+/services/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Execute any GraphQL query against the Firebase Data 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.

  • firebasedataconnect.projects.locations.services.list

      Path: v1beta/{+parent}/services

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/services

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. Value of parent.

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Location: path

          Required: Yes

          Type: string

        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

          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.

          Location: query

          Type: string

        filter

          Description: Optional. Filtering results.

          Location: query

          Type: string

        orderBy

          Description: Optional. Hint for how to order the results.

          Location: query

          Type: string

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Lists Services in a given project and location.

  • firebasedataconnect.projects.locations.services.get

      Path: v1beta/{+name}

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The name of the service to retrieve, in the format: ``` projects/{project}/locations/{location}/services/{service} ```

          Pattern: ^projects/[^/]+/locations/[^/]+/services/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Gets details of a single Service.

  • firebasedataconnect.projects.locations.services.create

      Path: v1beta/{+parent}/services

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/services

      HTTP Method: POST

      Parameters:

        parent

          Description: Required. Value of parent.

          Pattern: ^projects/[^/]+/locations/[^/]+$

          Location: path

          Required: Yes

          Type: string

        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

          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 create it.

          Location: query

          Type: boolean

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Creates a new Service in a given project and location.

  • firebasedataconnect.projects.locations.services.patch

      Path: v1beta/{+name}

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}

      HTTP Method: PATCH

      Parameters:

        name

          Description: Identifier. The relative resource name of the Firebase Data Connect service, in the format: ``` projects/{project}/locations/{location}/services/{service} ``` Note that the service ID is specific to Firebase Data Connect and does not correspond to any of the instance IDs of the underlying data source connections.

          Pattern: ^projects/[^/]+/locations/[^/]+/services/[^/]+$

          Location: path

          Required: Yes

          Type: string

        updateMask

          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.

          Location: query

          Type: string

          Format: google-fieldmask

        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

        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

        validateOnly

          Description: Optional. If set, validate the request and preview the Service, but do not actually update it.

          Location: query

          Type: boolean

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Updates the parameters of a single Service.

  • firebasedataconnect.projects.locations.services.delete

      Path: v1beta/{+name}

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}

      HTTP Method: DELETE

      Parameters:

        name

          Description: Required. The name of the service to delete, in the format: ``` projects/{project}/locations/{location}/services/{service} ```

          Pattern: ^projects/[^/]+/locations/[^/]+/services/[^/]+$

          Location: path

          Required: Yes

          Type: string

        force

          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.

          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

        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

        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

        validateOnly

          Description: Optional. If set, validate the request and preview the Service, but do not actually delete it.

          Location: query

          Type: boolean

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Deletes a single Service.

  • firebasedataconnect.projects.locations.services.connectors.executeQuery

      Path: v1beta/{+name}:executeQuery

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/connectors/{connectorsId}:executeQuery

      HTTP Method: POST

      Parameters:

        name

          Description: Required. The resource name of the connector to find the predefined query, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ```

          Pattern: ^projects/[^/]+/locations/[^/]+/services/[^/]+/connectors/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Execute a predefined query in a Connector.

  • firebasedataconnect.projects.locations.services.connectors.executeMutation

      Path: v1beta/{+name}:executeMutation

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/connectors/{connectorsId}:executeMutation

      HTTP Method: POST

      Parameters:

        name

          Description: Required. The resource name of the connector to find the predefined mutation, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ```

          Pattern: ^projects/[^/]+/locations/[^/]+/services/[^/]+/connectors/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Execute a predefined mutation in a Connector.

  • firebasedataconnect.projects.locations.services.connectors.list

      Path: v1beta/{+parent}/connectors

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/connectors

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. Value of parent.

          Pattern: ^projects/[^/]+/locations/[^/]+/services/[^/]+$

          Location: path

          Required: Yes

          Type: string

        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

          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

          Description: Optional. Filtering results.

          Location: query

          Type: string

        orderBy

          Description: Optional. Hint for how to order the results.

          Location: query

          Type: string

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Lists Connectors in a given project and location.

  • firebasedataconnect.projects.locations.services.connectors.get

      Path: v1beta/{+name}

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/connectors/{connectorsId}

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The name of the connector to retrieve, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ```

          Pattern: ^projects/[^/]+/locations/[^/]+/services/[^/]+/connectors/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Gets details of a single Connector.

  • firebasedataconnect.projects.locations.services.connectors.create

      Path: v1beta/{+parent}/connectors

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/connectors

      HTTP Method: POST

      Parameters:

        parent

          Description: Required. Value for parent.

          Pattern: ^projects/[^/]+/locations/[^/]+/services/[^/]+$

          Location: path

          Required: Yes

          Type: string

        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

        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 Connector, but do not actually create it.

          Location: query

          Type: boolean

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      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.

  • firebasedataconnect.projects.locations.services.connectors.patch

      Path: v1beta/{+name}

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/connectors/{connectorsId}

      HTTP Method: PATCH

      Parameters:

        name

          Description: Identifier. The relative resource name of the connector, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ```

          Pattern: ^projects/[^/]+/locations/[^/]+/services/[^/]+/connectors/[^/]+$

          Location: path

          Required: Yes

          Type: string

        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

        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

        allowMissing

          Description: Optional. If true and the Connector is not found, a new Connector will be created. In this case, `update_mask` is ignored.

          Location: query

          Type: boolean

        validateOnly

          Description: Optional. If set, validate the request and preview the Connector, but do not actually update it.

          Location: query

          Type: boolean

      Parameter Order: name

      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.

  • firebasedataconnect.projects.locations.services.connectors.delete

      Path: v1beta/{+name}

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/connectors/{connectorsId}

      HTTP Method: DELETE

      Parameters:

        name

          Description: Required. The name of the connector to delete, in the format: ``` projects/{project}/locations/{location}/services/{service}/connectors/{connector} ```

          Pattern: ^projects/[^/]+/locations/[^/]+/services/[^/]+/connectors/[^/]+$

          Location: path

          Required: Yes

          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

        etag

          Description: Optional. The etag of the Connector. If this is provided, it must match the server's etag.

          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 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

        allowMissing

          Description: Optional. If true and the Connector is not found, the request will succeed but no action will be taken on the server.

          Location: query

          Type: boolean

        validateOnly

          Description: Optional. If set, validate the request and preview the Connector, but do not actually delete it.

          Location: query

          Type: boolean

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Deletes a single Connector.

  • firebasedataconnect.projects.locations.services.schemas.get

      Path: v1beta/{+name}

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/schemas/{schemasId}

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The name of the schema to retrieve, in the format: ``` projects/{project}/locations/{location}/services/{service}/schemas/{schema} ```

          Pattern: ^projects/[^/]+/locations/[^/]+/services/[^/]+/schemas/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Gets details of a single Schema.

  • firebasedataconnect.projects.locations.services.schemas.list

      Path: v1beta/{+parent}/schemas

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/schemas

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. Value of parent.

          Pattern: ^projects/[^/]+/locations/[^/]+/services/[^/]+$

          Location: path

          Required: Yes

          Type: string

        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

          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.

          Location: query

          Type: string

        filter

          Description: Optional. Filtering results.

          Location: query

          Type: string

        orderBy

          Description: Optional. Hint for how to order the results.

          Location: query

          Type: string

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Lists Schemas in a given project and location. Note that only `schemas/main` is supported, so this will always return at most one Schema.

  • firebasedataconnect.projects.locations.services.schemas.create

      Path: v1beta/{+parent}/schemas

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/schemas

      HTTP Method: POST

      Parameters:

        parent

          Description: Required. Value for parent.

          Pattern: ^projects/[^/]+/locations/[^/]+/services/[^/]+$

          Location: path

          Required: Yes

          Type: string

        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

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      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.

  • firebasedataconnect.projects.locations.services.schemas.patch

      Path: v1beta/{+name}

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/schemas/{schemasId}

      HTTP Method: PATCH

      Parameters:

        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".

          Pattern: ^projects/[^/]+/locations/[^/]+/services/[^/]+/schemas/[^/]+$

          Location: path

          Required: Yes

          Type: string

        updateMask

          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.

          Location: query

          Type: string

          Format: google-fieldmask

        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

        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

        validateOnly

          Description: Optional. If set, validate the request and preview the Schema, but do not actually update it.

          Location: query

          Type: boolean

      Parameter Order: name

      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.

  • firebasedataconnect.projects.locations.services.schemas.delete

      Path: v1beta/{+name}

      Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/schemas/{schemasId}

      HTTP Method: DELETE

      Parameters:

        name

          Description: Required. The name of the schema to delete, in the format: ``` projects/{project}/locations/{location}/services/{service}/schemas/{schema} ```

          Pattern: ^projects/[^/]+/locations/[^/]+/services/[^/]+/schemas/[^/]+$

          Location: path

          Required: Yes

          Type: string

        force

          Description: Optional. If set to true, any child resources (i.e. SchemaRevisions) will also be deleted.

          Location: query

          Type: boolean

        etag

          Description: Optional. The etag of the Schema. If this is provided, it must match the server's etag.

          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 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

        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

        validateOnly

          Description: Optional. If set, validate the request and preview the Schema, but do not actually delete it.

          Location: query

          Type: boolean

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

      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.