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

Public Member Functions

 __construct (DefaultApi $defaultApi)
 
 deleteRemoteConnectionByID ($remote_id, $zap_trace_span=null)
 
 deleteRemoteConnectionByIDWithHttpInfo ($remote_id, $zap_trace_span=null)
 
 getRemoteConnectionByID ($remote_id, $zap_trace_span=null)
 
 getRemoteConnectionByIDWithHttpInfo ($remote_id, $zap_trace_span=null)
 
 getRemoteConnections ($org_id, $zap_trace_span=null, $name=null, $remote_url=null)
 
 getRemoteConnectionsWithHttpInfo ($org_id, $zap_trace_span=null, $name=null, $remote_url=null)
 
 patchRemoteConnectionByID ($remote_id, $remote_connection_update_request, $zap_trace_span=null)
 
 patchRemoteConnectionByIDWithHttpInfo ($remote_id, $remote_connection_update_request, $zap_trace_span=null)
 
 postRemoteConnection ($remote_connection_creation_request)
 
 postRemoteConnectionWithHttpInfo ($remote_connection_creation_request)
 

Protected Member Functions

 deleteRemoteConnectionByIDRequest ($remote_id, $zap_trace_span=null)
 
 getRemoteConnectionByIDRequest ($remote_id, $zap_trace_span=null)
 
 getRemoteConnectionsRequest ($org_id, $zap_trace_span=null, $name=null, $remote_url=null)
 
 patchRemoteConnectionByIDRequest ($remote_id, $remote_connection_update_request, $zap_trace_span=null)
 
 postRemoteConnectionRequest ($remote_connection_creation_request)
 

Protected Attributes

 $defaultApi
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ deleteRemoteConnectionByID()

InfluxDB2\Service\RemoteConnectionsService::deleteRemoteConnectionByID (   $remote_id,
  $zap_trace_span = null 
)

Operation deleteRemoteConnectionByID

Delete a remote connection

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

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteRemoteConnectionByIDRequest()

InfluxDB2\Service\RemoteConnectionsService::deleteRemoteConnectionByIDRequest (   $remote_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'deleteRemoteConnectionByID'

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

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ deleteRemoteConnectionByIDWithHttpInfo()

InfluxDB2\Service\RemoteConnectionsService::deleteRemoteConnectionByIDWithHttpInfo (   $remote_id,
  $zap_trace_span = null 
)

Operation deleteRemoteConnectionByIDWithHttpInfo

Delete a remote connection

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

◆ getRemoteConnectionByID()

InfluxDB2\Service\RemoteConnectionsService::getRemoteConnectionByID (   $remote_id,
  $zap_trace_span = null 
)

Operation getRemoteConnectionByID

Retrieve a remote connection

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

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\RemoteConnection|string|string

◆ getRemoteConnectionByIDRequest()

InfluxDB2\Service\RemoteConnectionsService::getRemoteConnectionByIDRequest (   $remote_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'getRemoteConnectionByID'

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

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getRemoteConnectionByIDWithHttpInfo()

InfluxDB2\Service\RemoteConnectionsService::getRemoteConnectionByIDWithHttpInfo (   $remote_id,
  $zap_trace_span = null 
)

Operation getRemoteConnectionByIDWithHttpInfo

Retrieve a remote connection

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

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getRemoteConnections()

InfluxDB2\Service\RemoteConnectionsService::getRemoteConnections (   $org_id,
  $zap_trace_span = null,
  $name = null,
  $remote_url = null 
)

Operation getRemoteConnections

List all remote connections

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

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\RemoteConnections|string|string

◆ getRemoteConnectionsRequest()

InfluxDB2\Service\RemoteConnectionsService::getRemoteConnectionsRequest (   $org_id,
  $zap_trace_span = null,
  $name = null,
  $remote_url = null 
)
protected

Create request for operation 'getRemoteConnections'

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

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getRemoteConnectionsWithHttpInfo()

InfluxDB2\Service\RemoteConnectionsService::getRemoteConnectionsWithHttpInfo (   $org_id,
  $zap_trace_span = null,
  $name = null,
  $remote_url = null 
)

Operation getRemoteConnectionsWithHttpInfo

List all remote connections

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

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ patchRemoteConnectionByID()

InfluxDB2\Service\RemoteConnectionsService::patchRemoteConnectionByID (   $remote_id,
  $remote_connection_update_request,
  $zap_trace_span = null 
)

Operation patchRemoteConnectionByID

Update a remote connection

Parameters
string$remote_idremote_id (required)
\InfluxDB2\Model\RemoteConnectionUpdateRequest$remote_connection_update_requestremote_connection_update_request (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\RemoteConnection|string|string|string

◆ patchRemoteConnectionByIDRequest()

InfluxDB2\Service\RemoteConnectionsService::patchRemoteConnectionByIDRequest (   $remote_id,
  $remote_connection_update_request,
  $zap_trace_span = null 
)
protected

Create request for operation 'patchRemoteConnectionByID'

Parameters
string$remote_id(required)
\InfluxDB2\Model\RemoteConnectionUpdateRequest$remote_connection_update_request(required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ patchRemoteConnectionByIDWithHttpInfo()

InfluxDB2\Service\RemoteConnectionsService::patchRemoteConnectionByIDWithHttpInfo (   $remote_id,
  $remote_connection_update_request,
  $zap_trace_span = null 
)

Operation patchRemoteConnectionByIDWithHttpInfo

Update a remote connection

Parameters
string$remote_id(required)
\InfluxDB2\Model\RemoteConnectionUpdateRequest$remote_connection_update_request(required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ postRemoteConnection()

InfluxDB2\Service\RemoteConnectionsService::postRemoteConnection (   $remote_connection_creation_request)

Operation postRemoteConnection

Register a new remote connection

Parameters
\InfluxDB2\Model\RemoteConnectionCreationRequest$remote_connection_creation_requestremote_connection_creation_request (required)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\RemoteConnection|string|string

◆ postRemoteConnectionRequest()

InfluxDB2\Service\RemoteConnectionsService::postRemoteConnectionRequest (   $remote_connection_creation_request)
protected

Create request for operation 'postRemoteConnection'

Parameters
\InfluxDB2\Model\RemoteConnectionCreationRequest$remote_connection_creation_request(required)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ postRemoteConnectionWithHttpInfo()

InfluxDB2\Service\RemoteConnectionsService::postRemoteConnectionWithHttpInfo (   $remote_connection_creation_request)

Operation postRemoteConnectionWithHttpInfo

Register a new remote connection

Parameters
\InfluxDB2\Model\RemoteConnectionCreationRequest$remote_connection_creation_request(required)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

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