Class RenamableField

Describes a field that can be renamed and made visible or invisible.

Inheritance

System.Object

RenamableField

Namespace: InfluxDB.Client.Api.Domain

Assembly: InfluxDB.Client.dll

Syntax

public class RenamableField : IEquatable<RenamableField>

Constructors

RenamableField(String, Nullable<Boolean>)

Initializes a new instance of the RenamableField class.

Declaration

public RenamableField(string displayName = null, bool? visible = null)

Parameters

Type	Name	Description
System.String	displayName	The name that a field is renamed to by the user..
System.Nullable<System.Boolean>	visible	Indicates whether this field should be visible on the table..

Properties

DisplayName

The name that a field is renamed to by the user.

Declaration

public string DisplayName { get; set; }

Property Value

Type	Description
System.String	The name that a field is renamed to by the user.

InternalName

The calculated name of a field.

Declaration

public string InternalName { get; }

Property Value

Type	Description
System.String	The calculated name of a field.

Visible

Indicates whether this field should be visible on the table.

Declaration

public bool? Visible { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>	Indicates whether this field should be visible on the table.

Methods

Equals(RenamableField)

Returns true if RenamableField instances are equal

Declaration

public bool Equals(RenamableField input)

Parameters

Type	Name	Description
RenamableField	input	Instance of RenamableField 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