SchemasApi
Summary
| Members | Descriptions |
|---|---|
| This function will return a |
| This function will return a list of schemas that match the criteria specified in the |
This function will return a schema object for the specified collection and schema name. | |
| It returns the stats of a schema. |
| This function returns a list of logs for a specific schema. |
| This function returns a list of logs for a specific schema. |
| |
| It returns a URI that points to the schemas endpoint. |
| It takes a |
| It returns a URI for a specific schema in a specific collection |
| It returns a URI that points to the stats for a specific schema in a specific collection. |
| This function returns a URI for the schema logs endpoint |
| It returns a URI for the schema logs endpoint. |
Members
public SchemasDto Schemas()
This function will return a SchemasDto object that contains a list of all the schemas that are available in the API.
Returns
A SchemasDto object.
public SchemasDto Schemas( SchemasUriParameterBuilder schemasUriParameterBuilder)
This function will return a list of schemas that match the criteria specified in the SchemasUriParameterBuilder object.
Parameters
SchemasUriParameterBuilderThis is a class that contains all the parameters that can be passed to the API.
Returns
A list of schemas.
public SchemaDto Schema(string collectionName, string schemaName)
This function will return a schema object for the specified collection and schema name.
Parameters
collectionNameThe name of the collection you want to get the schema for.schemaNameThe name of the schema you want to retrieve.
Returns
A SchemaDto object.
public StatsDto SchemaStats(string collectionName, string schemaName)
It returns the stats of a schema.
Parameters
collectionNameThe name of the collection you want to get the stats for.schemaNameThe name of the schema you want to get stats for.
Returns
A StatsDto object
public LogsDto SchemaLogs(string collectionName, string schemaName)
This function returns a list of logs for a specific schema.
Parameters
collectionNameThe name of the collection you want to get the logs for.schemaNameThe name of the schema you want to get logs for.
Returns
A list of logs for the schema.
public LogsDto SchemaLogs(string collectionName, string schemaName, SchemasUriParameterBuilder schemasUriParameterBuilder)
This function returns a list of logs for a specific schema.
Parameters
collectionNameThe name of the collection you want to get the schema logs for.schemaNameThe name of the schema you want to get the logs for.SchemasUriParameterBuilderThis is a class that contains the parameters that can be passed to the API.
Returns
A LogsDto object.
private readonly string _requestUriBase
private Uri SchemasUri()
It returns a URI that points to the schemas endpoint.
private Uri SchemasUri( SchemasUriParameterBuilder schemasUriParameterBuilder)
It takes a SchemasUriParameterBuilder object as a parameter, and returns a Uri object.
Parameters
SchemasUriParameterBuilderA class that builds the query string parameters for the schemas endpoint.
private Uri SchemaUri(string collectionName, string schemaName)
It returns a URI for a specific schema in a specific collection
Parameters
collectionNameThe name of the collection you want to create the schema in.schemaNameThe name of the schema to be created.
private Uri SchemaStatsUri(string collectionName, string schemaName)
It returns a URI that points to the stats for a specific schema in a specific collection.
Parameters
collectionNameThe name of the collection you want to get the schema stats for.schemaNameThe name of the schema.
private Uri SchemaLogsUri(string collectionName, string schemaName)
This function returns a URI for the schema logs endpoint
Parameters
collectionNameThe name of the collection you want to create a schema for.schemaNameThe name of the schema.
private Uri SchemaLogsUri(string collectionName, string schemaName, SchemasUriParameterBuilder schemasUriParameterBuilder)
It returns a URI for the schema logs endpoint.
Parameters
collectionNameThe name of the collection.schemaNameThe name of the schema.SchemasUriParameterBuilderThis is a class that helps you build the query parameters for the request.
Last updated