SchemasApi

Summary

Members	Descriptions
public SchemasDto Schemas()	This function will return a SchemasDto object that contains a list of all the schemas that are available in the API.
public SchemasDto Schemas( SchemasUriParameterBuilder schemasUriParameterBuilder)	This function will return a list of schemas that match the criteria specified in the SchemasUriParameterBuilder object.
public SchemaDto Schema(string collectionName, string schemaName)	This function will return a schema object for the specified collection and schema name.
public StatsDto SchemaStats(string collectionName, string schemaName)	It returns the stats of a schema.
public LogsDto SchemaLogs(string collectionName, string schemaName)	This function returns a list of logs for a specific schema.
public LogsDto SchemaLogs(string collectionName, string schemaName, SchemasUriParameterBuilder schemasUriParameterBuilder)	This function returns a list of logs for a specific schema.
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.
private Uri SchemaUri(string collectionName, string schemaName)	It returns a URI for a specific schema in a specific collection
private Uri SchemaStatsUri(string collectionName, string schemaName)	It returns a URI that points to the stats for a specific schema in a specific collection.
private Uri SchemaLogsUri(string collectionName, string schemaName)	This function returns a URI for the schema logs endpoint
private Uri SchemaLogsUri(string collectionName, string schemaName, SchemasUriParameterBuilder schemasUriParameterBuilder)	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

• SchemasUriParameterBuilder This 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

• collectionName The name of the collection you want to get the schema for.

• schemaName The 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

• collectionName The name of the collection you want to get the stats for.

• schemaName The 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

• collectionName The name of the collection you want to get the logs for.

• schemaName The 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

• collectionName The name of the collection you want to get the schema logs for.

• schemaName The name of the schema you want to get the logs for.

• SchemasUriParameterBuilder This 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

• SchemasUriParameterBuilder A 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

• collectionName The name of the collection you want to create the schema in.

• schemaName The 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

• collectionName The name of the collection you want to get the schema stats for.

• schemaName The name of the schema.

private Uri SchemaLogsUri(string collectionName, string schemaName)

This function returns a URI for the schema logs endpoint

Parameters

• collectionName The name of the collection you want to create a schema for.

• schemaName The name of the schema.

private Uri SchemaLogsUri(string collectionName, string schemaName, SchemasUriParameterBuilder schemasUriParameterBuilder)

It returns a URI for the schema logs endpoint.

Parameters

• collectionName The name of the collection.

• schemaName The name of the schema.

• SchemasUriParameterBuilder This is a class that helps you build the query parameters for the request.