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

Public Member Functions

 __construct (ClientInterface $client=null, Configuration $config=null, HeaderSelector $selector=null)
 
 getConfig ()
 
 postDelete ($delete_predicate_request, $zap_trace_span=null, $org=null, $bucket=null, $org_id=null, $bucket_id=null)
 
 postDeleteWithHttpInfo ($delete_predicate_request, $zap_trace_span=null, $org=null, $bucket=null, $org_id=null, $bucket_id=null)
 
 postDeleteAsync ($delete_predicate_request, $zap_trace_span=null, $org=null, $bucket=null, $org_id=null, $bucket_id=null)
 
 postDeleteAsyncWithHttpInfo ($delete_predicate_request, $zap_trace_span=null, $org=null, $bucket=null, $org_id=null, $bucket_id=null)
 

Protected Member Functions

 postDeleteRequest ($delete_predicate_request, $zap_trace_span=null, $org=null, $bucket=null, $org_id=null, $bucket_id=null)
 
 createHttpClientOption ()
 

Protected Attributes

 $client
 
 $config
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ createHttpClientOption()

InfluxDB2\Service\DeleteService::createHttpClientOption ( )
protected

Create http client option

Exceptions

RuntimeException on file opening failure

Returns
array of http client options

◆ getConfig()

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

◆ postDelete()

InfluxDB2\Service\DeleteService::postDelete (   $delete_predicate_request,
  $zap_trace_span = null,
  $org = null,
  $bucket = null,
  $org_id = null,
  $bucket_id = null 
)

Operation postDelete

Delete time series data from InfluxDB

Parameters
\InfluxDB2\Model\DeletePredicateRequest$delete_predicate_requestPredicate delete request (required)
string$zap_trace_spanOpenTracing span context (optional)
string$orgSpecifies the organization to delete data from. (optional)
string$bucketSpecifies the bucket to delete data from. (optional)
string$org_idSpecifies the organization ID of the resource. (optional)
string$bucket_idSpecifies the bucket ID to delete data from. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ postDeleteAsync()

InfluxDB2\Service\DeleteService::postDeleteAsync (   $delete_predicate_request,
  $zap_trace_span = null,
  $org = null,
  $bucket = null,
  $org_id = null,
  $bucket_id = null 
)

Operation postDeleteAsync

Delete time series data from InfluxDB

Parameters
\InfluxDB2\Model\DeletePredicateRequest$delete_predicate_requestPredicate delete request (required)
string$zap_trace_spanOpenTracing span context (optional)
string$orgSpecifies the organization to delete data from. (optional)
string$bucketSpecifies the bucket to delete data from. (optional)
string$org_idSpecifies the organization ID of the resource. (optional)
string$bucket_idSpecifies the bucket ID to delete data from. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postDeleteAsyncWithHttpInfo()

InfluxDB2\Service\DeleteService::postDeleteAsyncWithHttpInfo (   $delete_predicate_request,
  $zap_trace_span = null,
  $org = null,
  $bucket = null,
  $org_id = null,
  $bucket_id = null 
)

Operation postDeleteAsyncWithHttpInfo

Delete time series data from InfluxDB

Parameters
\InfluxDB2\Model\DeletePredicateRequest$delete_predicate_requestPredicate delete request (required)
string$zap_trace_spanOpenTracing span context (optional)
string$orgSpecifies the organization to delete data from. (optional)
string$bucketSpecifies the bucket to delete data from. (optional)
string$org_idSpecifies the organization ID of the resource. (optional)
string$bucket_idSpecifies the bucket ID to delete data from. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postDeleteRequest()

InfluxDB2\Service\DeleteService::postDeleteRequest (   $delete_predicate_request,
  $zap_trace_span = null,
  $org = null,
  $bucket = null,
  $org_id = null,
  $bucket_id = null 
)
protected

Create request for operation 'postDelete'

Parameters
\InfluxDB2\Model\DeletePredicateRequest$delete_predicate_requestPredicate delete request (required)
string$zap_trace_spanOpenTracing span context (optional)
string$orgSpecifies the organization to delete data from. (optional)
string$bucketSpecifies the bucket to delete data from. (optional)
string$org_idSpecifies the organization ID of the resource. (optional)
string$bucket_idSpecifies the bucket ID to delete data from. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ postDeleteWithHttpInfo()

InfluxDB2\Service\DeleteService::postDeleteWithHttpInfo (   $delete_predicate_request,
  $zap_trace_span = null,
  $org = null,
  $bucket = null,
  $org_id = null,
  $bucket_id = null 
)

Operation postDeleteWithHttpInfo

Delete time series data from InfluxDB

Parameters
\InfluxDB2\Model\DeletePredicateRequest$delete_predicate_requestPredicate delete request (required)
string$zap_trace_spanOpenTracing span context (optional)
string$orgSpecifies the organization to delete data from. (optional)
string$bucketSpecifies the bucket to delete data from. (optional)
string$org_idSpecifies the organization ID of the resource. (optional)
string$bucket_idSpecifies the bucket ID to delete data from. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

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