Constructor
new DatastoreAdmin(rpcImpl, requestDelimitedopt, responseDelimitedopt)
Constructs a new DatastoreAdmin 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.datastore.admin.v1.ICreateIndexRequest |
CreateIndexRequest message or plain object |
callback |
google.datastore.admin.v1.DatastoreAdmin.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.datastore.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.datastore.admin.v1.IDeleteIndexRequest |
DeleteIndexRequest message or plain object |
callback |
google.datastore.admin.v1.DatastoreAdmin.DeleteIndexCallback |
Node-style callback called with the error, if any, and Operation |
Returns:
| Type | Description |
|---|---|
| undefined |
deleteIndex(request) → {Promise.<google.longrunning.Operation>}
Calls DeleteIndex.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.datastore.admin.v1.IDeleteIndexRequest |
DeleteIndexRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.longrunning.Operation> |
Promise |
exportEntities(request, callback) → {undefined}
Calls ExportEntities.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.datastore.admin.v1.IExportEntitiesRequest |
ExportEntitiesRequest message or plain object |
callback |
google.datastore.admin.v1.DatastoreAdmin.ExportEntitiesCallback |
Node-style callback called with the error, if any, and Operation |
Returns:
| Type | Description |
|---|---|
| undefined |
exportEntities(request) → {Promise.<google.longrunning.Operation>}
Calls ExportEntities.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.datastore.admin.v1.IExportEntitiesRequest |
ExportEntitiesRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.longrunning.Operation> |
Promise |
getIndex(request, callback) → {undefined}
Calls GetIndex.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.datastore.admin.v1.IGetIndexRequest |
GetIndexRequest message or plain object |
callback |
google.datastore.admin.v1.DatastoreAdmin.GetIndexCallback |
Node-style callback called with the error, if any, and Index |
Returns:
| Type | Description |
|---|---|
| undefined |
getIndex(request) → {Promise.<google.datastore.admin.v1.Index>}
Calls GetIndex.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.datastore.admin.v1.IGetIndexRequest |
GetIndexRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.datastore.admin.v1.Index> |
Promise |
importEntities(request, callback) → {undefined}
Calls ImportEntities.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.datastore.admin.v1.IImportEntitiesRequest |
ImportEntitiesRequest message or plain object |
callback |
google.datastore.admin.v1.DatastoreAdmin.ImportEntitiesCallback |
Node-style callback called with the error, if any, and Operation |
Returns:
| Type | Description |
|---|---|
| undefined |
importEntities(request) → {Promise.<google.longrunning.Operation>}
Calls ImportEntities.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.datastore.admin.v1.IImportEntitiesRequest |
ImportEntitiesRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.longrunning.Operation> |
Promise |
listIndexes(request, callback) → {undefined}
Calls ListIndexes.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.datastore.admin.v1.IListIndexesRequest |
ListIndexesRequest message or plain object |
callback |
google.datastore.admin.v1.DatastoreAdmin.ListIndexesCallback |
Node-style callback called with the error, if any, and ListIndexesResponse |
Returns:
| Type | Description |
|---|---|
| undefined |
listIndexes(request) → {Promise.<google.datastore.admin.v1.ListIndexesResponse>}
Calls ListIndexes.
Parameters:
| Name | Type | Description |
|---|---|---|
request |
google.datastore.admin.v1.IListIndexesRequest |
ListIndexesRequest message or plain object |
Returns:
| Type | Description |
|---|---|
| Promise.<google.datastore.admin.v1.ListIndexesResponse> |
Promise |
(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {DatastoreAdmin}
Creates new DatastoreAdmin service using the specified rpc implementation.
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 |
Returns:
| Type | Description |
|---|---|
| DatastoreAdmin |
RPC service. Useful where requests and/or responses are streamed. |
Type Definitions
CreateIndexCallback(error, responseopt)
Callback as used by 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 deleteIndex.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.longrunning.Operation |
<optional> |
Operation |
ExportEntitiesCallback(error, responseopt)
Callback as used by exportEntities.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.longrunning.Operation |
<optional> |
Operation |
GetIndexCallback(error, responseopt)
Callback as used by getIndex.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.datastore.admin.v1.Index |
<optional> |
Index |
ImportEntitiesCallback(error, responseopt)
Callback as used by importEntities.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.longrunning.Operation |
<optional> |
Operation |
ListIndexesCallback(error, responseopt)
Callback as used by listIndexes.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.datastore.admin.v1.ListIndexesResponse |
<optional> |
ListIndexesResponse |