IndexApiClient Class

A client for interacting with ArangoDB Index endpoints, implementing IIndexApiClient.

Inheritance Hierarchy

SystemObject
ArangoDBNetStandardApiClientBase
ArangoDBNetStandard.IndexApiIndexApiClient

Namespace: ArangoDBNetStandard.IndexApi
Assembly: ArangoDBNetStandard (in ArangoDBNetStandard.dll) Version: 1.1.0

Syntax

public class IndexApiClient : ApiClientBase

Public Class IndexApiClient
	Inherits ApiClientBase

public ref class IndexApiClient : public ApiClientBase

type IndexApiClient =  
    class
        inherit ApiClientBase
    end

The IndexApiClient type exposes the following members.

Constructors

	Name	Description
	IndexApiClient(IApiClientTransport)	Creates an instance of IndexApiClient using the provided transport layer and the default JSON serialization.
	IndexApiClient(IApiClientTransport, IApiClientSerialization)	Creates an instance of IndexApiClient using the provided transport and serialization layers.

Methods

	Name	Description
	DeleteIndexAsync	Delete an index permanently.
	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.)
	GetAllCollectionIndexesAsync	Fetch the list of indexes for a collection.
	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.)
	GetIndexAsync	Fetches data about the specified index.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	PostIndexAsync
	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
	_client	The transport client used to communicate with the ArangoDB host.
	_indexApiPath	The root path of the API.