Class BucketRetentionRules
BucketRetentionRules
Inheritance
Namespace: InfluxDB.Client.Api.Domain
Assembly: InfluxDB.Client.dll
Syntax
public class BucketRetentionRules : IEquatable<BucketRetentionRules>Constructors
BucketRetentionRules()
Initializes a new instance of the BucketRetentionRules class.
Declaration
protected BucketRetentionRules()BucketRetentionRules(BucketRetentionRules.TypeEnum, Nullable<Int64>, Nullable<Int64>)
Initializes a new instance of the BucketRetentionRules class.
Declaration
public BucketRetentionRules(BucketRetentionRules.TypeEnum type = default(BucketRetentionRules.TypeEnum), long? everySeconds = null, long? shardGroupDurationSeconds = null)Parameters
| Type | Name | Description |
|---|---|---|
| BucketRetentionRules.TypeEnum | type | type (required) (default to TypeEnum.Expire). |
| System.Nullable<System.Int64> | everySeconds | Duration in seconds for how long data will be kept in the database. 0 means infinite. (required). |
| System.Nullable<System.Int64> | shardGroupDurationSeconds | Shard duration measured in seconds.. |
Properties
EverySeconds
Duration in seconds for how long data will be kept in the database. 0 means infinite.
Declaration
public long? EverySeconds { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> | Duration in seconds for how long data will be kept in the database. 0 means infinite. |
ShardGroupDurationSeconds
Shard duration measured in seconds.
Declaration
public long? ShardGroupDurationSeconds { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.Int64> | Shard duration measured in seconds. |
Type
Gets or Sets Type
Declaration
public BucketRetentionRules.TypeEnum Type { get; set; }Property Value
| Type | Description |
|---|---|
| BucketRetentionRules.TypeEnum |
Methods
Equals(BucketRetentionRules)
Returns true if BucketRetentionRules instances are equal
Declaration
public bool Equals(BucketRetentionRules input)Parameters
| Type | Name | Description |
|---|---|---|
| BucketRetentionRules | input | Instance of BucketRetentionRules 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 |