Class Dialect
Dialect are options to change the default CSV output format; https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions
Inheritance
Namespace: InfluxDB.Client.Api.Domain
Assembly: InfluxDB.Client.dll
Syntax
public class Dialect : IEquatable<Dialect>Constructors
Dialect(Nullable<Boolean>, String, List<Dialect.AnnotationsEnum>, String, Nullable<Dialect.DateTimeFormatEnum>)
Initializes a new instance of the Dialect class.
Declaration
public Dialect(bool? header, string delimiter = ",", List<Dialect.AnnotationsEnum> annotations = null, string commentPrefix = "#", Dialect.DateTimeFormatEnum? dateTimeFormat = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.Nullable<System.Boolean> | header | If true, the results will contain a header row (default to true). |
| System.String | delimiter | Separator between cells; the default is , (default to ","). |
| List<Dialect.AnnotationsEnum> | annotations | https://www.w3.org/TR/2015/REC-tabular-data-model-20151217/#columns. |
| System.String | commentPrefix | Character prefixed to comment strings (default to "#"). |
| System.Nullable<Dialect.DateTimeFormatEnum> | dateTimeFormat | Format of timestamps (default to DateTimeFormatEnum.RFC3339). |
Properties
Annotations
Declaration
public List<Dialect.AnnotationsEnum> Annotations { get; set; }Property Value
| Type | Description |
|---|---|
| List<Dialect.AnnotationsEnum> | https://www.w3.org/TR/2015/REC-tabular-data-model-20151217/#columns |
CommentPrefix
Character prefixed to comment strings
Declaration
public string CommentPrefix { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | Character prefixed to comment strings |
DateTimeFormat
Format of timestamps
Declaration
public Dialect.DateTimeFormatEnum? DateTimeFormat { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<Dialect.DateTimeFormatEnum> | Format of timestamps |
Delimiter
Separator between cells; the default is ,
Declaration
public string Delimiter { get; set; }Property Value
| Type | Description |
|---|---|
| System.String | Separator between cells; the default is , |
Header
If true, the results will contain a header row
Declaration
public bool? Header { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Boolean> | If true, the results will contain a header row |
Methods
Equals(Dialect)
Returns true if Dialect instances are equal
Declaration
public bool Equals(Dialect input)Parameters
| Type | Name | Description |
|---|---|---|
| Dialect | input | Instance of Dialect to be compared |
Returns
| Type | Description |
|---|---|
| System.Boolean | Boolean |
Equals(Object)
Returns true if objects are equal
Declaration
public override bool Equals(object input)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | input | Object to be compared |
Returns
| Type | Description |
|---|---|
| System.Boolean | Boolean |
GetHashCode()
Gets the hash code
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| System.Int32 | Hash code |
ToJson()
Returns the JSON string presentation of the object
Declaration
public virtual string ToJson()Returns
| Type | Description |
|---|---|
| System.String | JSON string presentation of the object |
ToString()
Returns the string presentation of the object
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| System.String | String presentation of the object |