Class Bucket

Bucket

Inheritance

System.Object

Bucket

Namespace: InfluxDB.Client.Api.Domain

Assembly: InfluxDB.Client.dll

Syntax

public class Bucket : IEquatable<Bucket>

Constructors

Bucket()

Initializes a new instance of the Bucket class.

Declaration

protected Bucket()

Bucket(BucketLinks, String, String, String, String, Nullable<SchemaType>, List<BucketRetentionRules>, List<Label>)

Initializes a new instance of the Bucket class.

Declaration

public Bucket(BucketLinks links = null, string name = null, string description = null, string orgID = null, string rp = null, SchemaType? schemaType = null, List<BucketRetentionRules> retentionRules = null, List<Label> labels = null)

Parameters

Type	Name	Description
BucketLinks	links	links.
System.String	name	name (required).
System.String	description	description.
System.String	orgID	orgID.
System.String	rp	rp.
System.Nullable<SchemaType>	schemaType	schemaType.
List<BucketRetentionRules>	retentionRules	Rules to expire or retain data. No rules means data never expires. (required).
List<Label>	labels	labels.

Properties

CreatedAt

Gets or Sets CreatedAt

Declaration

public DateTime? CreatedAt { get; }

Property Value

Type	Description
System.Nullable<DateTime>

Description

Gets or Sets Description

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String

Id

Gets or Sets Id

Declaration

public string Id { get; }

Property Value

Type	Description
System.String

Labels

Gets or Sets Labels

Declaration

public List<Label> Labels { get; set; }

Property Value

Type	Description
List<Label>

Links

Gets or Sets Links

Declaration

public BucketLinks Links { get; set; }

Property Value

Type	Description
BucketLinks

Name

Gets or Sets Name

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String

OrgID

Gets or Sets OrgID

Declaration

public string OrgID { get; set; }

Property Value

Type	Description
System.String

RetentionRules

Rules to expire or retain data. No rules means data never expires.

Declaration

public List<BucketRetentionRules> RetentionRules { get; set; }

Property Value

Type	Description
List<BucketRetentionRules>	Rules to expire or retain data. No rules means data never expires.

Rp

Gets or Sets Rp

Declaration

public string Rp { get; set; }

Property Value

Type	Description
System.String

SchemaType

Gets or Sets SchemaType

Declaration

public SchemaType? SchemaType { get; set; }

Property Value

Type	Description
System.Nullable<SchemaType>

Type

Gets or Sets Type

Declaration

public Bucket.TypeEnum? Type { get; set; }

Property Value

Type	Description
System.Nullable<Bucket.TypeEnum>

UpdatedAt

Gets or Sets UpdatedAt

Declaration

public DateTime? UpdatedAt { get; }

Property Value

Type	Description
System.Nullable<DateTime>

Methods

Equals(Bucket)

Returns true if Bucket instances are equal

Declaration

public bool Equals(Bucket input)

Parameters

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