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

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

Calls CreateIndex.

Parameters:
Name Type Description
request google.firestore.admin.v1.ICreateIndexRequest

CreateIndexRequest message or plain object

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

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

Calls DeleteIndex.

Parameters:
Name Type Description
request google.firestore.admin.v1.IDeleteIndexRequest

DeleteIndexRequest message or plain object

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

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

Calls ExportDocuments.

Parameters:
Name Type Description
request google.firestore.admin.v1.IExportDocumentsRequest

ExportDocumentsRequest message or plain object

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

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

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

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

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

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

Calls ImportDocuments.

Parameters:
Name Type Description
request google.firestore.admin.v1.IImportDocumentsRequest

ImportDocumentsRequest message or plain object

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

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

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

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

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

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

Calls UpdateField.

Parameters:
Name Type Description
request google.firestore.admin.v1.IUpdateFieldRequest

UpdateFieldRequest message or plain object

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

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

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

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