InfluxDB PHP Client
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
InfluxDB2\Service\BucketsService Class Reference

Public Member Functions

 __construct (ClientInterface $client=null, Configuration $config=null, HeaderSelector $selector=null)
 
 getConfig ()
 
 deleteBucketsID ($bucket_id, $zap_trace_span=null)
 
 deleteBucketsIDWithHttpInfo ($bucket_id, $zap_trace_span=null)
 
 deleteBucketsIDAsync ($bucket_id, $zap_trace_span=null)
 
 deleteBucketsIDAsyncWithHttpInfo ($bucket_id, $zap_trace_span=null)
 
 deleteBucketsIDLabelsID ($bucket_id, $label_id, $zap_trace_span=null)
 
 deleteBucketsIDLabelsIDWithHttpInfo ($bucket_id, $label_id, $zap_trace_span=null)
 
 deleteBucketsIDLabelsIDAsync ($bucket_id, $label_id, $zap_trace_span=null)
 
 deleteBucketsIDLabelsIDAsyncWithHttpInfo ($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)
 
 deleteBucketsIDMembersIDAsync ($user_id, $bucket_id, $zap_trace_span=null)
 
 deleteBucketsIDMembersIDAsyncWithHttpInfo ($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)
 
 deleteBucketsIDOwnersIDAsync ($user_id, $bucket_id, $zap_trace_span=null)
 
 deleteBucketsIDOwnersIDAsyncWithHttpInfo ($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)
 
 getBucketsAsync ($zap_trace_span=null, $offset=null, $limit=20, $after=null, $org=null, $org_id=null, $name=null, $id=null)
 
 getBucketsAsyncWithHttpInfo ($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)
 
 getBucketsIDAsync ($bucket_id, $zap_trace_span=null)
 
 getBucketsIDAsyncWithHttpInfo ($bucket_id, $zap_trace_span=null)
 
 getBucketsIDLabels ($bucket_id, $zap_trace_span=null)
 
 getBucketsIDLabelsWithHttpInfo ($bucket_id, $zap_trace_span=null)
 
 getBucketsIDLabelsAsync ($bucket_id, $zap_trace_span=null)
 
 getBucketsIDLabelsAsyncWithHttpInfo ($bucket_id, $zap_trace_span=null)
 
 getBucketsIDMembers ($bucket_id, $zap_trace_span=null)
 
 getBucketsIDMembersWithHttpInfo ($bucket_id, $zap_trace_span=null)
 
 getBucketsIDMembersAsync ($bucket_id, $zap_trace_span=null)
 
 getBucketsIDMembersAsyncWithHttpInfo ($bucket_id, $zap_trace_span=null)
 
 getBucketsIDOwners ($bucket_id, $zap_trace_span=null)
 
 getBucketsIDOwnersWithHttpInfo ($bucket_id, $zap_trace_span=null)
 
 getBucketsIDOwnersAsync ($bucket_id, $zap_trace_span=null)
 
 getBucketsIDOwnersAsyncWithHttpInfo ($bucket_id, $zap_trace_span=null)
 
 getSourcesIDBuckets ($source_id, $zap_trace_span=null, $org=null)
 
 getSourcesIDBucketsWithHttpInfo ($source_id, $zap_trace_span=null, $org=null)
 
 getSourcesIDBucketsAsync ($source_id, $zap_trace_span=null, $org=null)
 
 getSourcesIDBucketsAsyncWithHttpInfo ($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)
 
 patchBucketsIDAsync ($bucket_id, $patch_bucket_request, $zap_trace_span=null)
 
 patchBucketsIDAsyncWithHttpInfo ($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)
 
 postBucketsAsync ($post_bucket_request, $zap_trace_span=null)
 
 postBucketsAsyncWithHttpInfo ($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)
 
 postBucketsIDLabelsAsync ($bucket_id, $label_mapping, $zap_trace_span=null)
 
 postBucketsIDLabelsAsyncWithHttpInfo ($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)
 
 postBucketsIDMembersAsync ($bucket_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 postBucketsIDMembersAsyncWithHttpInfo ($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)
 
 postBucketsIDOwnersAsync ($bucket_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 postBucketsIDOwnersAsyncWithHttpInfo ($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)
 
 createHttpClientOption ()
 

Protected Attributes

 $client
 
 $config
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

InfluxDB2\Service\BucketsService::__construct ( ClientInterface  $client = null,
Configuration  $config = null,
HeaderSelector  $selector = null 
)
Parameters
ClientInterface$client
Configuration$config
HeaderSelector$selector

Member Function Documentation

◆ createHttpClientOption()

InfluxDB2\Service\BucketsService::createHttpClientOption ( )
protected

Create http client option

Exceptions

RuntimeException on file opening failure

Returns
array of http client options

◆ deleteBucketsID()

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

Operation deleteBucketsID

Delete a bucket

Parameters
string$bucket_idThe ID of the bucket to delete. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteBucketsIDAsync()

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

Operation deleteBucketsIDAsync

Delete a bucket

Parameters
string$bucket_idThe ID of the bucket to delete. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteBucketsIDAsyncWithHttpInfo()

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

Operation deleteBucketsIDAsyncWithHttpInfo

Delete a bucket

Parameters
string$bucket_idThe ID of the bucket to delete. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteBucketsIDLabelsID()

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

Operation deleteBucketsIDLabelsID

Delete a label from a bucket

Parameters
string$bucket_idThe bucket ID. (required)
string$label_idThe ID of the label to delete. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteBucketsIDLabelsIDAsync()

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

Operation deleteBucketsIDLabelsIDAsync

Delete a label from a bucket

Parameters
string$bucket_idThe bucket ID. (required)
string$label_idThe ID of the label to delete. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteBucketsIDLabelsIDAsyncWithHttpInfo()

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

Operation deleteBucketsIDLabelsIDAsyncWithHttpInfo

Delete a label from a bucket

Parameters
string$bucket_idThe bucket ID. (required)
string$label_idThe ID of the label to delete. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteBucketsIDLabelsIDRequest()

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

Create request for operation 'deleteBucketsIDLabelsID'

Parameters
string$bucket_idThe bucket ID. (required)
string$label_idThe ID of the label to delete. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ deleteBucketsIDLabelsIDWithHttpInfo()

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

Operation deleteBucketsIDLabelsIDWithHttpInfo

Delete a label from a bucket

Parameters
string$bucket_idThe bucket ID. (required)
string$label_idThe ID of the label to delete. (required)
string$zap_trace_spanOpenTracing 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_idThe ID of the member to remove. (required)
string$bucket_idThe bucket ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteBucketsIDMembersIDAsync()

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

Operation deleteBucketsIDMembersIDAsync

Remove a member from a bucket

Parameters
string$user_idThe ID of the member to remove. (required)
string$bucket_idThe bucket ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteBucketsIDMembersIDAsyncWithHttpInfo()

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

Operation deleteBucketsIDMembersIDAsyncWithHttpInfo

Remove a member from a bucket

Parameters
string$user_idThe ID of the member to remove. (required)
string$bucket_idThe bucket ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteBucketsIDMembersIDRequest()

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

Create request for operation 'deleteBucketsIDMembersID'

Parameters
string$user_idThe ID of the member to remove. (required)
string$bucket_idThe bucket ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ deleteBucketsIDMembersIDWithHttpInfo()

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

Operation deleteBucketsIDMembersIDWithHttpInfo

Remove a member from a bucket

Parameters
string$user_idThe ID of the member to remove. (required)
string$bucket_idThe bucket ID. (required)
string$zap_trace_spanOpenTracing 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_idThe ID of the owner to remove. (required)
string$bucket_idThe bucket ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteBucketsIDOwnersIDAsync()

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

Operation deleteBucketsIDOwnersIDAsync

Remove an owner from a bucket

Parameters
string$user_idThe ID of the owner to remove. (required)
string$bucket_idThe bucket ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteBucketsIDOwnersIDAsyncWithHttpInfo()

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

Operation deleteBucketsIDOwnersIDAsyncWithHttpInfo

Remove an owner from a bucket

Parameters
string$user_idThe ID of the owner to remove. (required)
string$bucket_idThe bucket ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteBucketsIDOwnersIDRequest()

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

Create request for operation 'deleteBucketsIDOwnersID'

Parameters
string$user_idThe ID of the owner to remove. (required)
string$bucket_idThe bucket ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ deleteBucketsIDOwnersIDWithHttpInfo()

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

Operation deleteBucketsIDOwnersIDWithHttpInfo

Remove an owner from a bucket

Parameters
string$user_idThe ID of the owner to remove. (required)
string$bucket_idThe bucket ID. (required)
string$zap_trace_spanOpenTracing 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_idThe ID of the bucket to delete. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ deleteBucketsIDWithHttpInfo()

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

Operation deleteBucketsIDWithHttpInfo

Delete a bucket

Parameters
string$bucket_idThe ID of the bucket to delete. (required)
string$zap_trace_spanOpenTracing 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 all buckets

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$offsetoffset (optional)
int$limitlimit (optional, default to 20)
string$afterThe last resource ID from which to seek from (but not including). This is to be used instead of `offset`. (optional)
string$orgThe name of the organization. (optional)
string$org_idThe organization ID. (optional)
string$nameOnly returns buckets with a specific name. (optional)
string$idOnly returns buckets with a specific ID. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getBucketsAsync()

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

Operation getBucketsAsync

List all buckets

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$offset(optional)
int$limit(optional, default to 20)
string$afterThe last resource ID from which to seek from (but not including). This is to be used instead of `offset`. (optional)
string$orgThe name of the organization. (optional)
string$org_idThe organization ID. (optional)
string$nameOnly returns buckets with a specific name. (optional)
string$idOnly returns buckets with a specific ID. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getBucketsAsyncWithHttpInfo()

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

Operation getBucketsAsyncWithHttpInfo

List all buckets

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$offset(optional)
int$limit(optional, default to 20)
string$afterThe last resource ID from which to seek from (but not including). This is to be used instead of `offset`. (optional)
string$orgThe name of the organization. (optional)
string$org_idThe organization ID. (optional)
string$nameOnly returns buckets with a specific name. (optional)
string$idOnly returns buckets with a specific ID. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getBucketsID()

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

Operation getBucketsID

Retrieve a bucket

Parameters
string$bucket_idThe bucket ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Bucket|\InfluxDB2\Model\Error

◆ getBucketsIDAsync()

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

Operation getBucketsIDAsync

Retrieve a bucket

Parameters
string$bucket_idThe bucket ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getBucketsIDAsyncWithHttpInfo()

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

Operation getBucketsIDAsyncWithHttpInfo

Retrieve a bucket

Parameters
string$bucket_idThe bucket ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getBucketsIDLabels()

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

Operation getBucketsIDLabels

List all labels for a bucket

Parameters
string$bucket_idThe bucket ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\LabelsResponse|\InfluxDB2\Model\Error

◆ getBucketsIDLabelsAsync()

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

Operation getBucketsIDLabelsAsync

List all labels for a bucket

Parameters
string$bucket_idThe bucket ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getBucketsIDLabelsAsyncWithHttpInfo()

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

Operation getBucketsIDLabelsAsyncWithHttpInfo

List all labels for a bucket

Parameters
string$bucket_idThe bucket ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getBucketsIDLabelsRequest()

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

Create request for operation 'getBucketsIDLabels'

Parameters
string$bucket_idThe bucket ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getBucketsIDLabelsWithHttpInfo()

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

Operation getBucketsIDLabelsWithHttpInfo

List all labels for a bucket

Parameters
string$bucket_idThe bucket ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\LabelsResponse|\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_idThe bucket ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\ResourceMembers|\InfluxDB2\Model\Error

◆ getBucketsIDMembersAsync()

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

Operation getBucketsIDMembersAsync

List all users with member privileges for a bucket

Parameters
string$bucket_idThe bucket ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getBucketsIDMembersAsyncWithHttpInfo()

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

Operation getBucketsIDMembersAsyncWithHttpInfo

List all users with member privileges for a bucket

Parameters
string$bucket_idThe bucket ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getBucketsIDMembersRequest()

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

Create request for operation 'getBucketsIDMembers'

Parameters
string$bucket_idThe bucket ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ 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_idThe bucket ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\ResourceMembers|\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_idThe bucket ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getBucketsIDOwnersAsync()

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

Operation getBucketsIDOwnersAsync

List all owners of a bucket

Parameters
string$bucket_idThe bucket ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getBucketsIDOwnersAsyncWithHttpInfo()

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

Operation getBucketsIDOwnersAsyncWithHttpInfo

List all owners of a bucket

Parameters
string$bucket_idThe bucket ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getBucketsIDOwnersRequest()

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

Create request for operation 'getBucketsIDOwners'

Parameters
string$bucket_idThe bucket ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getBucketsIDOwnersWithHttpInfo()

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

Operation getBucketsIDOwnersWithHttpInfo

List all owners of a bucket

Parameters
string$bucket_idThe bucket ID. (required)
string$zap_trace_spanOpenTracing 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_idThe bucket ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getBucketsIDWithHttpInfo()

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

Operation getBucketsIDWithHttpInfo

Retrieve a bucket

Parameters
string$bucket_idThe bucket ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Bucket|\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_spanOpenTracing span context (optional)
int$offset(optional)
int$limit(optional, default to 20)
string$afterThe last resource ID from which to seek from (but not including). This is to be used instead of `offset`. (optional)
string$orgThe name of the organization. (optional)
string$org_idThe organization ID. (optional)
string$nameOnly returns buckets with a specific name. (optional)
string$idOnly returns buckets with a specific ID. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ 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 all buckets

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$offset(optional)
int$limit(optional, default to 20)
string$afterThe last resource ID from which to seek from (but not including). This is to be used instead of `offset`. (optional)
string$orgThe name of the organization. (optional)
string$org_idThe organization ID. (optional)
string$nameOnly returns buckets with a specific name. (optional)
string$idOnly returns buckets with a specific ID. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getConfig()

InfluxDB2\Service\BucketsService::getConfig ( )
Returns
Configuration

◆ getSourcesIDBuckets()

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

Operation getSourcesIDBuckets

Get buckets in a source

Parameters
string$source_idThe source ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$orgThe name of the organization. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getSourcesIDBucketsAsync()

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

Operation getSourcesIDBucketsAsync

Get buckets in a source

Parameters
string$source_idThe source ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$orgThe name of the organization. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getSourcesIDBucketsAsyncWithHttpInfo()

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

Operation getSourcesIDBucketsAsyncWithHttpInfo

Get buckets in a source

Parameters
string$source_idThe source ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$orgThe name of the organization. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getSourcesIDBucketsRequest()

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

Create request for operation 'getSourcesIDBuckets'

Parameters
string$source_idThe source ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$orgThe name of the organization. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getSourcesIDBucketsWithHttpInfo()

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

Operation getSourcesIDBucketsWithHttpInfo

Get buckets in a source

Parameters
string$source_idThe source ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$orgThe 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_idThe bucket ID. (required)
\InfluxDB2\Model\PatchBucketRequest$patch_bucket_requestBucket update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Bucket|\InfluxDB2\Model\Error

◆ patchBucketsIDAsync()

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

Operation patchBucketsIDAsync

Update a bucket

Parameters
string$bucket_idThe bucket ID. (required)
\InfluxDB2\Model\PatchBucketRequest$patch_bucket_requestBucket update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ patchBucketsIDAsyncWithHttpInfo()

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

Operation patchBucketsIDAsyncWithHttpInfo

Update a bucket

Parameters
string$bucket_idThe bucket ID. (required)
\InfluxDB2\Model\PatchBucketRequest$patch_bucket_requestBucket update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ patchBucketsIDRequest()

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

Create request for operation 'patchBucketsID'

Parameters
string$bucket_idThe bucket ID. (required)
\InfluxDB2\Model\PatchBucketRequest$patch_bucket_requestBucket update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ patchBucketsIDWithHttpInfo()

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

Operation patchBucketsIDWithHttpInfo

Update a bucket

Parameters
string$bucket_idThe bucket ID. (required)
\InfluxDB2\Model\PatchBucketRequest$patch_bucket_requestBucket update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Bucket|\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_requestBucket to create (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Bucket|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ postBucketsAsync()

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

Operation postBucketsAsync

Create a bucket

Parameters
\InfluxDB2\Model\PostBucketRequest$post_bucket_requestBucket to create (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postBucketsAsyncWithHttpInfo()

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

Operation postBucketsAsyncWithHttpInfo

Create a bucket

Parameters
\InfluxDB2\Model\PostBucketRequest$post_bucket_requestBucket to create (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postBucketsIDLabels()

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

Operation postBucketsIDLabels

Add a label to a bucket

Parameters
string$bucket_idThe bucket ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingLabel to add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\LabelResponse|\InfluxDB2\Model\Error

◆ postBucketsIDLabelsAsync()

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

Operation postBucketsIDLabelsAsync

Add a label to a bucket

Parameters
string$bucket_idThe bucket ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingLabel to add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postBucketsIDLabelsAsyncWithHttpInfo()

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

Operation postBucketsIDLabelsAsyncWithHttpInfo

Add a label to a bucket

Parameters
string$bucket_idThe bucket ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingLabel to add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postBucketsIDLabelsRequest()

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

Create request for operation 'postBucketsIDLabels'

Parameters
string$bucket_idThe bucket ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingLabel to add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ postBucketsIDLabelsWithHttpInfo()

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

Operation postBucketsIDLabelsWithHttpInfo

Add a label to a bucket

Parameters
string$bucket_idThe bucket ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingLabel to add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\LabelResponse|\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_idThe bucket ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as member (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\ResourceMember|\InfluxDB2\Model\Error

◆ postBucketsIDMembersAsync()

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

Operation postBucketsIDMembersAsync

Add a member to a bucket

Parameters
string$bucket_idThe bucket ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as member (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postBucketsIDMembersAsyncWithHttpInfo()

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

Operation postBucketsIDMembersAsyncWithHttpInfo

Add a member to a bucket

Parameters
string$bucket_idThe bucket ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as member (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ 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_idThe bucket ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as member (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ 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_idThe bucket ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as member (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\ResourceMember|\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_idThe bucket ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as owner (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ postBucketsIDOwnersAsync()

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

Operation postBucketsIDOwnersAsync

Add an owner to a bucket

Parameters
string$bucket_idThe bucket ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as owner (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postBucketsIDOwnersAsyncWithHttpInfo()

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

Operation postBucketsIDOwnersAsyncWithHttpInfo

Add an owner to a bucket

Parameters
string$bucket_idThe bucket ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as owner (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ 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_idThe bucket ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as owner (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ 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_idThe bucket ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as owner (required)
string$zap_trace_spanOpenTracing 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_requestBucket to create (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ postBucketsWithHttpInfo()

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

Operation postBucketsWithHttpInfo

Create a bucket

Parameters
\InfluxDB2\Model\PostBucketRequest$post_bucket_requestBucket to create (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\Bucket|\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: