CollectionsApi
Summary
| Members | Descriptions |
|---|---|
| It returns a list of all the collections in the database. |
| It takes a |
| This function will return a collection object from the API. |
| This function will return a StatsDto object that contains the stats for the collection specified in the collectionName parameter. |
| This function will return a list of logs for a given collection. |
| This function returns a list of logs for a given collection. |
| |
| It returns a Uri object that represents the URL for the collections endpoint. |
| It takes a |
| Given a collection name, return a Uri object that represents the collection's endpoint. |
| It returns a URI that points to the stats endpoint for a given collection. |
| It returns a URI for the collection logs endpoint. |
| It returns a Uri object that represents the URL for the collection logs endpoint. |
Members
public CollectionsDto Collections()
It returns a list of all the collections in the database.
Returns
A list of collections
public CollectionsDto Collections( CollectionsUriParameterBuilder collectionsUriParameterBuilder)
It takes a CollectionsUriParameterBuilder object as a parameter, builds an HttpRequestMessage object, sends it to the API, and returns a CollectionsDto object.
Parameters
CollectionsUriParameterBuilderThis is a class that contains all the parameters that can be passed to the API.
Returns
A collection of collections.
public CollectionDto Collection(string collectionName)
This function will return a collection object from the API.
Parameters
collectionNameThe name of the collection you want to retrieve.
Returns
A collection of documents.
public StatsDto CollectionStats(string collectionName)
This function will return a StatsDto object that contains the stats for the collection specified in the collectionName parameter.
Parameters
collectionNameThe name of the collection you want to get stats for.
Returns
A StatsDto object
public LogsDto CollectionLogs(string collectionName)
This function will return a list of logs for a given collection.
Parameters
collectionNameThe name of the collection you want to get the logs for.
Returns
A LogsDto object
public LogsDto CollectionLogs(string collectionName, CollectionsUriParameterBuilder collectionsUriParameterBuilder)
This function returns a list of logs for a given collection.
Parameters
collectionNameThe name of the collection you want to get the logs for.CollectionsUriParameterBuilderThis is a class that allows you to build the query string parameters for the request.
Returns
A LogsDto object
private readonly string _requestUriBase
private Uri CollectionsUri()
It returns a Uri object that represents the URL for the collections endpoint.
private Uri CollectionsUri( CollectionsUriParameterBuilder collectionsUriParameterBuilder)
It takes a CollectionsUriParameterBuilder object as a parameter and returns a Uri object.
Parameters
CollectionsUriParameterBuilderA class that builds the query string parameters for the collections endpoint.
private Uri CollectionUri(string collectionName)
Given a collection name, return a Uri object that represents the collection's endpoint.
Parameters
collectionNameThe name of the collection you want to query.
private Uri CollectionStatsUri(string collectionName)
It returns a URI that points to the stats endpoint for a given collection.
Parameters
collectionNameThe name of the collection you want to get stats for.
private Uri CollectionLogsUri(string collectionName)
It returns a URI for the collection logs endpoint.
Parameters
collectionNameThe name of the collection you want to get the logs for.
private Uri CollectionLogsUri(string collectionName, CollectionsUriParameterBuilder collectionsUriParameterBuilder)
It returns a Uri object that represents the URL for the collection logs endpoint.
Parameters
collectionNameThe name of the collection you want to get the logs for.CollectionsUriParameterBuilderThis is a class that builds the query parameters for the request.
Last updated