FirestoreAdmin

google .firestore .admin .v1. FirestoreAdmin

Represents a FirestoreAdmin

Constructor

new FirestoreAdmin(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new FirestoreAdmin service.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Extends

$protobuf.rpc.Service

Methods

createIndex(request, callback) → {undefined}

Calls CreateIndex.

Parameters:

Name	Type	Description
`request`	google.firestore.admin.v1.ICreateIndexRequest	CreateIndexRequest message or plain object
`callback`	google.firestore.admin.v1.FirestoreAdmin.CreateIndexCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

createIndex(request) → {Promise.<google.longrunning.Operation>}

Calls CreateIndex.

Parameters:

Name	Type	Description
`request`	google.firestore.admin.v1.ICreateIndexRequest	CreateIndexRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

deleteIndex(request, callback) → {undefined}

Calls DeleteIndex.

Parameters:

Name	Type	Description
`request`	google.firestore.admin.v1.IDeleteIndexRequest	DeleteIndexRequest message or plain object
`callback`	google.firestore.admin.v1.FirestoreAdmin.DeleteIndexCallback	Node-style callback called with the error, if any, and Empty

Returns:

Type	Description
undefined

deleteIndex(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteIndex.

Parameters:

Name	Type	Description
`request`	google.firestore.admin.v1.IDeleteIndexRequest	DeleteIndexRequest message or plain object

Returns:

Type	Description
Promise.<google.protobuf.Empty>	Promise

exportDocuments(request, callback) → {undefined}

Calls ExportDocuments.

Parameters:

Name	Type	Description
`request`	google.firestore.admin.v1.IExportDocumentsRequest	ExportDocumentsRequest message or plain object
`callback`	google.firestore.admin.v1.FirestoreAdmin.ExportDocumentsCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

exportDocuments(request) → {Promise.<google.longrunning.Operation>}

Calls ExportDocuments.

Parameters:

Name	Type	Description
`request`	google.firestore.admin.v1.IExportDocumentsRequest	ExportDocumentsRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

getDatabase(request, callback) → {undefined}

Calls GetDatabase.

Parameters:

Name	Type	Description
`request`	google.firestore.admin.v1.IGetDatabaseRequest	GetDatabaseRequest message or plain object
`callback`	google.firestore.admin.v1.FirestoreAdmin.GetDatabaseCallback	Node-style callback called with the error, if any, and Database

Returns:

Type	Description
undefined

getDatabase(request) → {Promise.<google.firestore.admin.v1.Database>}

Calls GetDatabase.

Parameters:

Name	Type	Description
`request`	google.firestore.admin.v1.IGetDatabaseRequest	GetDatabaseRequest message or plain object

Returns:

Type	Description
Promise.<google.firestore.admin.v1.Database>	Promise

getField(request, callback) → {undefined}

Calls GetField.

Parameters:

Name	Type	Description
`request`	google.firestore.admin.v1.IGetFieldRequest	GetFieldRequest message or plain object
`callback`	google.firestore.admin.v1.FirestoreAdmin.GetFieldCallback	Node-style callback called with the error, if any, and Field

Returns:

Type	Description
undefined

getField(request) → {Promise.<google.firestore.admin.v1.Field>}

Calls GetField.

Parameters:

Name	Type	Description
`request`	google.firestore.admin.v1.IGetFieldRequest	GetFieldRequest message or plain object

Returns:

Type	Description
Promise.<google.firestore.admin.v1.Field>	Promise

getIndex(request, callback) → {undefined}

Calls GetIndex.

Parameters:

Name	Type	Description
`request`	google.firestore.admin.v1.IGetIndexRequest	GetIndexRequest message or plain object
`callback`	google.firestore.admin.v1.FirestoreAdmin.GetIndexCallback	Node-style callback called with the error, if any, and Index

Returns:

Type	Description
undefined

getIndex(request) → {Promise.<google.firestore.admin.v1.Index>}

Calls GetIndex.

Parameters:

Name	Type	Description
`request`	google.firestore.admin.v1.IGetIndexRequest	GetIndexRequest message or plain object

Returns:

Type	Description
Promise.<google.firestore.admin.v1.Index>	Promise

importDocuments(request, callback) → {undefined}

Calls ImportDocuments.

Parameters:

Name	Type	Description
`request`	google.firestore.admin.v1.IImportDocumentsRequest	ImportDocumentsRequest message or plain object
`callback`	google.firestore.admin.v1.FirestoreAdmin.ImportDocumentsCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

importDocuments(request) → {Promise.<google.longrunning.Operation>}

Calls ImportDocuments.

Parameters:

Name	Type	Description
`request`	google.firestore.admin.v1.IImportDocumentsRequest	ImportDocumentsRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

listDatabases(request, callback) → {undefined}

Calls ListDatabases.

Parameters:

Name	Type	Description
`request`	google.firestore.admin.v1.IListDatabasesRequest	ListDatabasesRequest message or plain object
`callback`	google.firestore.admin.v1.FirestoreAdmin.ListDatabasesCallback	Node-style callback called with the error, if any, and ListDatabasesResponse

Returns:

Type	Description
undefined

listDatabases(request) → {Promise.<google.firestore.admin.v1.ListDatabasesResponse>}

Calls ListDatabases.

Parameters:

Name	Type	Description
`request`	google.firestore.admin.v1.IListDatabasesRequest	ListDatabasesRequest message or plain object

Returns:

Type	Description
Promise.<google.firestore.admin.v1.ListDatabasesResponse>	Promise

listFields(request, callback) → {undefined}

Calls ListFields.

Parameters:

Name	Type	Description
`request`	google.firestore.admin.v1.IListFieldsRequest	ListFieldsRequest message or plain object
`callback`	google.firestore.admin.v1.FirestoreAdmin.ListFieldsCallback	Node-style callback called with the error, if any, and ListFieldsResponse

Returns:

Type	Description
undefined

listFields(request) → {Promise.<google.firestore.admin.v1.ListFieldsResponse>}

Calls ListFields.

Parameters:

Name	Type	Description
`request`	google.firestore.admin.v1.IListFieldsRequest	ListFieldsRequest message or plain object

Returns:

Type	Description
Promise.<google.firestore.admin.v1.ListFieldsResponse>	Promise

listIndexes(request, callback) → {undefined}

Calls ListIndexes.

Parameters:

Name	Type	Description
`request`	google.firestore.admin.v1.IListIndexesRequest	ListIndexesRequest message or plain object
`callback`	google.firestore.admin.v1.FirestoreAdmin.ListIndexesCallback	Node-style callback called with the error, if any, and ListIndexesResponse

Returns:

Type	Description
undefined

listIndexes(request) → {Promise.<google.firestore.admin.v1.ListIndexesResponse>}

Calls ListIndexes.

Parameters:

Name	Type	Description
`request`	google.firestore.admin.v1.IListIndexesRequest	ListIndexesRequest message or plain object

Returns:

Type	Description
Promise.<google.firestore.admin.v1.ListIndexesResponse>	Promise

updateDatabase(request, callback) → {undefined}

Calls UpdateDatabase.

Parameters:

Name	Type	Description
`request`	google.firestore.admin.v1.IUpdateDatabaseRequest	UpdateDatabaseRequest message or plain object
`callback`	google.firestore.admin.v1.FirestoreAdmin.UpdateDatabaseCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

updateDatabase(request) → {Promise.<google.longrunning.Operation>}

Calls UpdateDatabase.

Parameters:

Name	Type	Description
`request`	google.firestore.admin.v1.IUpdateDatabaseRequest	UpdateDatabaseRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

updateField(request, callback) → {undefined}

Calls UpdateField.

Parameters:

Name	Type	Description
`request`	google.firestore.admin.v1.IUpdateFieldRequest	UpdateFieldRequest message or plain object
`callback`	google.firestore.admin.v1.FirestoreAdmin.UpdateFieldCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

updateField(request) → {Promise.<google.longrunning.Operation>}

Calls UpdateField.

Parameters:

Name	Type	Description
`request`	google.firestore.admin.v1.IUpdateFieldRequest	UpdateFieldRequest message or plain object

Returns:

Type	Description
Promise.<google.longrunning.Operation>	Promise

Type Definitions

CreateIndexCallback(error, responseopt)

Callback as used by google.firestore.admin.v1.FirestoreAdmin#createIndex.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

DeleteIndexCallback(error, responseopt)

Callback as used by google.firestore.admin.v1.FirestoreAdmin#deleteIndex.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.protobuf.Empty	<optional>	Empty

ExportDocumentsCallback(error, responseopt)

Callback as used by google.firestore.admin.v1.FirestoreAdmin#exportDocuments.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

GetDatabaseCallback(error, responseopt)

Callback as used by google.firestore.admin.v1.FirestoreAdmin#getDatabase.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.firestore.admin.v1.Database	<optional>	Database

GetFieldCallback(error, responseopt)

Callback as used by google.firestore.admin.v1.FirestoreAdmin#getField.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.firestore.admin.v1.Field	<optional>	Field

GetIndexCallback(error, responseopt)

Callback as used by google.firestore.admin.v1.FirestoreAdmin#getIndex.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.firestore.admin.v1.Index	<optional>	Index

ImportDocumentsCallback(error, responseopt)

Callback as used by google.firestore.admin.v1.FirestoreAdmin#importDocuments.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

ListDatabasesCallback(error, responseopt)

Callback as used by google.firestore.admin.v1.FirestoreAdmin#listDatabases.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.firestore.admin.v1.ListDatabasesResponse	<optional>	ListDatabasesResponse

ListFieldsCallback(error, responseopt)

Callback as used by google.firestore.admin.v1.FirestoreAdmin#listFields.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.firestore.admin.v1.ListFieldsResponse	<optional>	ListFieldsResponse

ListIndexesCallback(error, responseopt)

Callback as used by google.firestore.admin.v1.FirestoreAdmin#listIndexes.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.firestore.admin.v1.ListIndexesResponse	<optional>	ListIndexesResponse

UpdateDatabaseCallback(error, responseopt)

Callback as used by google.firestore.admin.v1.FirestoreAdmin#updateDatabase.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

UpdateFieldCallback(error, responseopt)

Callback as used by google.firestore.admin.v1.FirestoreAdmin#updateField.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation