InfluxDB PHP Client
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
InfluxDB2\Service\ReplicationsService Class Reference

Public Member Functions

 __construct (DefaultApi $defaultApi)
 
 deleteReplicationByID ($replication_id, $zap_trace_span=null)
 
 deleteReplicationByIDWithHttpInfo ($replication_id, $zap_trace_span=null)
 
 getReplicationByID ($replication_id, $zap_trace_span=null)
 
 getReplicationByIDWithHttpInfo ($replication_id, $zap_trace_span=null)
 
 getReplications ($org_id, $zap_trace_span=null, $name=null, $remote_id=null, $local_bucket_id=null)
 
 getReplicationsWithHttpInfo ($org_id, $zap_trace_span=null, $name=null, $remote_id=null, $local_bucket_id=null)
 
 patchReplicationByID ($replication_id, $replication_update_request, $zap_trace_span=null, $validate=false)
 
 patchReplicationByIDWithHttpInfo ($replication_id, $replication_update_request, $zap_trace_span=null, $validate=false)
 
 postReplication ($replication_creation_request, $zap_trace_span=null, $validate=false)
 
 postReplicationWithHttpInfo ($replication_creation_request, $zap_trace_span=null, $validate=false)
 
 postValidateReplicationByID ($replication_id, $zap_trace_span=null)
 
 postValidateReplicationByIDWithHttpInfo ($replication_id, $zap_trace_span=null)
 

Protected Member Functions

 deleteReplicationByIDRequest ($replication_id, $zap_trace_span=null)
 
 getReplicationByIDRequest ($replication_id, $zap_trace_span=null)
 
 getReplicationsRequest ($org_id, $zap_trace_span=null, $name=null, $remote_id=null, $local_bucket_id=null)
 
 patchReplicationByIDRequest ($replication_id, $replication_update_request, $zap_trace_span=null, $validate=false)
 
 postReplicationRequest ($replication_creation_request, $zap_trace_span=null, $validate=false)
 
 postValidateReplicationByIDRequest ($replication_id, $zap_trace_span=null)
 

Protected Attributes

 $defaultApi
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

InfluxDB2\Service\ReplicationsService::__construct ( DefaultApi $defaultApi)
Parameters
DefaultApi$defaultApi
HeaderSelector$selector

Member Function Documentation

◆ deleteReplicationByID()

InfluxDB2\Service\ReplicationsService::deleteReplicationByID ( $replication_id,
$zap_trace_span = null )

Operation deleteReplicationByID

Delete a replication

Parameters
string$replication_idreplication_id (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteReplicationByIDRequest()

InfluxDB2\Service\ReplicationsService::deleteReplicationByIDRequest ( $replication_id,
$zap_trace_span = null )
protected

Create request for operation 'deleteReplicationByID'

Parameters
string$replication_id(required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ deleteReplicationByIDWithHttpInfo()

InfluxDB2\Service\ReplicationsService::deleteReplicationByIDWithHttpInfo ( $replication_id,
$zap_trace_span = null )

Operation deleteReplicationByIDWithHttpInfo

Delete a replication

Parameters
string$replication_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)

◆ getReplicationByID()

InfluxDB2\Service\ReplicationsService::getReplicationByID ( $replication_id,
$zap_trace_span = null )

Operation getReplicationByID

Retrieve a replication

Parameters
string$replication_idreplication_id (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Replication|string|string

◆ getReplicationByIDRequest()

InfluxDB2\Service\ReplicationsService::getReplicationByIDRequest ( $replication_id,
$zap_trace_span = null )
protected

Create request for operation 'getReplicationByID'

Parameters
string$replication_id(required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getReplicationByIDWithHttpInfo()

InfluxDB2\Service\ReplicationsService::getReplicationByIDWithHttpInfo ( $replication_id,
$zap_trace_span = null )

Operation getReplicationByIDWithHttpInfo

Retrieve a replication

Parameters
string$replication_id(required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getReplications()

InfluxDB2\Service\ReplicationsService::getReplications ( $org_id,
$zap_trace_span = null,
$name = null,
$remote_id = null,
$local_bucket_id = null )

Operation getReplications

List all replications

Parameters
string$org_idThe organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$namename (optional)
string$remote_idremote_id (optional)
string$local_bucket_idlocal_bucket_id (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Replications|string|string

◆ getReplicationsRequest()

InfluxDB2\Service\ReplicationsService::getReplicationsRequest ( $org_id,
$zap_trace_span = null,
$name = null,
$remote_id = null,
$local_bucket_id = null )
protected

Create request for operation 'getReplications'

Parameters
string$org_idThe organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$name(optional)
string$remote_id(optional)
string$local_bucket_id(optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getReplicationsWithHttpInfo()

InfluxDB2\Service\ReplicationsService::getReplicationsWithHttpInfo ( $org_id,
$zap_trace_span = null,
$name = null,
$remote_id = null,
$local_bucket_id = null )

Operation getReplicationsWithHttpInfo

List all replications

Parameters
string$org_idThe organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
string$name(optional)
string$remote_id(optional)
string$local_bucket_id(optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ patchReplicationByID()

InfluxDB2\Service\ReplicationsService::patchReplicationByID ( $replication_id,
$replication_update_request,
$zap_trace_span = null,
$validate = false )

Operation patchReplicationByID

Update a replication

Parameters
string$replication_idreplication_id (required)
\InfluxDB2\Model\ReplicationUpdateRequest$replication_update_requestreplication_update_request (required)
string$zap_trace_spanOpenTracing span context (optional)
bool$validateIf true, validate the updated information, but don't save it. (optional, default to false)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Replication|string|string|string

◆ patchReplicationByIDRequest()

InfluxDB2\Service\ReplicationsService::patchReplicationByIDRequest ( $replication_id,
$replication_update_request,
$zap_trace_span = null,
$validate = false )
protected

Create request for operation 'patchReplicationByID'

Parameters
string$replication_id(required)
\InfluxDB2\Model\ReplicationUpdateRequest$replication_update_request(required)
string$zap_trace_spanOpenTracing span context (optional)
bool$validateIf true, validate the updated information, but don't save it. (optional, default to false)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ patchReplicationByIDWithHttpInfo()

InfluxDB2\Service\ReplicationsService::patchReplicationByIDWithHttpInfo ( $replication_id,
$replication_update_request,
$zap_trace_span = null,
$validate = false )

Operation patchReplicationByIDWithHttpInfo

Update a replication

Parameters
string$replication_id(required)
\InfluxDB2\Model\ReplicationUpdateRequest$replication_update_request(required)
string$zap_trace_spanOpenTracing span context (optional)
bool$validateIf true, validate the updated information, but don't save it. (optional, default to false)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ postReplication()

InfluxDB2\Service\ReplicationsService::postReplication ( $replication_creation_request,
$zap_trace_span = null,
$validate = false )

Operation postReplication

Register a new replication

Parameters
\InfluxDB2\Model\ReplicationCreationRequest$replication_creation_requestreplication_creation_request (required)
string$zap_trace_spanOpenTracing span context (optional)
bool$validateIf true, validate the replication, but don't save it. (optional, default to false)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Replication|string|string

◆ postReplicationRequest()

InfluxDB2\Service\ReplicationsService::postReplicationRequest ( $replication_creation_request,
$zap_trace_span = null,
$validate = false )
protected

Create request for operation 'postReplication'

Parameters
\InfluxDB2\Model\ReplicationCreationRequest$replication_creation_request(required)
string$zap_trace_spanOpenTracing span context (optional)
bool$validateIf true, validate the replication, but don't save it. (optional, default to false)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ postReplicationWithHttpInfo()

InfluxDB2\Service\ReplicationsService::postReplicationWithHttpInfo ( $replication_creation_request,
$zap_trace_span = null,
$validate = false )

Operation postReplicationWithHttpInfo

Register a new replication

Parameters
\InfluxDB2\Model\ReplicationCreationRequest$replication_creation_request(required)
string$zap_trace_spanOpenTracing span context (optional)
bool$validateIf true, validate the replication, but don't save it. (optional, default to false)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ postValidateReplicationByID()

InfluxDB2\Service\ReplicationsService::postValidateReplicationByID ( $replication_id,
$zap_trace_span = null )

Operation postValidateReplicationByID

Validate a replication

Parameters
string$replication_idreplication_id (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ postValidateReplicationByIDRequest()

InfluxDB2\Service\ReplicationsService::postValidateReplicationByIDRequest ( $replication_id,
$zap_trace_span = null )
protected

Create request for operation 'postValidateReplicationByID'

Parameters
string$replication_id(required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ postValidateReplicationByIDWithHttpInfo()

InfluxDB2\Service\ReplicationsService::postValidateReplicationByIDWithHttpInfo ( $replication_id,
$zap_trace_span = null )

Operation postValidateReplicationByIDWithHttpInfo

Validate a replication

Parameters
string$replication_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)

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