InfluxDB2\Service\DeleteService Class Reference

Public Member Functions
	__construct (DefaultApi $defaultApi)
	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)

Protected Member Functions
	postDeleteRequest ($delete_predicate_request, $zap_trace_span=null, $org=null, $bucket=null, $org_id=null, $bucket_id=null)

Protected Attributes
	$defaultApi
	$headerSelector

Constructor & Destructor Documentation

__construct()

InfluxDB2\Service\DeleteService::__construct

(

DefaultApi

$defaultApi

)

Parameters

DefaultApi	$defaultApi
HeaderSelector	$selector

Member Function Documentation

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 data

Parameters

\InfluxDB2\Model\DeletePredicateRequest	$delete_predicate_request	Time range parameters and an optional delete predicate expression. To select points to delete within the specified time range, pass a delete predicate expression in the `predicate` property of the request body. If you don't pass a `predicate`, InfluxDB deletes all data with timestamps in the specified time range. #### Related guides - Delete data. - Learn how to use delete predicate syntax. (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$org	The organization to delete data from. If you pass both `orgID` and `org`, they must both be valid. #### InfluxDB Cloud - Doesn't require `org` or `orgID`. - Deletes data from the bucket in the organization associated with the authorization (API token). #### InfluxDB OSS - Requires either `org` or `orgID`. (optional)
string	$bucket	The name or ID of the bucket to delete data from. If you pass both `bucket` and `bucketID`, `bucketID` takes precedence. (optional)
string	$org_id	The ID of the organization to delete data from. If you pass both `orgID` and `org`, they must both be valid. #### InfluxDB Cloud - Doesn't require `org` or `orgID`. - Deletes data from the bucket in the organization associated with the authorization (API token). #### InfluxDB OSS - Requires either `org` or `orgID`. (optional)
string	$bucket_id	The ID of the bucket to delete data from. If you pass both `bucket` and `bucketID`, `bucketID` takes precedence. (optional)

Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns

void

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_request	Time range parameters and an optional delete predicate expression. To select points to delete within the specified time range, pass a delete predicate expression in the `predicate` property of the request body. If you don't pass a `predicate`, InfluxDB deletes all data with timestamps in the specified time range. #### Related guides - Delete data. - Learn how to use delete predicate syntax. (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$org	The organization to delete data from. If you pass both `orgID` and `org`, they must both be valid. #### InfluxDB Cloud - Doesn't require `org` or `orgID`. - Deletes data from the bucket in the organization associated with the authorization (API token). #### InfluxDB OSS - Requires either `org` or `orgID`. (optional)
string	$bucket	The name or ID of the bucket to delete data from. If you pass both `bucket` and `bucketID`, `bucketID` takes precedence. (optional)
string	$org_id	The ID of the organization to delete data from. If you pass both `orgID` and `org`, they must both be valid. #### InfluxDB Cloud - Doesn't require `org` or `orgID`. - Deletes data from the bucket in the organization associated with the authorization (API token). #### InfluxDB OSS - Requires either `org` or `orgID`. (optional)
string	$bucket_id	The ID of the bucket to delete data from. If you pass both `bucket` and `bucketID`, `bucketID` takes precedence. (optional)

Exceptions

InvalidArgumentException

Returns

\Psr\Http\Message\RequestInterface

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 data

Parameters

\InfluxDB2\Model\DeletePredicateRequest	$delete_predicate_request	Time range parameters and an optional delete predicate expression. To select points to delete within the specified time range, pass a delete predicate expression in the `predicate` property of the request body. If you don't pass a `predicate`, InfluxDB deletes all data with timestamps in the specified time range. #### Related guides - Delete data. - Learn how to use delete predicate syntax. (required)
string	$zap_trace_span	OpenTracing span context (optional)
string	$org	The organization to delete data from. If you pass both `orgID` and `org`, they must both be valid. #### InfluxDB Cloud - Doesn't require `org` or `orgID`. - Deletes data from the bucket in the organization associated with the authorization (API token). #### InfluxDB OSS - Requires either `org` or `orgID`. (optional)
string	$bucket	The name or ID of the bucket to delete data from. If you pass both `bucket` and `bucketID`, `bucketID` takes precedence. (optional)
string	$org_id	The ID of the organization to delete data from. If you pass both `orgID` and `org`, they must both be valid. #### InfluxDB Cloud - Doesn't require `org` or `orgID`. - Deletes data from the bucket in the organization associated with the authorization (API token). #### InfluxDB OSS - Requires either `org` or `orgID`. (optional)
string	$bucket_id	The ID of the bucket to delete data from. If you pass both `bucket` and `bucketID`, `bucketID` takes precedence. (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:

• src/InfluxDB2/Service/DeleteService.php