File: bucket_retention_rules.py

package info (click to toggle)
python-influxdb-client 1.40.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 7,216 kB
  • sloc: python: 60,236; sh: 64; makefile: 53
file content (164 lines) | stat: -rw-r--r-- 6,101 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# coding: utf-8

"""
InfluxDB OSS API Service.

The InfluxDB v2 API provides a programmatic interface for all interactions with InfluxDB. Access the InfluxDB API using the `/api/v2/` endpoint.   # noqa: E501

OpenAPI spec version: 2.0.0
Generated by: https://openapi-generator.tech
"""


import pprint
import re  # noqa: F401


class BucketRetentionRules(object):
    """NOTE: This class is auto generated by OpenAPI Generator.

    Ref: https://openapi-generator.tech

    Do not edit the class manually.
    """

    """
    Attributes:
      openapi_types (dict): The key is attribute name
                            and the value is attribute type.
      attribute_map (dict): The key is attribute name
                            and the value is json key in definition.
    """
    openapi_types = {
        'type': 'str',
        'every_seconds': 'int',
        'shard_group_duration_seconds': 'int'
    }

    attribute_map = {
        'type': 'type',
        'every_seconds': 'everySeconds',
        'shard_group_duration_seconds': 'shardGroupDurationSeconds'
    }

    def __init__(self, type='expire', every_seconds=2592000, shard_group_duration_seconds=None):  # noqa: E501,D401,D403
        """BucketRetentionRules - a model defined in OpenAPI."""  # noqa: E501
        self._type = None
        self._every_seconds = None
        self._shard_group_duration_seconds = None
        self.discriminator = None

        if type is not None:
            self.type = type
        self.every_seconds = every_seconds
        if shard_group_duration_seconds is not None:
            self.shard_group_duration_seconds = shard_group_duration_seconds

    @property
    def type(self):
        """Get the type of this BucketRetentionRules.

        :return: The type of this BucketRetentionRules.
        :rtype: str
        """  # noqa: E501
        return self._type

    @type.setter
    def type(self, type):
        """Set the type of this BucketRetentionRules.

        :param type: The type of this BucketRetentionRules.
        :type: str
        """  # noqa: E501
        self._type = type

    @property
    def every_seconds(self):
        """Get the every_seconds of this BucketRetentionRules.

        The duration in seconds for how long data will be kept in the database. The default duration is 2592000 (30 days). 0 represents infinite retention.

        :return: The every_seconds of this BucketRetentionRules.
        :rtype: int
        """  # noqa: E501
        return self._every_seconds

    @every_seconds.setter
    def every_seconds(self, every_seconds):
        """Set the every_seconds of this BucketRetentionRules.

        The duration in seconds for how long data will be kept in the database. The default duration is 2592000 (30 days). 0 represents infinite retention.

        :param every_seconds: The every_seconds of this BucketRetentionRules.
        :type: int
        """  # noqa: E501
        if every_seconds is None:
            raise ValueError("Invalid value for `every_seconds`, must not be `None`")  # noqa: E501
        if every_seconds is not None and every_seconds < 0:  # noqa: E501
            raise ValueError("Invalid value for `every_seconds`, must be a value greater than or equal to `0`")  # noqa: E501
        self._every_seconds = every_seconds

    @property
    def shard_group_duration_seconds(self):
        """Get the shard_group_duration_seconds of this BucketRetentionRules.

        The shard group duration. The duration or interval (in seconds) that each shard group covers.  #### InfluxDB Cloud  - Does not use `shardGroupDurationsSeconds`.  #### InfluxDB OSS  - Default value depends on the [bucket retention period](https://docs.influxdata.com/influxdb/latest/reference/internals/shards/#shard-group-duration).

        :return: The shard_group_duration_seconds of this BucketRetentionRules.
        :rtype: int
        """  # noqa: E501
        return self._shard_group_duration_seconds

    @shard_group_duration_seconds.setter
    def shard_group_duration_seconds(self, shard_group_duration_seconds):
        """Set the shard_group_duration_seconds of this BucketRetentionRules.

        The shard group duration. The duration or interval (in seconds) that each shard group covers.  #### InfluxDB Cloud  - Does not use `shardGroupDurationsSeconds`.  #### InfluxDB OSS  - Default value depends on the [bucket retention period](https://docs.influxdata.com/influxdb/latest/reference/internals/shards/#shard-group-duration).

        :param shard_group_duration_seconds: The shard_group_duration_seconds of this BucketRetentionRules.
        :type: int
        """  # noqa: E501
        self._shard_group_duration_seconds = shard_group_duration_seconds

    def to_dict(self):
        """Return the model properties as a dict."""
        result = {}

        for attr, _ in self.openapi_types.items():
            value = getattr(self, attr)
            if isinstance(value, list):
                result[attr] = list(map(
                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
                    value
                ))
            elif hasattr(value, "to_dict"):
                result[attr] = value.to_dict()
            elif isinstance(value, dict):
                result[attr] = dict(map(
                    lambda item: (item[0], item[1].to_dict())
                    if hasattr(item[1], "to_dict") else item,
                    value.items()
                ))
            else:
                result[attr] = value

        return result

    def to_str(self):
        """Return the string representation of the model."""
        return pprint.pformat(self.to_dict())

    def __repr__(self):
        """For `print` and `pprint`."""
        return self.to_str()

    def __eq__(self, other):
        """Return true if both objects are equal."""
        if not isinstance(other, BucketRetentionRules):
            return False

        return self.__dict__ == other.__dict__

    def __ne__(self, other):
        """Return true if both objects are not equal."""
        return not self == other