Cloud Firestore API (firestore:v1)

▼ ▲ firestore.projects.databases.changeStreams.delete

Flat Path : v1/projects/{projectsId}/databases/{databasesId}/changeStreams/{changeStreamsId}

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/datastore

HTTP Method : DELETE

Path : v1/{+name}

Parameters :

name

Location : path

Required : Yes

Description : Required. The name of the change stream to delete. Format is `projects/{project}/databases/{database}/changeStreams/{change_stream}`.

Type : string

Pattern : ^projects/[^/]+/databases/[^/]+/changeStreams/[^/]+$

etag

Description : Optional. The etag of the change stream to delete. If this is not the current etag of the change stream, the deletion will fail.

Location : query

Type : string

Parameter Order : name

Description : Deletes a change stream.

▼ ▲ firestore.projects.databases.changeStreams.create

Flat Path : v1/projects/{projectsId}/databases/{databasesId}/changeStreams

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/datastore

Description : Creates a new change stream for the database.

Parameter Order : parent

HTTP Method : POST

Path : v1/{+parent}/changeStreams

Parameters :

changeStreamId

Description : Required. The ID to use for the change stream, which will become the final component of the change stream's resource name. This value should be 4-63 characters. Valid characters are lowercase letters, numbers, and hyphens. The first character must be a letter, and the last character must be a letter or a number.

Location : query

Type : string

parent

Location : path

Required : Yes

Type : string

Description : Required. The parent database to create the change stream for. Format is `projects/{project}/databases/{database}`.

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

▼ ▲ firestore.projects.databases.changeStreams.list

Description : Lists all change streams in a database.

Parameter Order : parent

HTTP Method : GET

Path : v1/{+parent}/changeStreams

Parameters :

parent

Required : Yes

Location : path

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

Description : Required. The parent database to list change streams from. Format is `projects/{project}/databases/{database}`.

Type : string

Flat Path : v1/projects/{projectsId}/databases/{databasesId}/changeStreams

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/datastore

▼ ▲ firestore.projects.databases.changeStreams.get

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/datastore

Flat Path : v1/projects/{projectsId}/databases/{databasesId}/changeStreams/{changeStreamsId}

Parameter Order : name

Path : v1/{+name}

Parameters :

name

Pattern : ^projects/[^/]+/databases/[^/]+/changeStreams/[^/]+$

Type : string

Description : Required. The name of the change stream to retrieve. Format is `projects/{project}/databases/{database}/changeStreams/{change_stream}`.

Required : Yes

Location : path

HTTP Method : GET

Description : Gets information about a change stream.

▼ ▲ firestore.projects.databases.documents.list

Parameters :

requestOptions.requestTags

Repeated : Yes

Type : string

Description : Optional. The request tags for the request.

Location : query

▼ ▲ firestore.projects.databases.documents.listDocuments

Parameters :

requestOptions.requestTags

Repeated : Yes

Type : string

Description : Optional. The request tags for the request.

Location : query

▼ ▲ firestore.projects.databases.documents.get

Parameters :

requestOptions.requestTags

Repeated : Yes

Description : Optional. The request tags for the request.

Location : query

Type : string

▼ ▲ firestore.projects.databases.documents.patch

Parameters :

requestOptions.requestTags

Repeated : Yes

Type : string

Description : Optional. The request tags for the request.

Location : query

▼ ▲ firestore.projects.databases.documents.createDocument

Parameters :

requestOptions.requestTags

Description : Optional. The request tags for the request.

Location : query

Type : string

Repeated : Yes

▼ ▲ firestore.projects.databases.documents.delete

Parameters :

requestOptions.requestTags

Type : string

Description : Optional. The request tags for the request.

Location : query

Repeated : Yes