AdminApiClient Class |
A client for interacting with ArangoDB Admin API,
implementing IAdminApiClient.
Inheritance HierarchyNamespace: ArangoDBNetStandard.AdminApi
Assembly: ArangoDBNetStandard (in ArangoDBNetStandard.dll) Version: 1.1.0
SyntaxThe AdminApiClient type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | AdminApiClient(IApiClientTransport) |
Creates an instance of AdminApiClient
using the provided transport layer and the default JSON serialization.
|
| AdminApiClient(IApiClientTransport, IApiClientSerialization) |
Creates an instance of AdminApiClient
using the provided transport and serialization layers.
|
Methods| Name | Description | |
|---|---|---|
 | DeserializeJsonFromStreamT | (Inherited from ApiClientBase.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetApiErrorException |
Gets an ApiErrorException from the provided error response.
(Inherited from ApiClientBase.) |
| GetContentT | (Inherited from ApiClientBase.) |
| GetContentStringT | (Inherited from ApiClientBase.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetLogsAsync |
Retrieves log messages from the server.
GET /_admin/log/entries
Works on ArangoDB 3.8 or later.
|
| GetServerEngineTypeAsync |
Retrieves the server database engine type.
GET /_api/engine
|
| GetServerIdAsync |
Retrieves the internal id of the server.
The method will fail if the server is not running in cluster mode.
GET /_admin/server/id
|
| GetServerRoleAsync |
Retrieves the role of the server in a cluster.
GET /_admin/server/role
|
| GetServerVersionAsync |
Retrieves the server version.
GET /_api/version
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| PostReloadRoutingInfoAsync |
Reloads the routing table.
POST /_admin/routing/reload
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| ValidateDocumentId |
Checks whether the provided document ID is in the correct form
of "{collection}/{key}".
(Inherited from ApiClientBase.) |
Fields| Name | Description | |
|---|---|---|
 | _adminApiPath |
The root path of the API.
|
| _client |
The transport client used to communicate with the ArangoDB host.
|
See Also