Class OnboardingRequest

OnboardingRequest

Inheritance

System.Object

OnboardingRequest

Namespace: InfluxDB.Client.Api.Domain

Assembly: InfluxDB.Client.dll

Syntax

public class OnboardingRequest : IEquatable<OnboardingRequest>

Constructors

OnboardingRequest()

Initializes a new instance of the OnboardingRequest class.

Declaration

protected OnboardingRequest()

OnboardingRequest(String, String, String, String, Nullable<Int64>, Nullable<Int32>, String)

Initializes a new instance of the OnboardingRequest class.

Declaration

public OnboardingRequest(string username = null, string password = null, string org = null, string bucket = null, long? retentionPeriodSeconds = null, int? retentionPeriodHrs = null, string token = null)

Parameters

Type	Name	Description
System.String	username	username (required).
System.String	password	password.
System.String	org	org (required).
System.String	bucket	bucket (required).
System.Nullable<System.Int64>	retentionPeriodSeconds	retentionPeriodSeconds.
System.Nullable<System.Int32>	retentionPeriodHrs	Retention period in nanoseconds for the new bucket. This key's name has been misleading since OSS 2.0 GA, please transition to use retentionPeriodSeconds.
System.String	token	Authentication token to set on the initial user. If not specified, the server will generate a token..

Properties

Bucket

Gets or Sets Bucket

Declaration

public string Bucket { get; set; }

Property Value

Type	Description
System.String

Org

Gets or Sets Org

Declaration

public string Org { get; set; }

Property Value

Type	Description
System.String

Password

Gets or Sets Password

Declaration

public string Password { get; set; }

Property Value

Type	Description
System.String

RetentionPeriodHrs

Retention period in nanoseconds for the new bucket. This key's name has been misleading since OSS 2.0 GA, please transition to use retentionPeriodSeconds

Declaration

public int? RetentionPeriodHrs { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>	Retention period in nanoseconds for the new bucket. This key's name has been misleading since OSS 2.0 GA, please transition to use retentionPeriodSeconds

RetentionPeriodSeconds

Gets or Sets RetentionPeriodSeconds

Declaration

public long? RetentionPeriodSeconds { get; set; }

Property Value

Type	Description
System.Nullable<System.Int64>

Token

Authentication token to set on the initial user. If not specified, the server will generate a token.

Declaration

public string Token { get; set; }

Property Value

Type	Description
System.String	Authentication token to set on the initial user. If not specified, the server will generate a token.

Username

Gets or Sets Username

Declaration

public string Username { get; set; }

Property Value

Type	Description
System.String

Methods

Equals(OnboardingRequest)

Returns true if OnboardingRequest instances are equal

Declaration

public bool Equals(OnboardingRequest input)

Parameters

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