Public Member Functions
	__construct (DefaultApi $defaultApi)

	deleteBucketsID ($bucket_id, $zap_trace_span=null)

	deleteBucketsIDWithHttpInfo ($bucket_id, $zap_trace_span=null)

	deleteBucketsIDLabelsID ($bucket_id, $label_id, $zap_trace_span=null)

	deleteBucketsIDLabelsIDWithHttpInfo ($bucket_id, $label_id, $zap_trace_span=null)

	deleteBucketsIDMembersID ($user_id, $bucket_id, $zap_trace_span=null)

	deleteBucketsIDMembersIDWithHttpInfo ($user_id, $bucket_id, $zap_trace_span=null)

	deleteBucketsIDOwnersID ($user_id, $bucket_id, $zap_trace_span=null)

	deleteBucketsIDOwnersIDWithHttpInfo ($user_id, $bucket_id, $zap_trace_span=null)

	getBuckets ($zap_trace_span=null, $offset=null, $limit=20, $after=null, $org=null, $org_id=null, $name=null, $id=null)

	getBucketsWithHttpInfo ($zap_trace_span=null, $offset=null, $limit=20, $after=null, $org=null, $org_id=null, $name=null, $id=null)

	getBucketsID ($bucket_id, $zap_trace_span=null)

	getBucketsIDWithHttpInfo ($bucket_id, $zap_trace_span=null)

	getBucketsIDLabels ($bucket_id, $zap_trace_span=null)

	getBucketsIDLabelsWithHttpInfo ($bucket_id, $zap_trace_span=null)

	getBucketsIDMembers ($bucket_id, $zap_trace_span=null)

	getBucketsIDMembersWithHttpInfo ($bucket_id, $zap_trace_span=null)

	getBucketsIDOwners ($bucket_id, $zap_trace_span=null)

	getBucketsIDOwnersWithHttpInfo ($bucket_id, $zap_trace_span=null)

	getSourcesIDBuckets ($source_id, $zap_trace_span=null, $org=null)

	getSourcesIDBucketsWithHttpInfo ($source_id, $zap_trace_span=null, $org=null)

	patchBucketsID ($bucket_id, $patch_bucket_request, $zap_trace_span=null)

	patchBucketsIDWithHttpInfo ($bucket_id, $patch_bucket_request, $zap_trace_span=null)

	postBuckets ($post_bucket_request, $zap_trace_span=null)

	postBucketsWithHttpInfo ($post_bucket_request, $zap_trace_span=null)

	postBucketsIDLabels ($bucket_id, $label_mapping, $zap_trace_span=null)

	postBucketsIDLabelsWithHttpInfo ($bucket_id, $label_mapping, $zap_trace_span=null)

	postBucketsIDMembers ($bucket_id, $add_resource_member_request_body, $zap_trace_span=null)

	postBucketsIDMembersWithHttpInfo ($bucket_id, $add_resource_member_request_body, $zap_trace_span=null)

	postBucketsIDOwners ($bucket_id, $add_resource_member_request_body, $zap_trace_span=null)

	postBucketsIDOwnersWithHttpInfo ($bucket_id, $add_resource_member_request_body, $zap_trace_span=null)

Protected Member Functions
	deleteBucketsIDRequest ($bucket_id, $zap_trace_span=null)

	deleteBucketsIDLabelsIDRequest ($bucket_id, $label_id, $zap_trace_span=null)

	deleteBucketsIDMembersIDRequest ($user_id, $bucket_id, $zap_trace_span=null)

	deleteBucketsIDOwnersIDRequest ($user_id, $bucket_id, $zap_trace_span=null)

	getBucketsRequest ($zap_trace_span=null, $offset=null, $limit=20, $after=null, $org=null, $org_id=null, $name=null, $id=null)

	getBucketsIDRequest ($bucket_id, $zap_trace_span=null)

	getBucketsIDLabelsRequest ($bucket_id, $zap_trace_span=null)

	getBucketsIDMembersRequest ($bucket_id, $zap_trace_span=null)

	getBucketsIDOwnersRequest ($bucket_id, $zap_trace_span=null)

	getSourcesIDBucketsRequest ($source_id, $zap_trace_span=null, $org=null)

	patchBucketsIDRequest ($bucket_id, $patch_bucket_request, $zap_trace_span=null)

	postBucketsRequest ($post_bucket_request, $zap_trace_span=null)

	postBucketsIDLabelsRequest ($bucket_id, $label_mapping, $zap_trace_span=null)

	postBucketsIDMembersRequest ($bucket_id, $add_resource_member_request_body, $zap_trace_span=null)

	postBucketsIDOwnersRequest ($bucket_id, $add_resource_member_request_body, $zap_trace_span=null)

Protected Attributes
	$defaultApi

	$headerSelector

Constructor & Destructor Documentation

◆ __construct()

InfluxDB2\Service\BucketsService::__construct ( DefaultApi $defaultApi )

Parameters

DefaultApi	$defaultApi
HeaderSelector	$selector

Member Function Documentation

◆ deleteBucketsID()

InfluxDB2\Service\BucketsService::deleteBucketsID	(		$bucket_id,
			$zap_trace_span = null )

Operation deleteBucketsID

Delete a bucket

Parameters

string	$bucket_id	Bucket ID. The ID of the bucket to delete. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: void

◆ deleteBucketsIDLabelsID()

InfluxDB2\Service\BucketsService::deleteBucketsIDLabelsID	(	$bucket_id,
		$label_id,
		$zap_trace_span = null )

Operation deleteBucketsIDLabelsID

Delete a label from a bucket

Parameters

string	$bucket_id	The bucket ID. (required)
string	$label_id	The ID of the label to delete. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: void

◆ deleteBucketsIDLabelsIDRequest()

InfluxDB2\Service\BucketsService::deleteBucketsIDLabelsIDRequest	(	$bucket_id,
		$label_id,
		$zap_trace_span = null )

protected

Create request for operation 'deleteBucketsIDLabelsID'

Parameters

string	$bucket_id	The bucket ID. (required)
string	$label_id	The ID of the label to delete. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ deleteBucketsIDLabelsIDWithHttpInfo()

InfluxDB2\Service\BucketsService::deleteBucketsIDLabelsIDWithHttpInfo	(	$bucket_id,
		$label_id,
		$zap_trace_span = null )

Operation deleteBucketsIDLabelsIDWithHttpInfo

Delete a label from a bucket

Parameters

string	$bucket_id	The bucket ID. (required)
string	$label_id	The ID of the label to delete. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: array of null, HTTP status code, HTTP response headers (array of strings)

◆ deleteBucketsIDMembersID()

InfluxDB2\Service\BucketsService::deleteBucketsIDMembersID	(	$user_id,
		$bucket_id,
		$zap_trace_span = null )

Operation deleteBucketsIDMembersID

Remove a member from a bucket

Parameters

string	$user_id	The ID of the user to remove. (required)
string	$bucket_id	The ID of the bucket to remove a user from. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: void

◆ deleteBucketsIDMembersIDRequest()

InfluxDB2\Service\BucketsService::deleteBucketsIDMembersIDRequest	(	$user_id,
		$bucket_id,
		$zap_trace_span = null )

protected

Create request for operation 'deleteBucketsIDMembersID'

Parameters

string	$user_id	The ID of the user to remove. (required)
string	$bucket_id	The ID of the bucket to remove a user from. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ deleteBucketsIDMembersIDWithHttpInfo()

InfluxDB2\Service\BucketsService::deleteBucketsIDMembersIDWithHttpInfo	(	$user_id,
		$bucket_id,
		$zap_trace_span = null )

Operation deleteBucketsIDMembersIDWithHttpInfo

Remove a member from a bucket

Parameters

string	$user_id	The ID of the user to remove. (required)
string	$bucket_id	The ID of the bucket to remove a user from. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: array of null, HTTP status code, HTTP response headers (array of strings)

◆ deleteBucketsIDOwnersID()

InfluxDB2\Service\BucketsService::deleteBucketsIDOwnersID	(	$user_id,
		$bucket_id,
		$zap_trace_span = null )

Operation deleteBucketsIDOwnersID

Remove an owner from a bucket

Parameters

string	$user_id	The ID of the owner to remove. (required)
string	$bucket_id	The bucket ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: void

◆ deleteBucketsIDOwnersIDRequest()

InfluxDB2\Service\BucketsService::deleteBucketsIDOwnersIDRequest	(	$user_id,
		$bucket_id,
		$zap_trace_span = null )

protected

Create request for operation 'deleteBucketsIDOwnersID'

Parameters

string	$user_id	The ID of the owner to remove. (required)
string	$bucket_id	The bucket ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ deleteBucketsIDOwnersIDWithHttpInfo()

InfluxDB2\Service\BucketsService::deleteBucketsIDOwnersIDWithHttpInfo	(	$user_id,
		$bucket_id,
		$zap_trace_span = null )

Operation deleteBucketsIDOwnersIDWithHttpInfo

Remove an owner from a bucket

Parameters

string	$user_id	The ID of the owner to remove. (required)
string	$bucket_id	The bucket ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: array of null, HTTP status code, HTTP response headers (array of strings)

◆ deleteBucketsIDRequest()

InfluxDB2\Service\BucketsService::deleteBucketsIDRequest	(		$bucket_id,
			$zap_trace_span = null )

protected

Create request for operation 'deleteBucketsID'

Parameters

string	$bucket_id	Bucket ID. The ID of the bucket to delete. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ deleteBucketsIDWithHttpInfo()

InfluxDB2\Service\BucketsService::deleteBucketsIDWithHttpInfo	(		$bucket_id,
			$zap_trace_span = null )

Operation deleteBucketsIDWithHttpInfo

Delete a bucket

Parameters

string	$bucket_id	Bucket ID. The ID of the bucket to delete. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: array of null, HTTP status code, HTTP response headers (array of strings)

◆ getBuckets()

InfluxDB2\Service\BucketsService::getBuckets	(	$zap_trace_span = null,
		$offset = null,
		$limit = 20,
		$after = null,
		$org = null,
		$org_id = null,
		$name = null,
		$id = null )

Operation getBuckets

List buckets

Parameters

string	$zap_trace_span	OpenTracing span context (optional)
int	$offset	The offset for pagination. The number of records to skip. (optional)
int	$limit	Limits the number of records returned. Default is `20`. (optional, default to 20)
string	$after	Resource ID to seek from. Results are not inclusive of this ID. Use `after` instead of `offset`. (optional)
string	$org	Organization name. The name of the organization. #### InfluxDB Cloud - Doesn't use `org` or `orgID`. - Creates a bucket in the organization associated with the authorization (API token). #### InfluxDB OSS - Accepts either `org` or `orgID`. - InfluxDB creates the bucket within this organization. (optional)
string	$org_id	Organization ID. The organization ID. #### InfluxDB Cloud - Doesn't use `org` or `orgID`. - Creates a bucket in the organization associated with the authorization (API token). #### InfluxDB OSS - Accepts either `org` or `orgID`. - InfluxDB creates the bucket within this organization. (optional)
string	$name	Bucket name. Only returns buckets with this specific name. (optional)
string	$id	Bucket ID. Only returns the bucket with this ID. (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\Buckets|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ getBucketsID()

InfluxDB2\Service\BucketsService::getBucketsID	(		$bucket_id,
			$zap_trace_span = null )

Operation getBucketsID

Retrieve a bucket

Parameters

string	$bucket_id	The ID of the bucket to retrieve. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\Bucket|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ getBucketsIDLabels()

InfluxDB2\Service\BucketsService::getBucketsIDLabels	(		$bucket_id,
			$zap_trace_span = null )

Operation getBucketsIDLabels

List all labels for a bucket

Parameters

string	$bucket_id	The ID of the bucket to retrieve labels for. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\LabelsResponse|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ getBucketsIDLabelsRequest()

InfluxDB2\Service\BucketsService::getBucketsIDLabelsRequest	(		$bucket_id,
			$zap_trace_span = null )

protected

Create request for operation 'getBucketsIDLabels'

Parameters

string	$bucket_id	The ID of the bucket to retrieve labels for. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ getBucketsIDLabelsWithHttpInfo()

InfluxDB2\Service\BucketsService::getBucketsIDLabelsWithHttpInfo	(		$bucket_id,
			$zap_trace_span = null )

Operation getBucketsIDLabelsWithHttpInfo

List all labels for a bucket

Parameters

string	$bucket_id	The ID of the bucket to retrieve labels for. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: array of \InfluxDB2\Model\LabelsResponse|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ getBucketsIDMembers()

InfluxDB2\Service\BucketsService::getBucketsIDMembers	(		$bucket_id,
			$zap_trace_span = null )

Operation getBucketsIDMembers

List all users with member privileges for a bucket

Parameters

string	$bucket_id	The ID of the bucket to retrieve users for. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\ResourceMembers|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ getBucketsIDMembersRequest()

InfluxDB2\Service\BucketsService::getBucketsIDMembersRequest	(		$bucket_id,
			$zap_trace_span = null )

protected

Create request for operation 'getBucketsIDMembers'

Parameters

string	$bucket_id	The ID of the bucket to retrieve users for. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ getBucketsIDMembersWithHttpInfo()

InfluxDB2\Service\BucketsService::getBucketsIDMembersWithHttpInfo	(		$bucket_id,
			$zap_trace_span = null )

Operation getBucketsIDMembersWithHttpInfo

List all users with member privileges for a bucket

Parameters

string	$bucket_id	The ID of the bucket to retrieve users for. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: array of \InfluxDB2\Model\ResourceMembers|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ getBucketsIDOwners()

InfluxDB2\Service\BucketsService::getBucketsIDOwners	(		$bucket_id,
			$zap_trace_span = null )

Operation getBucketsIDOwners

List all owners of a bucket

Parameters

string	$bucket_id	The bucket ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\ResourceOwners|\InfluxDB2\Model\Error

◆ getBucketsIDOwnersRequest()

InfluxDB2\Service\BucketsService::getBucketsIDOwnersRequest	(		$bucket_id,
			$zap_trace_span = null )

protected

Create request for operation 'getBucketsIDOwners'

Parameters

string	$bucket_id	The bucket ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ getBucketsIDOwnersWithHttpInfo()

InfluxDB2\Service\BucketsService::getBucketsIDOwnersWithHttpInfo	(		$bucket_id,
			$zap_trace_span = null )

Operation getBucketsIDOwnersWithHttpInfo

List all owners of a bucket

Parameters

string	$bucket_id	The bucket ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: array of \InfluxDB2\Model\ResourceOwners|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ getBucketsIDRequest()

InfluxDB2\Service\BucketsService::getBucketsIDRequest	(		$bucket_id,
			$zap_trace_span = null )

protected

Create request for operation 'getBucketsID'

Parameters

string	$bucket_id	The ID of the bucket to retrieve. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ getBucketsIDWithHttpInfo()

InfluxDB2\Service\BucketsService::getBucketsIDWithHttpInfo	(		$bucket_id,
			$zap_trace_span = null )

Operation getBucketsIDWithHttpInfo

Retrieve a bucket

Parameters

string	$bucket_id	The ID of the bucket to retrieve. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: array of \InfluxDB2\Model\Bucket|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ getBucketsRequest()

InfluxDB2\Service\BucketsService::getBucketsRequest	(	$zap_trace_span = null,
		$offset = null,
		$limit = 20,
		$after = null,
		$org = null,
		$org_id = null,
		$name = null,
		$id = null )

protected

Create request for operation 'getBuckets'

Parameters

string	$zap_trace_span	OpenTracing span context (optional)
int	$offset	The offset for pagination. The number of records to skip. (optional)
int	$limit	Limits the number of records returned. Default is `20`. (optional, default to 20)
string	$after	Resource ID to seek from. Results are not inclusive of this ID. Use `after` instead of `offset`. (optional)
string	$org	Organization name. The name of the organization. #### InfluxDB Cloud - Doesn't use `org` or `orgID`. - Creates a bucket in the organization associated with the authorization (API token). #### InfluxDB OSS - Accepts either `org` or `orgID`. - InfluxDB creates the bucket within this organization. (optional)
string	$org_id	Organization ID. The organization ID. #### InfluxDB Cloud - Doesn't use `org` or `orgID`. - Creates a bucket in the organization associated with the authorization (API token). #### InfluxDB OSS - Accepts either `org` or `orgID`. - InfluxDB creates the bucket within this organization. (optional)
string	$name	Bucket name. Only returns buckets with this specific name. (optional)
string	$id	Bucket ID. Only returns the bucket with this ID. (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ getBucketsWithHttpInfo()

InfluxDB2\Service\BucketsService::getBucketsWithHttpInfo	(	$zap_trace_span = null,
		$offset = null,
		$limit = 20,
		$after = null,
		$org = null,
		$org_id = null,
		$name = null,
		$id = null )

Operation getBucketsWithHttpInfo

List buckets

Parameters

string	$zap_trace_span	OpenTracing span context (optional)
int	$offset	The offset for pagination. The number of records to skip. (optional)
int	$limit	Limits the number of records returned. Default is `20`. (optional, default to 20)
string	$after	Resource ID to seek from. Results are not inclusive of this ID. Use `after` instead of `offset`. (optional)
string	$org	Organization name. The name of the organization. #### InfluxDB Cloud - Doesn't use `org` or `orgID`. - Creates a bucket in the organization associated with the authorization (API token). #### InfluxDB OSS - Accepts either `org` or `orgID`. - InfluxDB creates the bucket within this organization. (optional)
string	$org_id	Organization ID. The organization ID. #### InfluxDB Cloud - Doesn't use `org` or `orgID`. - Creates a bucket in the organization associated with the authorization (API token). #### InfluxDB OSS - Accepts either `org` or `orgID`. - InfluxDB creates the bucket within this organization. (optional)
string	$name	Bucket name. Only returns buckets with this specific name. (optional)
string	$id	Bucket ID. Only returns the bucket with this ID. (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: array of \InfluxDB2\Model\Buckets|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ getSourcesIDBuckets()

InfluxDB2\Service\BucketsService::getSourcesIDBuckets	(	$source_id,
		$zap_trace_span = null,
		$org = null )

Operation getSourcesIDBuckets

Get buckets in a source

Parameters

string	$source_id	The source ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$org	The name of the organization. (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\Buckets|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ getSourcesIDBucketsRequest()

InfluxDB2\Service\BucketsService::getSourcesIDBucketsRequest	(	$source_id,
		$zap_trace_span = null,
		$org = null )

protected

Create request for operation 'getSourcesIDBuckets'

Parameters

string	$source_id	The source ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$org	The name of the organization. (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ getSourcesIDBucketsWithHttpInfo()

InfluxDB2\Service\BucketsService::getSourcesIDBucketsWithHttpInfo	(	$source_id,
		$zap_trace_span = null,
		$org = null )

Operation getSourcesIDBucketsWithHttpInfo

Get buckets in a source

Parameters

string	$source_id	The source ID. (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$org	The name of the organization. (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: array of \InfluxDB2\Model\Buckets|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ patchBucketsID()

InfluxDB2\Service\BucketsService::patchBucketsID	(	$bucket_id,
		$patch_bucket_request,
		$zap_trace_span = null )

Operation patchBucketsID

Update a bucket

Parameters

string	$bucket_id	The bucket ID. (required)
\InfluxDB2\Model\PatchBucketRequest	$patch_bucket_request	The bucket update to apply. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\Bucket|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ patchBucketsIDRequest()

InfluxDB2\Service\BucketsService::patchBucketsIDRequest	(	$bucket_id,
		$patch_bucket_request,
		$zap_trace_span = null )

protected

Create request for operation 'patchBucketsID'

Parameters

string	$bucket_id	The bucket ID. (required)
\InfluxDB2\Model\PatchBucketRequest	$patch_bucket_request	The bucket update to apply. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ patchBucketsIDWithHttpInfo()

InfluxDB2\Service\BucketsService::patchBucketsIDWithHttpInfo	(	$bucket_id,
		$patch_bucket_request,
		$zap_trace_span = null )

Operation patchBucketsIDWithHttpInfo

Update a bucket

Parameters

string	$bucket_id	The bucket ID. (required)
\InfluxDB2\Model\PatchBucketRequest	$patch_bucket_request	The bucket update to apply. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: array of \InfluxDB2\Model\Bucket|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ postBuckets()

InfluxDB2\Service\BucketsService::postBuckets	(		$post_bucket_request,
			$zap_trace_span = null )

Operation postBuckets

Create a bucket

Parameters

\InfluxDB2\Model\PostBucketRequest	$post_bucket_request	Bucket to create (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\Bucket|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ postBucketsIDLabels()

InfluxDB2\Service\BucketsService::postBucketsIDLabels	(	$bucket_id,
		$label_mapping,
		$zap_trace_span = null )

Operation postBucketsIDLabels

Add a label to a bucket

Parameters

string	$bucket_id	Bucket ID. The ID of the bucket to label. (required)
\InfluxDB2\Model\LabelMapping	$label_mapping	An object that contains a `labelID` to add to the bucket. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\LabelResponse|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ postBucketsIDLabelsRequest()

InfluxDB2\Service\BucketsService::postBucketsIDLabelsRequest	(	$bucket_id,
		$label_mapping,
		$zap_trace_span = null )

protected

Create request for operation 'postBucketsIDLabels'

Parameters

string	$bucket_id	Bucket ID. The ID of the bucket to label. (required)
\InfluxDB2\Model\LabelMapping	$label_mapping	An object that contains a `labelID` to add to the bucket. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ postBucketsIDLabelsWithHttpInfo()

InfluxDB2\Service\BucketsService::postBucketsIDLabelsWithHttpInfo	(	$bucket_id,
		$label_mapping,
		$zap_trace_span = null )

Operation postBucketsIDLabelsWithHttpInfo

Add a label to a bucket

Parameters

string	$bucket_id	Bucket ID. The ID of the bucket to label. (required)
\InfluxDB2\Model\LabelMapping	$label_mapping	An object that contains a `labelID` to add to the bucket. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: array of \InfluxDB2\Model\LabelResponse|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ postBucketsIDMembers()

InfluxDB2\Service\BucketsService::postBucketsIDMembers	(	$bucket_id,
		$add_resource_member_request_body,
		$zap_trace_span = null )

Operation postBucketsIDMembers

Add a member to a bucket

Parameters

string	$bucket_id	The ID of the bucket to retrieve users for. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody	$add_resource_member_request_body	A user to add as a member to the bucket. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\ResourceMember|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ postBucketsIDMembersRequest()

InfluxDB2\Service\BucketsService::postBucketsIDMembersRequest	(	$bucket_id,
		$add_resource_member_request_body,
		$zap_trace_span = null )

protected

Create request for operation 'postBucketsIDMembers'

Parameters

string	$bucket_id	The ID of the bucket to retrieve users for. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody	$add_resource_member_request_body	A user to add as a member to the bucket. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ postBucketsIDMembersWithHttpInfo()

InfluxDB2\Service\BucketsService::postBucketsIDMembersWithHttpInfo	(	$bucket_id,
		$add_resource_member_request_body,
		$zap_trace_span = null )

Operation postBucketsIDMembersWithHttpInfo

Add a member to a bucket

Parameters

string	$bucket_id	The ID of the bucket to retrieve users for. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody	$add_resource_member_request_body	A user to add as a member to the bucket. (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: array of \InfluxDB2\Model\ResourceMember|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ postBucketsIDOwners()

InfluxDB2\Service\BucketsService::postBucketsIDOwners	(	$bucket_id,
		$add_resource_member_request_body,
		$zap_trace_span = null )

Operation postBucketsIDOwners

Add an owner to a bucket

Parameters

string	$bucket_id	The bucket ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody	$add_resource_member_request_body	User to add as owner (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: \InfluxDB2\Model\ResourceOwner|\InfluxDB2\Model\Error

◆ postBucketsIDOwnersRequest()

InfluxDB2\Service\BucketsService::postBucketsIDOwnersRequest	(	$bucket_id,
		$add_resource_member_request_body,
		$zap_trace_span = null )

protected

Create request for operation 'postBucketsIDOwners'

Parameters

string	$bucket_id	The bucket ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody	$add_resource_member_request_body	User to add as owner (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ postBucketsIDOwnersWithHttpInfo()

InfluxDB2\Service\BucketsService::postBucketsIDOwnersWithHttpInfo	(	$bucket_id,
		$add_resource_member_request_body,
		$zap_trace_span = null )

Operation postBucketsIDOwnersWithHttpInfo

Add an owner to a bucket

Parameters

string	$bucket_id	The bucket ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody	$add_resource_member_request_body	User to add as owner (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: array of \InfluxDB2\Model\ResourceOwner|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ postBucketsRequest()

InfluxDB2\Service\BucketsService::postBucketsRequest	(		$post_bucket_request,
			$zap_trace_span = null )

protected

Create request for operation 'postBuckets'

Parameters

\InfluxDB2\Model\PostBucketRequest	$post_bucket_request	Bucket to create (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InvalidArgumentException

Returns: \Psr\Http\Message\RequestInterface

◆ postBucketsWithHttpInfo()

InfluxDB2\Service\BucketsService::postBucketsWithHttpInfo	(		$post_bucket_request,
			$zap_trace_span = null )

Operation postBucketsWithHttpInfo

Create a bucket

Parameters

\InfluxDB2\Model\PostBucketRequest	$post_bucket_request	Bucket to create (required)
string	$zap_trace_span	OpenTracing span context (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns: array of \InfluxDB2\Model\Bucket|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

The documentation for this class was generated from the following file:

src/InfluxDB2/Service/BucketsService.php

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ deleteBucketsID()

◆ deleteBucketsIDLabelsID()

◆ deleteBucketsIDLabelsIDRequest()

◆ deleteBucketsIDLabelsIDWithHttpInfo()

◆ deleteBucketsIDMembersID()

◆ deleteBucketsIDMembersIDRequest()

◆ deleteBucketsIDMembersIDWithHttpInfo()

◆ deleteBucketsIDOwnersID()

◆ deleteBucketsIDOwnersIDRequest()

◆ deleteBucketsIDOwnersIDWithHttpInfo()

◆ deleteBucketsIDRequest()

◆ deleteBucketsIDWithHttpInfo()

◆ getBuckets()

◆ getBucketsID()

◆ getBucketsIDLabels()

◆ getBucketsIDLabelsRequest()

◆ getBucketsIDLabelsWithHttpInfo()

◆ getBucketsIDMembers()

◆ getBucketsIDMembersRequest()

◆ getBucketsIDMembersWithHttpInfo()

◆ getBucketsIDOwners()

◆ getBucketsIDOwnersRequest()

◆ getBucketsIDOwnersWithHttpInfo()

◆ getBucketsIDRequest()

◆ getBucketsIDWithHttpInfo()

◆ getBucketsRequest()

◆ getBucketsWithHttpInfo()

◆ getSourcesIDBuckets()

◆ getSourcesIDBucketsRequest()

◆ getSourcesIDBucketsWithHttpInfo()

◆ patchBucketsID()

◆ patchBucketsIDRequest()

◆ patchBucketsIDWithHttpInfo()

◆ postBuckets()

◆ postBucketsIDLabels()

◆ postBucketsIDLabelsRequest()

◆ postBucketsIDLabelsWithHttpInfo()

◆ postBucketsIDMembers()

◆ postBucketsIDMembersRequest()

◆ postBucketsIDMembersWithHttpInfo()

◆ postBucketsIDOwners()

◆ postBucketsIDOwnersRequest()

◆ postBucketsIDOwnersWithHttpInfo()

◆ postBucketsRequest()

◆ postBucketsWithHttpInfo()