🔐 Sid Gifari File Manager Pro
v8.0.5 | 2026-08-08 15:40:51 | PHP 8.2.32
📂
/ (Root)
/
opt
/
alt
/
python38
/
lib
/
python3.8
/
site-packages
/
influxdb_client
/
service
/
__pycache__
📍 /opt/alt/python38/lib/python3.8/site-packages/influxdb_client/service/__pycache__
🔄 Refresh
✏️
Editing: buckets_service.cpython-38.pyc
Read Only
U w�i�� � @ s8 d Z ddlmZ ddlZddlmZ G dd� de�ZdS )a 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 � )�absolute_importN)� _BaseServicec s e Zd ZdZd}� fdd� Zdd� Zdd� Zd d � Zd d � Zd d� Z dd� Z dd� Z dd� Z dd� Z dd� Zdd� Zdd � Zd d � Zd d � Zd!d"� Zd#d$� Zd%d&� Zd'd(� Zd)d*� Zd+d,� Zd-d.� Zd/d0� Zd1d2� Zd3d4� Z d5d6� Z d7d8� Z d9d:� Z d;d<� Z d=d>� Z!d?d@� Z"dAdB� Z#dCdD� Z$dEdF� Z%dGdH� Z&dIdJ� Z'dKdL� Z(dMdN� Z)dOdP� Z*dQdR� Z+dSdT� Z,dUdV� Z-dWdX� Z.dYdZ� Z/d[d\� Z0d]d^� Z1d_d`� Z2dadb� Z3dcdd� Z4dedf� Z5dgdh� Z6didj� Z7dkdl� Z8dmdn� Z9dodp� Z:dqdr� Z;dsdt� Z<dudv� Z=dwdx� Z>dydz� Z?d{d|� Z@� ZAS )~�BucketsServicez�NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech Do not edit the class manually. Nc s t � �|� dS )z0BucketsService - a operation defined in OpenAPI.N)�super�__init__)�self� api_client�� __class__� �X/opt/alt/python38/lib/python3.8/site-packages/influxdb_client/service/buckets_service.pyr s zBucketsService.__init__c K s6 d|d< |� d�r | j|f|�S | j|f|�}|S dS )a� Delete a bucket. Deletes a bucket and all associated records. #### InfluxDB Cloud - Does the following when you send a delete request: 1. Validates the request and queues the delete. 2. Returns an HTTP `204` status code if queued; _error_ otherwise. 3. Handles the delete asynchronously. #### InfluxDB OSS - Validates the request, handles the delete synchronously, and then responds with success or failure. #### Limitations - Only one bucket can be deleted per request. #### Related Guides - [Delete a bucket](https://docs.influxdata.com/influxdb/latest/organizations/buckets/delete-bucket/#delete-a-bucket-in-the-influxdb-ui) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_buckets_id(bucket_id, async_req=True) >>> result = thread.get() :param async_req bool :param str bucket_id: Bucket ID. The ID of the bucket to delete. (required) :param str zap_trace_span: OpenTracing span context :return: None If the method is called asynchronously, returns the request thread. T�_return_http_data_only� async_reqN)�get� delete_buckets_id_with_http_info�r � bucket_id�kwargs�datar r r �delete_buckets_id s z BucketsService.delete_buckets_idc K sf | j |f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d�d �S ) a� Delete a bucket. Deletes a bucket and all associated records. #### InfluxDB Cloud - Does the following when you send a delete request: 1. Validates the request and queues the delete. 2. Returns an HTTP `204` status code if queued; _error_ otherwise. 3. Handles the delete asynchronously. #### InfluxDB OSS - Validates the request, handles the delete synchronously, and then responds with success or failure. #### Limitations - Only one bucket can be deleted per request. #### Related Guides - [Delete a bucket](https://docs.influxdata.com/influxdb/latest/organizations/buckets/delete-bucket/#delete-a-bucket-in-the-influxdb-ui) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_buckets_id_with_http_info(bucket_id, async_req=True) >>> result = thread.get() :param async_req bool :param str bucket_id: Bucket ID. The ID of the bucket to delete. (required) :param str zap_trace_span: OpenTracing span context :return: None If the method is called asynchronously, returns the request thread. �/api/v2/buckets/{bucketID}�DELETENr r �_preload_contentT�_request_timeout� urlopen_kw� �bodyZ post_params�filesZ response_typeZ auth_settingsr r r r Zcollection_formatsr ��_delete_buckets_id_preparer �call_apir �r r r �local_var_params� path_params� query_params� header_params� body_paramsr r r r 7 s( � �z/BucketsService.delete_buckets_id_with_http_infoc � sl | j |f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d�d �I dH S ) a� Delete a bucket. Deletes a bucket and all associated records. #### InfluxDB Cloud - Does the following when you send a delete request: 1. Validates the request and queues the delete. 2. Returns an HTTP `204` status code if queued; _error_ otherwise. 3. Handles the delete asynchronously. #### InfluxDB OSS - Validates the request, handles the delete synchronously, and then responds with success or failure. #### Limitations - Only one bucket can be deleted per request. #### Related Guides - [Delete a bucket](https://docs.influxdata.com/influxdb/latest/organizations/buckets/delete-bucket/#delete-a-bucket-in-the-influxdb-ui) This method makes an asynchronous HTTP request. :param async_req bool :param str bucket_id: Bucket ID. The ID of the bucket to delete. (required) :param str zap_trace_span: OpenTracing span context :return: None If the method is called asynchronously, returns the request thread. r r Nr r r Tr r r r r! r r r �delete_buckets_id_async[ s( � �z&BucketsService.delete_buckets_id_asyncc K s� t � }ddg}| �d||� d|ks0|d d kr8td��i }d|krP|d |d< g }i }d|krl|d |d< d }| j�dg�|d< |||||fS ) Nr �zap_trace_spanr zKMissing the required parameter `bucket_id` when calling `delete_buckets_id`�bucketID�Zap-Trace-Span�application/json�Accept��locals�_check_operation_params� ValueErrorr �select_header_accept� r r r r" � all_paramsr# r$ r% r& r r r r | s& � �z)BucketsService._delete_buckets_id_preparec K s: d|d< |� d�r"| j||f|�S | j||f|�}|S dS )a� Delete a label from a bucket. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_buckets_id_labels_id(bucket_id, label_id, async_req=True) >>> result = thread.get() :param async_req bool :param str bucket_id: The bucket ID. (required) :param str label_id: The ID of the label to delete. (required) :param str zap_trace_span: OpenTracing span context :return: None If the method is called asynchronously, returns the request thread. Tr r N)r �*delete_buckets_id_labels_id_with_http_info)r r �label_idr r r r r �delete_buckets_id_labels_id� s z*BucketsService.delete_buckets_id_labels_idc K sh | j ||f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d�d �S ) a� Delete a label from a bucket. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_buckets_id_labels_id_with_http_info(bucket_id, label_id, async_req=True) >>> result = thread.get() :param async_req bool :param str bucket_id: The bucket ID. (required) :param str label_id: The ID of the label to delete. (required) :param str zap_trace_span: OpenTracing span context :return: None If the method is called asynchronously, returns the request thread. �+/api/v2/buckets/{bucketID}/labels/{labelID}r Nr r r Tr r r ��$_delete_buckets_id_labels_id_preparer r r � r r r5 r r" r# r$ r% r& r r r r4 � s( � �z9BucketsService.delete_buckets_id_labels_id_with_http_infoc � sn | j ||f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d�d �I dH S ) a� Delete a label from a bucket. This method makes an asynchronous HTTP request. :param async_req bool :param str bucket_id: The bucket ID. (required) :param str label_id: The ID of the label to delete. (required) :param str zap_trace_span: OpenTracing span context :return: None If the method is called asynchronously, returns the request thread. r7 r Nr r r Tr r r r8 r: r r r �!delete_buckets_id_labels_id_async� s( � �z0BucketsService.delete_buckets_id_labels_id_asyncc K s� t � }dddg}| �d||� d|ks2|d d kr:td��d|ksN|d d krVtd��i }d|krn|d |d< d|kr�|d |d< g }i }d|kr�|d |d < d } | j�d g�|d < ||||| fS ) Nr r5 r( r6 zUMissing the required parameter `bucket_id` when calling `delete_buckets_id_labels_id`zTMissing the required parameter `label_id` when calling `delete_buckets_id_labels_id`r) ZlabelIDr* r+ r, r- ) r r r5 r r" r3 r# r$ r% r& r r r r9 � s2 � � �z3BucketsService._delete_buckets_id_labels_id_preparec K s: d|d< |� d�r"| j||f|�S | j||f|�}|S dS )a Remove a member from a bucket. Removes a member from a bucket. Use this endpoint to remove a user's member privileges from a bucket. This removes the user's `read` and `write` permissions for the bucket. #### Related guides - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) - [Manage members](https://docs.influxdata.com/influxdb/latest/organizations/members/) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_buckets_id_members_id(user_id, bucket_id, async_req=True) >>> result = thread.get() :param async_req bool :param str user_id: The ID of the user to remove. (required) :param str bucket_id: The ID of the bucket to remove a user from. (required) :param str zap_trace_span: OpenTracing span context :return: None If the method is called asynchronously, returns the request thread. Tr r N)r �+delete_buckets_id_members_id_with_http_info�r �user_idr r r r r r � delete_buckets_id_members_id s z+BucketsService.delete_buckets_id_members_idc K sh | j ||f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d�d �S ) a Remove a member from a bucket. Removes a member from a bucket. Use this endpoint to remove a user's member privileges from a bucket. This removes the user's `read` and `write` permissions for the bucket. #### Related guides - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) - [Manage members](https://docs.influxdata.com/influxdb/latest/organizations/members/) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_buckets_id_members_id_with_http_info(user_id, bucket_id, async_req=True) >>> result = thread.get() :param async_req bool :param str user_id: The ID of the user to remove. (required) :param str bucket_id: The ID of the bucket to remove a user from. (required) :param str zap_trace_span: OpenTracing span context :return: None If the method is called asynchronously, returns the request thread. �+/api/v2/buckets/{bucketID}/members/{userID}r Nr r r Tr r r ��%_delete_buckets_id_members_id_preparer r r � r r> r r r" r# r$ r% r& r r r r< , s( � �z:BucketsService.delete_buckets_id_members_id_with_http_infoc � sn | j ||f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d�d �I dH S ) a9 Remove a member from a bucket. Removes a member from a bucket. Use this endpoint to remove a user's member privileges from a bucket. This removes the user's `read` and `write` permissions for the bucket. #### Related guides - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) - [Manage members](https://docs.influxdata.com/influxdb/latest/organizations/members/) This method makes an asynchronous HTTP request. :param async_req bool :param str user_id: The ID of the user to remove. (required) :param str bucket_id: The ID of the bucket to remove a user from. (required) :param str zap_trace_span: OpenTracing span context :return: None If the method is called asynchronously, returns the request thread. r@ r Nr r r Tr r r rA rC r r r �"delete_buckets_id_members_id_asyncQ s( � �z1BucketsService.delete_buckets_id_members_id_asyncc K s� t � }dddg}| �d||� d|ks2|d d kr:td��d|ksN|d d krVtd��i }d|krn|d |d< d|kr�|d |d< g }i }d|kr�|d |d < d } | j�d g�|d < ||||| fS ) Nr> r r( r? zTMissing the required parameter `user_id` when calling `delete_buckets_id_members_id`zVMissing the required parameter `bucket_id` when calling `delete_buckets_id_members_id`�userIDr) r* r+ r, r- � r r> r r r" r3 r# r$ r% r& r r r rB s s2 � � �z4BucketsService._delete_buckets_id_members_id_preparec K s: d|d< |� d�r"| j||f|�S | j||f|�}|S dS )as Remove an owner from a bucket. Removes an owner from a bucket. Use this endpoint to remove a user's `owner` role for a bucket. #### InfluxDB Cloud - Doesn't use `owner` and `member` roles. Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions. #### Limitations - Owner permissions are separate from API token permissions. - Owner permissions are used in the context of the InfluxDB UI. #### Required permissions - `write-orgs INFLUX_ORG_ID` *`INFLUX_ORG_ID`* is the ID of the organization that you want to remove an owner from. #### Related endpoints - [Authorizations](#tag/Authorizations-(API-tokens)) #### Related guides - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_buckets_id_owners_id(user_id, bucket_id, async_req=True) >>> result = thread.get() :param async_req bool :param str user_id: The ID of the owner to remove. (required) :param str bucket_id: The ID of the bucket to remove an owner from. (required) :param str zap_trace_span: OpenTracing span context :return: None If the method is called asynchronously, returns the request thread. Tr r N)r �*delete_buckets_id_owners_id_with_http_infor= r r r �delete_buckets_id_owners_id� s z*BucketsService.delete_buckets_id_owners_idc K sh | j ||f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d�d �S ) a� Remove an owner from a bucket. Removes an owner from a bucket. Use this endpoint to remove a user's `owner` role for a bucket. #### InfluxDB Cloud - Doesn't use `owner` and `member` roles. Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions. #### Limitations - Owner permissions are separate from API token permissions. - Owner permissions are used in the context of the InfluxDB UI. #### Required permissions - `write-orgs INFLUX_ORG_ID` *`INFLUX_ORG_ID`* is the ID of the organization that you want to remove an owner from. #### Related endpoints - [Authorizations](#tag/Authorizations-(API-tokens)) #### Related guides - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.delete_buckets_id_owners_id_with_http_info(user_id, bucket_id, async_req=True) >>> result = thread.get() :param async_req bool :param str user_id: The ID of the owner to remove. (required) :param str bucket_id: The ID of the bucket to remove an owner from. (required) :param str zap_trace_span: OpenTracing span context :return: None If the method is called asynchronously, returns the request thread. �*/api/v2/buckets/{bucketID}/owners/{userID}r Nr r r Tr r r ��$_delete_buckets_id_owners_id_preparer r r rC r r r rG � s( � �z9BucketsService.delete_buckets_id_owners_id_with_http_infoc � sn | j ||f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d�d �I dH S ) a� Remove an owner from a bucket. Removes an owner from a bucket. Use this endpoint to remove a user's `owner` role for a bucket. #### InfluxDB Cloud - Doesn't use `owner` and `member` roles. Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions. #### Limitations - Owner permissions are separate from API token permissions. - Owner permissions are used in the context of the InfluxDB UI. #### Required permissions - `write-orgs INFLUX_ORG_ID` *`INFLUX_ORG_ID`* is the ID of the organization that you want to remove an owner from. #### Related endpoints - [Authorizations](#tag/Authorizations-(API-tokens)) #### Related guides - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) This method makes an asynchronous HTTP request. :param async_req bool :param str user_id: The ID of the owner to remove. (required) :param str bucket_id: The ID of the bucket to remove an owner from. (required) :param str zap_trace_span: OpenTracing span context :return: None If the method is called asynchronously, returns the request thread. rI r Nr r r Tr r r rJ rC r r r �!delete_buckets_id_owners_id_async� s( � �z0BucketsService.delete_buckets_id_owners_id_asyncc K s� t � }dddg}| �d||� d|ks2|d d kr:td��d|ksN|d d krVtd��i }d|krn|d |d< d|kr�|d |d< g }i }d|kr�|d |d < d } | j�d g�|d < ||||| fS ) Nr> r r( rH zSMissing the required parameter `user_id` when calling `delete_buckets_id_owners_id`zUMissing the required parameter `bucket_id` when calling `delete_buckets_id_owners_id`rE r) r* r+ r, r- rF r r r rK � s2 � � �z3BucketsService._delete_buckets_id_owners_id_preparec K s2 d|d< |� d�r | jf |�S | jf |�}|S dS )a� List buckets. Lists [buckets](https://docs.influxdata.com/influxdb/latest/reference/glossary/#bucket). InfluxDB retrieves buckets owned by the [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization) associated with the authorization ([API token](https://docs.influxdata.com/influxdb/latest/reference/glossary/#token)). To limit which buckets are returned, pass query parameters in your request. If no query parameters are passed, InfluxDB returns all buckets up to the default `limit`. #### InfluxDB OSS - If you use an _[operator token](https://docs.influxdata.com/influxdb/latest/security/tokens/#operator-token)_ to authenticate your request, InfluxDB retrieves resources for _all organizations_ in the instance. To retrieve resources for only a specific organization, use the `org` parameter or the `orgID` parameter to specify the organization. #### Required permissions | Action | Permission required | |:--------------------------|:--------------------| | Retrieve _user buckets_ | `read-buckets` | | Retrieve [_system buckets_](https://docs.influxdata.com/influxdb/latest/reference/internals/system-buckets/) | `read-orgs` | #### Related Guides - [Manage buckets](https://docs.influxdata.com/influxdb/latest/organizations/buckets/) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_buckets(async_req=True) >>> result = thread.get() :param async_req bool :param str zap_trace_span: OpenTracing span context :param int offset: The offset for pagination. The number of records to skip. For more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/latest/api/#tag/Pagination). :param int limit: Limits the number of records returned. Default is `20`. :param str after: A resource ID to seek from. Returns records created after the specified record; results don't include the specified record. Use `after` instead of the `offset` parameter. For more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/latest/api/#tag/Pagination). :param str org: An organization name. #### InfluxDB Cloud - Doesn't use the `org` parameter or `orgID` parameter. - Lists buckets for the organization associated with the authorization (API token). #### InfluxDB OSS - Lists buckets for the specified organization. :param str org_id: An organization ID. #### InfluxDB Cloud - Doesn't use the `org` parameter or `orgID` parameter. - Lists buckets for the organization associated with the authorization (API token). #### InfluxDB OSS - Requires either the `org` parameter or `orgID` parameter. - Lists buckets for the specified organization. :param str name: A bucket name. Only returns buckets with the specified name. :param str id: A bucket ID. Only returns the bucket with the specified ID. :return: Buckets If the method is called asynchronously, returns the request thread. Tr r N)r �get_buckets_with_http_info)r r r r r r � get_buckets s zBucketsService.get_bucketsc K sd | j f |�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d �d �S ) a� List buckets. Lists [buckets](https://docs.influxdata.com/influxdb/latest/reference/glossary/#bucket). InfluxDB retrieves buckets owned by the [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization) associated with the authorization ([API token](https://docs.influxdata.com/influxdb/latest/reference/glossary/#token)). To limit which buckets are returned, pass query parameters in your request. If no query parameters are passed, InfluxDB returns all buckets up to the default `limit`. #### InfluxDB OSS - If you use an _[operator token](https://docs.influxdata.com/influxdb/latest/security/tokens/#operator-token)_ to authenticate your request, InfluxDB retrieves resources for _all organizations_ in the instance. To retrieve resources for only a specific organization, use the `org` parameter or the `orgID` parameter to specify the organization. #### Required permissions | Action | Permission required | |:--------------------------|:--------------------| | Retrieve _user buckets_ | `read-buckets` | | Retrieve [_system buckets_](https://docs.influxdata.com/influxdb/latest/reference/internals/system-buckets/) | `read-orgs` | #### Related Guides - [Manage buckets](https://docs.influxdata.com/influxdb/latest/organizations/buckets/) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_buckets_with_http_info(async_req=True) >>> result = thread.get() :param async_req bool :param str zap_trace_span: OpenTracing span context :param int offset: The offset for pagination. The number of records to skip. For more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/latest/api/#tag/Pagination). :param int limit: Limits the number of records returned. Default is `20`. :param str after: A resource ID to seek from. Returns records created after the specified record; results don't include the specified record. Use `after` instead of the `offset` parameter. For more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/latest/api/#tag/Pagination). :param str org: An organization name. #### InfluxDB Cloud - Doesn't use the `org` parameter or `orgID` parameter. - Lists buckets for the organization associated with the authorization (API token). #### InfluxDB OSS - Lists buckets for the specified organization. :param str org_id: An organization ID. #### InfluxDB Cloud - Doesn't use the `org` parameter or `orgID` parameter. - Lists buckets for the organization associated with the authorization (API token). #### InfluxDB OSS - Requires either the `org` parameter or `orgID` parameter. - Lists buckets for the specified organization. :param str name: A bucket name. Only returns buckets with the specified name. :param str id: A bucket ID. Only returns the bucket with the specified ID. :return: Buckets If the method is called asynchronously, returns the request thread. �/api/v2/buckets�GET�Bucketsr r r Tr r Nr ��_get_buckets_preparer r r �r r r" r# r$ r% r& r r r rM 1 s( � �z)BucketsService.get_buckets_with_http_infoc � sj | j f |�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d �d �I d H S ) a� List buckets. Lists [buckets](https://docs.influxdata.com/influxdb/latest/reference/glossary/#bucket). InfluxDB retrieves buckets owned by the [organization](https://docs.influxdata.com/influxdb/latest/reference/glossary/#organization) associated with the authorization ([API token](https://docs.influxdata.com/influxdb/latest/reference/glossary/#token)). To limit which buckets are returned, pass query parameters in your request. If no query parameters are passed, InfluxDB returns all buckets up to the default `limit`. #### InfluxDB OSS - If you use an _[operator token](https://docs.influxdata.com/influxdb/latest/security/tokens/#operator-token)_ to authenticate your request, InfluxDB retrieves resources for _all organizations_ in the instance. To retrieve resources for only a specific organization, use the `org` parameter or the `orgID` parameter to specify the organization. #### Required permissions | Action | Permission required | |:--------------------------|:--------------------| | Retrieve _user buckets_ | `read-buckets` | | Retrieve [_system buckets_](https://docs.influxdata.com/influxdb/latest/reference/internals/system-buckets/) | `read-orgs` | #### Related Guides - [Manage buckets](https://docs.influxdata.com/influxdb/latest/organizations/buckets/) This method makes an asynchronous HTTP request. :param async_req bool :param str zap_trace_span: OpenTracing span context :param int offset: The offset for pagination. The number of records to skip. For more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/latest/api/#tag/Pagination). :param int limit: Limits the number of records returned. Default is `20`. :param str after: A resource ID to seek from. Returns records created after the specified record; results don't include the specified record. Use `after` instead of the `offset` parameter. For more information about pagination parameters, see [Pagination](https://docs.influxdata.com/influxdb/latest/api/#tag/Pagination). :param str org: An organization name. #### InfluxDB Cloud - Doesn't use the `org` parameter or `orgID` parameter. - Lists buckets for the organization associated with the authorization (API token). #### InfluxDB OSS - Lists buckets for the specified organization. :param str org_id: An organization ID. #### InfluxDB Cloud - Doesn't use the `org` parameter or `orgID` parameter. - Lists buckets for the organization associated with the authorization (API token). #### InfluxDB OSS - Requires either the `org` parameter or `orgID` parameter. - Lists buckets for the specified organization. :param str name: A bucket name. Only returns buckets with the specified name. :param str id: A bucket ID. Only returns the bucket with the specified ID. :return: Buckets If the method is called asynchronously, returns the request thread. rO rP rQ r r r Tr r Nr rR rT r r r �get_buckets_async[ s( � �z BucketsService.get_buckets_asyncc K s~ t � }ddddddddg}| �d ||� d|krD|d d k rDtd ��d|kr`|d d kr`td ��d|kr||d dk r|td��i }g }d|kr�|�d|d f� d|kr�|�d|d f� d|kr�|�d|d f� d|kr�|�d|d f� d|k�r|�d|d f� d|k�r$|�d|d f� d|k�r@|�d|d f� i }d|k�rZ|d |d< d }| j�dg�|d< |||||fS )Nr( �offset�limit�after�orgZorg_id�name�idrN r zmInvalid value for parameter `offset` when calling `get_buckets`, must be a value greater than or equal to `0`�d zkInvalid value for parameter `limit` when calling `get_buckets`, must be a value less than or equal to `100`� zlInvalid value for parameter `limit` when calling `get_buckets`, must be a value greater than or equal to `1`ZorgIDr* r+ r, �r. r/ r0 �appendr r1 )r r r" r3 r# r$ r% r& r r r rS � sB �z#BucketsService._get_buckets_preparec K s6 d|d< |� d�r | j|f|�S | j|f|�}|S dS )a� Retrieve a bucket. Retrieves a bucket. Use this endpoint to retrieve information for a specific bucket. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_buckets_id(bucket_id, async_req=True) >>> result = thread.get() :param async_req bool :param str bucket_id: The ID of the bucket to retrieve. (required) :param str zap_trace_span: OpenTracing span context :return: Bucket If the method is called asynchronously, returns the request thread. Tr r N)r � get_buckets_id_with_http_infor r r r �get_buckets_id� s z BucketsService.get_buckets_idc K sf | j |f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d �d �S ) a� Retrieve a bucket. Retrieves a bucket. Use this endpoint to retrieve information for a specific bucket. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_buckets_id_with_http_info(bucket_id, async_req=True) >>> result = thread.get() :param async_req bool :param str bucket_id: The ID of the bucket to retrieve. (required) :param str zap_trace_span: OpenTracing span context :return: Bucket If the method is called asynchronously, returns the request thread. r rP �Bucketr r r Tr r Nr ��_get_buckets_id_preparer r r r! r r r r` � s( � �z,BucketsService.get_buckets_id_with_http_infoc � sl | j |f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d �d �I d H S ) a� Retrieve a bucket. Retrieves a bucket. Use this endpoint to retrieve information for a specific bucket. This method makes an asynchronous HTTP request. :param async_req bool :param str bucket_id: The ID of the bucket to retrieve. (required) :param str zap_trace_span: OpenTracing span context :return: Bucket If the method is called asynchronously, returns the request thread. r rP rb r r r Tr r Nr rc r! r r r �get_buckets_id_async� s( � �z#BucketsService.get_buckets_id_asyncc K s� t � }ddg}| �d||� d|ks0|d d kr8td��i }d|krP|d |d< g }i }d|krl|d |d< d }| j�dg�|d< |||||fS ) Nr r( ra zHMissing the required parameter `bucket_id` when calling `get_buckets_id`r) r* r+ r, r- r2 r r r rd s& � �z&BucketsService._get_buckets_id_preparec K s6 d|d< |� d�r | j|f|�S | j|f|�}|S dS )a� List all labels for a bucket. Lists all labels for a bucket. Labels are objects that contain `labelID`, `name`, `description`, and `color` key-value pairs. They may be used for grouping and filtering InfluxDB resources. Labels are also capable of grouping across different resources--for example, you can apply a label named `air_sensor` to a bucket and a task to quickly organize resources. #### Related guides - Use the [`/api/v2/labels` InfluxDB API endpoint](#tag/Labels) to retrieve and manage labels. - [Manage labels in the InfluxDB UI](https://docs.influxdata.com/influxdb/latest/visualize-data/labels/) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_buckets_id_labels(bucket_id, async_req=True) >>> result = thread.get() :param async_req bool :param str bucket_id: The ID of the bucket to retrieve labels for. (required) :param str zap_trace_span: OpenTracing span context :return: LabelsResponse If the method is called asynchronously, returns the request thread. Tr r N)r �$get_buckets_id_labels_with_http_infor r r r �get_buckets_id_labels" s z$BucketsService.get_buckets_id_labelsc K sf | j |f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d �d �S ) a� List all labels for a bucket. Lists all labels for a bucket. Labels are objects that contain `labelID`, `name`, `description`, and `color` key-value pairs. They may be used for grouping and filtering InfluxDB resources. Labels are also capable of grouping across different resources--for example, you can apply a label named `air_sensor` to a bucket and a task to quickly organize resources. #### Related guides - Use the [`/api/v2/labels` InfluxDB API endpoint](#tag/Labels) to retrieve and manage labels. - [Manage labels in the InfluxDB UI](https://docs.influxdata.com/influxdb/latest/visualize-data/labels/) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_buckets_id_labels_with_http_info(bucket_id, async_req=True) >>> result = thread.get() :param async_req bool :param str bucket_id: The ID of the bucket to retrieve labels for. (required) :param str zap_trace_span: OpenTracing span context :return: LabelsResponse If the method is called asynchronously, returns the request thread. �!/api/v2/buckets/{bucketID}/labelsrP �LabelsResponser r r Tr r Nr �� _get_buckets_id_labels_preparer r r r! r r r rf 9 s( � �z3BucketsService.get_buckets_id_labels_with_http_infoc � sl | j |f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d �d �I d H S ) a� List all labels for a bucket. Lists all labels for a bucket. Labels are objects that contain `labelID`, `name`, `description`, and `color` key-value pairs. They may be used for grouping and filtering InfluxDB resources. Labels are also capable of grouping across different resources--for example, you can apply a label named `air_sensor` to a bucket and a task to quickly organize resources. #### Related guides - Use the [`/api/v2/labels` InfluxDB API endpoint](#tag/Labels) to retrieve and manage labels. - [Manage labels in the InfluxDB UI](https://docs.influxdata.com/influxdb/latest/visualize-data/labels/) This method makes an asynchronous HTTP request. :param async_req bool :param str bucket_id: The ID of the bucket to retrieve labels for. (required) :param str zap_trace_span: OpenTracing span context :return: LabelsResponse If the method is called asynchronously, returns the request thread. rh rP ri r r r Tr r Nr rj r! r r r �get_buckets_id_labels_async] s( � �z*BucketsService.get_buckets_id_labels_asyncc K s� t � }ddg}| �d||� d|ks0|d d kr8td��i }d|krP|d |d< g }i }d|krl|d |d< d }| j�dg�|d< |||||fS ) Nr r( rg zOMissing the required parameter `bucket_id` when calling `get_buckets_id_labels`r) r* r+ r, r- r2 r r r rk ~ s& � �z-BucketsService._get_buckets_id_labels_preparec K s6 d|d< |� d�r | j|f|�S | j|f|�}|S dS )a� List all users with member privileges for a bucket. Lists all users for a bucket. InfluxDB [users](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) have permission to access InfluxDB. [Members](https://docs.influxdata.com/influxdb/latest/reference/glossary/#member) are users in an organization with access to the specified resource. Use this endpoint to retrieve all users with access to a bucket. #### Related guides - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) - [Manage members](https://docs.influxdata.com/influxdb/latest/organizations/members/) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_buckets_id_members(bucket_id, async_req=True) >>> result = thread.get() :param async_req bool :param str bucket_id: The ID of the bucket to retrieve users for. (required) :param str zap_trace_span: OpenTracing span context :return: ResourceMembers If the method is called asynchronously, returns the request thread. Tr r N)r �%get_buckets_id_members_with_http_infor r r r �get_buckets_id_members� s z%BucketsService.get_buckets_id_membersc K sf | j |f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d �d �S ) a� List all users with member privileges for a bucket. Lists all users for a bucket. InfluxDB [users](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) have permission to access InfluxDB. [Members](https://docs.influxdata.com/influxdb/latest/reference/glossary/#member) are users in an organization with access to the specified resource. Use this endpoint to retrieve all users with access to a bucket. #### Related guides - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) - [Manage members](https://docs.influxdata.com/influxdb/latest/organizations/members/) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_buckets_id_members_with_http_info(bucket_id, async_req=True) >>> result = thread.get() :param async_req bool :param str bucket_id: The ID of the bucket to retrieve users for. (required) :param str zap_trace_span: OpenTracing span context :return: ResourceMembers If the method is called asynchronously, returns the request thread. �"/api/v2/buckets/{bucketID}/membersrP �ResourceMembersr r r Tr r Nr �� _get_buckets_id_members_preparer r r r! r r r rm � s( � �z4BucketsService.get_buckets_id_members_with_http_infoc � sl | j |f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d �d �I d H S ) a� List all users with member privileges for a bucket. Lists all users for a bucket. InfluxDB [users](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) have permission to access InfluxDB. [Members](https://docs.influxdata.com/influxdb/latest/reference/glossary/#member) are users in an organization with access to the specified resource. Use this endpoint to retrieve all users with access to a bucket. #### Related guides - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) - [Manage members](https://docs.influxdata.com/influxdb/latest/organizations/members/) This method makes an asynchronous HTTP request. :param async_req bool :param str bucket_id: The ID of the bucket to retrieve users for. (required) :param str zap_trace_span: OpenTracing span context :return: ResourceMembers If the method is called asynchronously, returns the request thread. ro rP rp r r r Tr r Nr rq r! r r r � get_buckets_id_members_async� s( � �z+BucketsService.get_buckets_id_members_asyncc K s� t � }ddg}| �d||� d|ks0|d d kr8td��i }d|krP|d |d< g }i }d|krl|d |d< d }| j�dg�|d< |||||fS ) Nr r( rn zPMissing the required parameter `bucket_id` when calling `get_buckets_id_members`r) r* r+ r, r- r2 r r r rr � s& � �z.BucketsService._get_buckets_id_members_preparec K s6 d|d< |� d�r | j|f|�S | j|f|�}|S dS )a� List all owners of a bucket. Lists all [owners](https://docs.influxdata.com/influxdb/latest/reference/glossary/#owner) of a bucket. Bucket owners have permission to delete buckets and remove user and member permissions from the bucket. #### InfluxDB Cloud - Doesn't use `owner` and `member` roles. Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions. #### Limitations - Owner permissions are separate from API token permissions. - Owner permissions are used in the context of the InfluxDB UI. #### Required permissions - `read-orgs INFLUX_ORG_ID` *`INFLUX_ORG_ID`* is the ID of the organization that you want to retrieve a list of owners for. #### Related endpoints - [Authorizations](#tag/Authorizations-(API-tokens)) #### Related guides - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_buckets_id_owners(bucket_id, async_req=True) >>> result = thread.get() :param async_req bool :param str bucket_id: The ID of the bucket to retrieve owners for. (required) :param str zap_trace_span: OpenTracing span context :return: ResourceOwners If the method is called asynchronously, returns the request thread. Tr r N)r �$get_buckets_id_owners_with_http_infor r r r �get_buckets_id_owners s z$BucketsService.get_buckets_id_ownersc K sf | j |f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d �d �S ) a� List all owners of a bucket. Lists all [owners](https://docs.influxdata.com/influxdb/latest/reference/glossary/#owner) of a bucket. Bucket owners have permission to delete buckets and remove user and member permissions from the bucket. #### InfluxDB Cloud - Doesn't use `owner` and `member` roles. Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions. #### Limitations - Owner permissions are separate from API token permissions. - Owner permissions are used in the context of the InfluxDB UI. #### Required permissions - `read-orgs INFLUX_ORG_ID` *`INFLUX_ORG_ID`* is the ID of the organization that you want to retrieve a list of owners for. #### Related endpoints - [Authorizations](#tag/Authorizations-(API-tokens)) #### Related guides - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_buckets_id_owners_with_http_info(bucket_id, async_req=True) >>> result = thread.get() :param async_req bool :param str bucket_id: The ID of the bucket to retrieve owners for. (required) :param str zap_trace_span: OpenTracing span context :return: ResourceOwners If the method is called asynchronously, returns the request thread. �!/api/v2/buckets/{bucketID}/ownersrP �ResourceOwnersr r r Tr r Nr �� _get_buckets_id_owners_preparer r r r! r r r rt ' s( � �z3BucketsService.get_buckets_id_owners_with_http_infoc � sl | j |f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d �d �I d H S ) a� List all owners of a bucket. Lists all [owners](https://docs.influxdata.com/influxdb/latest/reference/glossary/#owner) of a bucket. Bucket owners have permission to delete buckets and remove user and member permissions from the bucket. #### InfluxDB Cloud - Doesn't use `owner` and `member` roles. Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions. #### Limitations - Owner permissions are separate from API token permissions. - Owner permissions are used in the context of the InfluxDB UI. #### Required permissions - `read-orgs INFLUX_ORG_ID` *`INFLUX_ORG_ID`* is the ID of the organization that you want to retrieve a list of owners for. #### Related endpoints - [Authorizations](#tag/Authorizations-(API-tokens)) #### Related guides - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) This method makes an asynchronous HTTP request. :param async_req bool :param str bucket_id: The ID of the bucket to retrieve owners for. (required) :param str zap_trace_span: OpenTracing span context :return: ResourceOwners If the method is called asynchronously, returns the request thread. rv rP rw r r r Tr r Nr rx r! r r r �get_buckets_id_owners_asyncK s( � �z*BucketsService.get_buckets_id_owners_asyncc K s� t � }ddg}| �d||� d|ks0|d d kr8td��i }d|krP|d |d< g }i }d|krl|d |d< d }| j�dg�|d< |||||fS ) Nr r( ru zOMissing the required parameter `bucket_id` when calling `get_buckets_id_owners`r) r* r+ r, r- r2 r r r ry l s& � �z-BucketsService._get_buckets_id_owners_preparec K s6 d|d< |� d�r | j|f|�S | j|f|�}|S dS )aa Get buckets in a source. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_sources_id_buckets(source_id, async_req=True) >>> result = thread.get() :param async_req bool :param str source_id: The source ID. (required) :param str zap_trace_span: OpenTracing span context :param str org: The name of the organization. :return: Buckets If the method is called asynchronously, returns the request thread. Tr r N)r �%get_sources_id_buckets_with_http_info)r � source_idr r r r r �get_sources_id_buckets� s z%BucketsService.get_sources_id_bucketsc K sf | j |f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d �d �S ) ap Get buckets in a source. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_sources_id_buckets_with_http_info(source_id, async_req=True) >>> result = thread.get() :param async_req bool :param str source_id: The source ID. (required) :param str zap_trace_span: OpenTracing span context :param str org: The name of the organization. :return: Buckets If the method is called asynchronously, returns the request thread. �"/api/v2/sources/{sourceID}/bucketsrP rQ r r r Tr r Nr �� _get_sources_id_buckets_preparer r r �r r| r r" r# r$ r% r& r r r r{ � s( � �z4BucketsService.get_sources_id_buckets_with_http_infoc � sl | j |f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d �d �I d H S ) a� Get buckets in a source. This method makes an asynchronous HTTP request. :param async_req bool :param str source_id: The source ID. (required) :param str zap_trace_span: OpenTracing span context :param str org: The name of the organization. :return: Buckets If the method is called asynchronously, returns the request thread. r~ rP rQ r r r Tr r Nr r r� r r r � get_sources_id_buckets_async� s( � �z+BucketsService.get_sources_id_buckets_asyncc K s� t � }dddg}| �d||� d|ks2|d d kr:td��i }d|krR|d |d< g }d|krp|�d|d f� i }d|kr�|d |d< d }| j�dg�|d < |||||fS ) Nr| r( rY r} zPMissing the required parameter `source_id` when calling `get_sources_id_buckets`ZsourceIDr* r+ r, r^ ) r r| r r" r3 r# r$ r% r& r r r r� � s* � �z.BucketsService._get_sources_id_buckets_preparec K s: d|d< |� d�r"| j||f|�S | j||f|�}|S dS )ao Update a bucket. Updates a bucket. Use this endpoint to update properties (`name`, `description`, and `retentionRules`) of a bucket. #### InfluxDB Cloud - Requires the `retentionRules` property in the request body. If you don't provide `retentionRules`, InfluxDB responds with an HTTP `403` status code. #### InfluxDB OSS - Doesn't require `retentionRules`. #### Related Guides - [Update a bucket](https://docs.influxdata.com/influxdb/latest/organizations/buckets/update-bucket/) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.patch_buckets_id(bucket_id, patch_bucket_request, async_req=True) >>> result = thread.get() :param async_req bool :param str bucket_id: The bucket ID. (required) :param PatchBucketRequest patch_bucket_request: The bucket update to apply. (required) :param str zap_trace_span: OpenTracing span context :return: Bucket If the method is called asynchronously, returns the request thread. Tr r N)r � patch_buckets_id_with_http_info)r r �patch_bucket_requestr r r r r �patch_buckets_id s z BucketsService.patch_buckets_idc K sh | j ||f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d �d �S ) a~ Update a bucket. Updates a bucket. Use this endpoint to update properties (`name`, `description`, and `retentionRules`) of a bucket. #### InfluxDB Cloud - Requires the `retentionRules` property in the request body. If you don't provide `retentionRules`, InfluxDB responds with an HTTP `403` status code. #### InfluxDB OSS - Doesn't require `retentionRules`. #### Related Guides - [Update a bucket](https://docs.influxdata.com/influxdb/latest/organizations/buckets/update-bucket/) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.patch_buckets_id_with_http_info(bucket_id, patch_bucket_request, async_req=True) >>> result = thread.get() :param async_req bool :param str bucket_id: The bucket ID. (required) :param PatchBucketRequest patch_bucket_request: The bucket update to apply. (required) :param str zap_trace_span: OpenTracing span context :return: Bucket If the method is called asynchronously, returns the request thread. r �PATCHrb r r r Tr r Nr ��_patch_buckets_id_preparer r r � r r r� r r" r# r$ r% r& r r r r� s( � �z.BucketsService.patch_buckets_id_with_http_infoc � sn | j ||f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d �d �I d H S ) a� Update a bucket. Updates a bucket. Use this endpoint to update properties (`name`, `description`, and `retentionRules`) of a bucket. #### InfluxDB Cloud - Requires the `retentionRules` property in the request body. If you don't provide `retentionRules`, InfluxDB responds with an HTTP `403` status code. #### InfluxDB OSS - Doesn't require `retentionRules`. #### Related Guides - [Update a bucket](https://docs.influxdata.com/influxdb/latest/organizations/buckets/update-bucket/) This method makes an asynchronous HTTP request. :param async_req bool :param str bucket_id: The bucket ID. (required) :param PatchBucketRequest patch_bucket_request: The bucket update to apply. (required) :param str zap_trace_span: OpenTracing span context :return: Bucket If the method is called asynchronously, returns the request thread. r r� rb r r r Tr r Nr r� r� r r r �patch_buckets_id_async= s( � �z%BucketsService.patch_buckets_id_asyncc K s� t � }dddg}| �d||� d|ks2|d d kr:td��d|ksN|d d krVtd��i }d|krn|d |d< g }i }d|kr�|d |d< d } d|kr�|d } | j�d g�|d < | j�d g�|d < ||||| fS ) Nr r� r( r� zJMissing the required parameter `bucket_id` when calling `patch_buckets_id`zUMissing the required parameter `patch_bucket_request` when calling `patch_buckets_id`r) r* r+ r, � Content-Type�r. r/ r0 r r1 Zselect_header_content_type) r r r� r r" r3 r# r$ r% r& r r r r� _ s8 � � ��z(BucketsService._patch_buckets_id_preparec K s6 d|d< |� d�r | j|f|�S | j|f|�}|S dS )aV Create a bucket. Creates a [bucket](https://docs.influxdata.com/influxdb/latest/reference/glossary/#bucket) and returns the bucket resource. The default data [retention period](https://docs.influxdata.com/influxdb/latest/reference/glossary/#retention-period) is 30 days. #### InfluxDB OSS - A single InfluxDB OSS instance supports active writes or queries for approximately 20 buckets across all organizations at a given time. Reading or writing to more than 20 buckets at a time can adversely affect performance. #### Limitations - InfluxDB Cloud Free Plan allows users to create up to two buckets. Exceeding the bucket quota will result in an HTTP `403` status code. For additional information regarding InfluxDB Cloud offerings, see [InfluxDB Cloud Pricing](https://www.influxdata.com/influxdb-cloud-pricing/). #### Related Guides - [Create a bucket](https://docs.influxdata.com/influxdb/latest/organizations/buckets/create-bucket/) - [Create bucket CLI reference](https://docs.influxdata.com/influxdb/latest/reference/cli/influx/bucket/create) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.post_buckets(post_bucket_request, async_req=True) >>> result = thread.get() :param async_req bool :param PostBucketRequest post_bucket_request: The bucket to create. (required) :param str zap_trace_span: OpenTracing span context :return: Bucket If the method is called asynchronously, returns the request thread. Tr r N)r �post_buckets_with_http_info)r �post_bucket_requestr r r r r � post_buckets� s zBucketsService.post_bucketsc K sf | j |f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d �d �S ) ae Create a bucket. Creates a [bucket](https://docs.influxdata.com/influxdb/latest/reference/glossary/#bucket) and returns the bucket resource. The default data [retention period](https://docs.influxdata.com/influxdb/latest/reference/glossary/#retention-period) is 30 days. #### InfluxDB OSS - A single InfluxDB OSS instance supports active writes or queries for approximately 20 buckets across all organizations at a given time. Reading or writing to more than 20 buckets at a time can adversely affect performance. #### Limitations - InfluxDB Cloud Free Plan allows users to create up to two buckets. Exceeding the bucket quota will result in an HTTP `403` status code. For additional information regarding InfluxDB Cloud offerings, see [InfluxDB Cloud Pricing](https://www.influxdata.com/influxdb-cloud-pricing/). #### Related Guides - [Create a bucket](https://docs.influxdata.com/influxdb/latest/organizations/buckets/create-bucket/) - [Create bucket CLI reference](https://docs.influxdata.com/influxdb/latest/reference/cli/influx/bucket/create) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.post_buckets_with_http_info(post_bucket_request, async_req=True) >>> result = thread.get() :param async_req bool :param PostBucketRequest post_bucket_request: The bucket to create. (required) :param str zap_trace_span: OpenTracing span context :return: Bucket If the method is called asynchronously, returns the request thread. rO �POSTrb r r r Tr r Nr ��_post_buckets_preparer r r �r r� r r" r# r$ r% r& r r r r� � s( � �z*BucketsService.post_buckets_with_http_infoc � sl | j |f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d �d �I d H S ) a� Create a bucket. Creates a [bucket](https://docs.influxdata.com/influxdb/latest/reference/glossary/#bucket) and returns the bucket resource. The default data [retention period](https://docs.influxdata.com/influxdb/latest/reference/glossary/#retention-period) is 30 days. #### InfluxDB OSS - A single InfluxDB OSS instance supports active writes or queries for approximately 20 buckets across all organizations at a given time. Reading or writing to more than 20 buckets at a time can adversely affect performance. #### Limitations - InfluxDB Cloud Free Plan allows users to create up to two buckets. Exceeding the bucket quota will result in an HTTP `403` status code. For additional information regarding InfluxDB Cloud offerings, see [InfluxDB Cloud Pricing](https://www.influxdata.com/influxdb-cloud-pricing/). #### Related Guides - [Create a bucket](https://docs.influxdata.com/influxdb/latest/organizations/buckets/create-bucket/) - [Create bucket CLI reference](https://docs.influxdata.com/influxdb/latest/reference/cli/influx/bucket/create) This method makes an asynchronous HTTP request. :param async_req bool :param PostBucketRequest post_bucket_request: The bucket to create. (required) :param str zap_trace_span: OpenTracing span context :return: Bucket If the method is called asynchronously, returns the request thread. rO r� rb r r r Tr r Nr r� r� r r r �post_buckets_async� s( � �z!BucketsService.post_buckets_asyncc K s� t � }ddg}| �d||� d|ks0|d d kr8td��i }g }i }d|krX|d |d< d }d|krl|d }| j�dg�|d< | j�dg�|d< |||||fS ) Nr� r( r� zPMissing the required parameter `post_bucket_request` when calling `post_buckets`r* r+ r, r� r� ) r r� r r" r3 r# r$ r% r& r r r r� � s, � ��z$BucketsService._post_buckets_preparec K s: d|d< |� d�r"| j||f|�S | j||f|�}|S dS )a� Add a label to a bucket. Adds a label to a bucket and returns the new label information. Labels are objects that contain `labelID`, `name`, `description`, and `color` key-value pairs. They may be used for grouping and filtering across one or more kinds of **resources**--for example, you can apply a label named `air_sensor` to a bucket and a task to quickly organize resources. #### Limitations - Before adding a label to a bucket, you must create the label if you haven't already. To create a label with the InfluxDB API, send a `POST` request to the [`/api/v2/labels` endpoint](#operation/PostLabels)). #### Related guides - Use the [`/api/v2/labels` InfluxDB API endpoint](#tag/Labels) to retrieve and manage labels. - [Manage labels in the InfluxDB UI](https://docs.influxdata.com/influxdb/latest/visualize-data/labels/) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.post_buckets_id_labels(bucket_id, label_mapping, async_req=True) >>> result = thread.get() :param async_req bool :param str bucket_id: Bucket ID. The ID of the bucket to label. (required) :param LabelMapping label_mapping: An object that contains a _`labelID`_ to add to the bucket. (required) :param str zap_trace_span: OpenTracing span context :return: LabelResponse If the method is called asynchronously, returns the request thread. Tr r N)r �%post_buckets_id_labels_with_http_info)r r � label_mappingr r r r r �post_buckets_id_labels� s z%BucketsService.post_buckets_id_labelsc K sh | j ||f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d �d �S ) a Add a label to a bucket. Adds a label to a bucket and returns the new label information. Labels are objects that contain `labelID`, `name`, `description`, and `color` key-value pairs. They may be used for grouping and filtering across one or more kinds of **resources**--for example, you can apply a label named `air_sensor` to a bucket and a task to quickly organize resources. #### Limitations - Before adding a label to a bucket, you must create the label if you haven't already. To create a label with the InfluxDB API, send a `POST` request to the [`/api/v2/labels` endpoint](#operation/PostLabels)). #### Related guides - Use the [`/api/v2/labels` InfluxDB API endpoint](#tag/Labels) to retrieve and manage labels. - [Manage labels in the InfluxDB UI](https://docs.influxdata.com/influxdb/latest/visualize-data/labels/) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.post_buckets_id_labels_with_http_info(bucket_id, label_mapping, async_req=True) >>> result = thread.get() :param async_req bool :param str bucket_id: Bucket ID. The ID of the bucket to label. (required) :param LabelMapping label_mapping: An object that contains a _`labelID`_ to add to the bucket. (required) :param str zap_trace_span: OpenTracing span context :return: LabelResponse If the method is called asynchronously, returns the request thread. rh r� � LabelResponser r r Tr r Nr �� _post_buckets_id_labels_preparer r r � r r r� r r" r# r$ r% r& r r r r� s( � �z4BucketsService.post_buckets_id_labels_with_http_infoc � sn | j ||f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d �d �I d H S ) a1 Add a label to a bucket. Adds a label to a bucket and returns the new label information. Labels are objects that contain `labelID`, `name`, `description`, and `color` key-value pairs. They may be used for grouping and filtering across one or more kinds of **resources**--for example, you can apply a label named `air_sensor` to a bucket and a task to quickly organize resources. #### Limitations - Before adding a label to a bucket, you must create the label if you haven't already. To create a label with the InfluxDB API, send a `POST` request to the [`/api/v2/labels` endpoint](#operation/PostLabels)). #### Related guides - Use the [`/api/v2/labels` InfluxDB API endpoint](#tag/Labels) to retrieve and manage labels. - [Manage labels in the InfluxDB UI](https://docs.influxdata.com/influxdb/latest/visualize-data/labels/) This method makes an asynchronous HTTP request. :param async_req bool :param str bucket_id: Bucket ID. The ID of the bucket to label. (required) :param LabelMapping label_mapping: An object that contains a _`labelID`_ to add to the bucket. (required) :param str zap_trace_span: OpenTracing span context :return: LabelResponse If the method is called asynchronously, returns the request thread. rh r� r� r r r Tr r Nr r� r� r r r � post_buckets_id_labels_async< s( � �z+BucketsService.post_buckets_id_labels_asyncc K s� t � }dddg}| �d||� d|ks2|d d kr:td��d|ksN|d d krVtd��i }d|krn|d |d< g }i }d|kr�|d |d< d } d|kr�|d } | j�d g�|d < | j�d g�|d < ||||| fS ) Nr r� r( r� zPMissing the required parameter `bucket_id` when calling `post_buckets_id_labels`zTMissing the required parameter `label_mapping` when calling `post_buckets_id_labels`r) r* r+ r, r� r� ) r r r� r r" r3 r# r$ r% r& r r r r� ^ s8 � � ��z.BucketsService._post_buckets_id_labels_preparec K s: d|d< |� d�r"| j||f|�S | j||f|�}|S dS )a Add a member to a bucket. Add a user to a bucket and return the new user information. InfluxDB [users](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) have permission to access InfluxDB. [Members](https://docs.influxdata.com/influxdb/latest/reference/glossary/#member) are users in an organization. Use this endpoint to give a user member privileges to a bucket. #### Related guides - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) - [Manage members](https://docs.influxdata.com/influxdb/latest/organizations/members/) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.post_buckets_id_members(bucket_id, add_resource_member_request_body, async_req=True) >>> result = thread.get() :param async_req bool :param str bucket_id: The ID of the bucket to retrieve users for. (required) :param AddResourceMemberRequestBody add_resource_member_request_body: A user to add as a member to the bucket. (required) :param str zap_trace_span: OpenTracing span context :return: ResourceMember If the method is called asynchronously, returns the request thread. Tr r N)r �&post_buckets_id_members_with_http_info�r r � add_resource_member_request_bodyr r r r r �post_buckets_id_members� s z&BucketsService.post_buckets_id_membersc K sh | j ||f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d �d �S ) a( Add a member to a bucket. Add a user to a bucket and return the new user information. InfluxDB [users](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) have permission to access InfluxDB. [Members](https://docs.influxdata.com/influxdb/latest/reference/glossary/#member) are users in an organization. Use this endpoint to give a user member privileges to a bucket. #### Related guides - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) - [Manage members](https://docs.influxdata.com/influxdb/latest/organizations/members/) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.post_buckets_id_members_with_http_info(bucket_id, add_resource_member_request_body, async_req=True) >>> result = thread.get() :param async_req bool :param str bucket_id: The ID of the bucket to retrieve users for. (required) :param AddResourceMemberRequestBody add_resource_member_request_body: A user to add as a member to the bucket. (required) :param str zap_trace_span: OpenTracing span context :return: ResourceMember If the method is called asynchronously, returns the request thread. ro r� �ResourceMemberr r r Tr r Nr �� _post_buckets_id_members_preparer r r � r r r� r r" r# r$ r% r& r r r r� � s( � �z5BucketsService.post_buckets_id_members_with_http_infoc � sn | j ||f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d �d �I d H S ) a7 Add a member to a bucket. Add a user to a bucket and return the new user information. InfluxDB [users](https://docs.influxdata.com/influxdb/latest/reference/glossary/#user) have permission to access InfluxDB. [Members](https://docs.influxdata.com/influxdb/latest/reference/glossary/#member) are users in an organization. Use this endpoint to give a user member privileges to a bucket. #### Related guides - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) - [Manage members](https://docs.influxdata.com/influxdb/latest/organizations/members/) This method makes an asynchronous HTTP request. :param async_req bool :param str bucket_id: The ID of the bucket to retrieve users for. (required) :param AddResourceMemberRequestBody add_resource_member_request_body: A user to add as a member to the bucket. (required) :param str zap_trace_span: OpenTracing span context :return: ResourceMember If the method is called asynchronously, returns the request thread. ro r� r� r r r Tr r Nr r� r� r r r � post_buckets_id_members_async� s( � �z,BucketsService.post_buckets_id_members_asyncc K s� t � }dddg}| �d||� d|ks2|d d kr:td��d|ksN|d d krVtd��i }d|krn|d |d< g }i }d|kr�|d |d< d } d|kr�|d } | j�d g�|d < | j�d g�|d < ||||| fS ) Nr r� r( r� zQMissing the required parameter `bucket_id` when calling `post_buckets_id_members`zhMissing the required parameter `add_resource_member_request_body` when calling `post_buckets_id_members`r) r* r+ r, r� r� � r r r� r r" r3 r# r$ r% r& r r r r� � s8 � � ��z/BucketsService._post_buckets_id_members_preparec K s: d|d< |� d�r"| j||f|�S | j||f|�}|S dS )a� Add an owner to a bucket. Adds an owner to a bucket and returns the [owners](https://docs.influxdata.com/influxdb/latest/reference/glossary/#owner) with role and user detail. Use this endpoint to create a _resource owner_ for the bucket. Bucket owners have permission to delete buckets and remove user and member permissions from the bucket. #### InfluxDB Cloud - Doesn't use `owner` and `member` roles. Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions. #### Limitations - Owner permissions are separate from API token permissions. - Owner permissions are used in the context of the InfluxDB UI. #### Required permissions - `write-orgs INFLUX_ORG_ID` *`INFLUX_ORG_ID`* is the ID of the organization that you want to add an owner for. #### Related endpoints - [Authorizations](#tag/Authorizations-(API-tokens)) #### Related guides - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.post_buckets_id_owners(bucket_id, add_resource_member_request_body, async_req=True) >>> result = thread.get() :param async_req bool :param str bucket_id: The ID of the bucket to add an owner for. (required) :param AddResourceMemberRequestBody add_resource_member_request_body: A user to add as an owner for the bucket. (required) :param str zap_trace_span: OpenTracing span context :return: ResourceOwner If the method is called asynchronously, returns the request thread. Tr r N)r �%post_buckets_id_owners_with_http_infor� r r r �post_buckets_id_owners s z%BucketsService.post_buckets_id_ownersc K sh | j ||f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d �d �S ) a� Add an owner to a bucket. Adds an owner to a bucket and returns the [owners](https://docs.influxdata.com/influxdb/latest/reference/glossary/#owner) with role and user detail. Use this endpoint to create a _resource owner_ for the bucket. Bucket owners have permission to delete buckets and remove user and member permissions from the bucket. #### InfluxDB Cloud - Doesn't use `owner` and `member` roles. Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions. #### Limitations - Owner permissions are separate from API token permissions. - Owner permissions are used in the context of the InfluxDB UI. #### Required permissions - `write-orgs INFLUX_ORG_ID` *`INFLUX_ORG_ID`* is the ID of the organization that you want to add an owner for. #### Related endpoints - [Authorizations](#tag/Authorizations-(API-tokens)) #### Related guides - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.post_buckets_id_owners_with_http_info(bucket_id, add_resource_member_request_body, async_req=True) >>> result = thread.get() :param async_req bool :param str bucket_id: The ID of the bucket to add an owner for. (required) :param AddResourceMemberRequestBody add_resource_member_request_body: A user to add as an owner for the bucket. (required) :param str zap_trace_span: OpenTracing span context :return: ResourceOwner If the method is called asynchronously, returns the request thread. rv r� � ResourceOwnerr r r Tr r Nr �� _post_buckets_id_owners_preparer r r r� r r r r� s( � �z4BucketsService.post_buckets_id_owners_with_http_infoc � sn | j ||f|�\}}}}}| jjdd||||g i dg |�d�|�d�|�dd�|�d�i |�d d �d �I d H S ) a� Add an owner to a bucket. Adds an owner to a bucket and returns the [owners](https://docs.influxdata.com/influxdb/latest/reference/glossary/#owner) with role and user detail. Use this endpoint to create a _resource owner_ for the bucket. Bucket owners have permission to delete buckets and remove user and member permissions from the bucket. #### InfluxDB Cloud - Doesn't use `owner` and `member` roles. Use [`/api/v2/authorizations`](#tag/Authorizations-(API-tokens)) to assign user permissions. #### Limitations - Owner permissions are separate from API token permissions. - Owner permissions are used in the context of the InfluxDB UI. #### Required permissions - `write-orgs INFLUX_ORG_ID` *`INFLUX_ORG_ID`* is the ID of the organization that you want to add an owner for. #### Related endpoints - [Authorizations](#tag/Authorizations-(API-tokens)) #### Related guides - [Manage users](https://docs.influxdata.com/influxdb/latest/users/) This method makes an asynchronous HTTP request. :param async_req bool :param str bucket_id: The ID of the bucket to add an owner for. (required) :param AddResourceMemberRequestBody add_resource_member_request_body: A user to add as an owner for the bucket. (required) :param str zap_trace_span: OpenTracing span context :return: ResourceOwner If the method is called asynchronously, returns the request thread. rv r� r� r r r Tr r Nr r� r� r r r � post_buckets_id_owners_asyncD s( � �z+BucketsService.post_buckets_id_owners_asyncc K s� t � }dddg}| �d||� d|ks2|d d kr:td��d|ksN|d d krVtd��i }d|krn|d |d< g }i }d|kr�|d |d< d } d|kr�|d } | j�d g�|d < | j�d g�|d < ||||| fS ) Nr r� r( r� zPMissing the required parameter `bucket_id` when calling `post_buckets_id_owners`zgMissing the required parameter `add_resource_member_request_body` when calling `post_buckets_id_owners`r) r* r+ r, r� r� r� r r r r� f s8 � � ��z.BucketsService._post_buckets_id_owners_prepare)N)B�__name__� __module__� __qualname__�__doc__r r r r' r r6 r4 r; r9 r? r< rD rB rH rG rL rK rN rM rU rS ra r` re rd rg rf rl rk rn rm rs rr ru rt rz ry r} r{ r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� � __classcell__r r r r r s| $!$!!%"!%"! *')$!$!$!$!$! %"%$! %"%%"%%"r )r� � __future__r �reZ%influxdb_client.service._base_servicer r r r r r �<module> s
💾 Save Changes
❌ Cancel