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

Public Member Functions

 __construct (ClientInterface $client=null, Configuration $config=null, HeaderSelector $selector=null)
 
 getConfig ()
 
 deleteAuthorizationsID ($auth_id, $zap_trace_span=null)
 
 deleteAuthorizationsIDWithHttpInfo ($auth_id, $zap_trace_span=null)
 
 deleteAuthorizationsIDAsync ($auth_id, $zap_trace_span=null)
 
 deleteAuthorizationsIDAsyncWithHttpInfo ($auth_id, $zap_trace_span=null)
 
 getAuthorizations ($zap_trace_span=null, $user_id=null, $user=null, $org_id=null, $org=null)
 
 getAuthorizationsWithHttpInfo ($zap_trace_span=null, $user_id=null, $user=null, $org_id=null, $org=null)
 
 getAuthorizationsAsync ($zap_trace_span=null, $user_id=null, $user=null, $org_id=null, $org=null)
 
 getAuthorizationsAsyncWithHttpInfo ($zap_trace_span=null, $user_id=null, $user=null, $org_id=null, $org=null)
 
 getAuthorizationsID ($auth_id, $zap_trace_span=null)
 
 getAuthorizationsIDWithHttpInfo ($auth_id, $zap_trace_span=null)
 
 getAuthorizationsIDAsync ($auth_id, $zap_trace_span=null)
 
 getAuthorizationsIDAsyncWithHttpInfo ($auth_id, $zap_trace_span=null)
 
 patchAuthorizationsID ($auth_id, $authorization_update_request, $zap_trace_span=null)
 
 patchAuthorizationsIDWithHttpInfo ($auth_id, $authorization_update_request, $zap_trace_span=null)
 
 patchAuthorizationsIDAsync ($auth_id, $authorization_update_request, $zap_trace_span=null)
 
 patchAuthorizationsIDAsyncWithHttpInfo ($auth_id, $authorization_update_request, $zap_trace_span=null)
 
 postAuthorizations ($authorization_post_request, $zap_trace_span=null)
 
 postAuthorizationsWithHttpInfo ($authorization_post_request, $zap_trace_span=null)
 
 postAuthorizationsAsync ($authorization_post_request, $zap_trace_span=null)
 
 postAuthorizationsAsyncWithHttpInfo ($authorization_post_request, $zap_trace_span=null)
 

Protected Member Functions

 deleteAuthorizationsIDRequest ($auth_id, $zap_trace_span=null)
 
 getAuthorizationsRequest ($zap_trace_span=null, $user_id=null, $user=null, $org_id=null, $org=null)
 
 getAuthorizationsIDRequest ($auth_id, $zap_trace_span=null)
 
 patchAuthorizationsIDRequest ($auth_id, $authorization_update_request, $zap_trace_span=null)
 
 postAuthorizationsRequest ($authorization_post_request, $zap_trace_span=null)
 
 createHttpClientOption ()
 

Protected Attributes

 $client
 
 $config
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ createHttpClientOption()

InfluxDB2\Service\AuthorizationsService::createHttpClientOption ( )
protected

Create http client option

Exceptions

RuntimeException on file opening failure

Returns
array of http client options

◆ deleteAuthorizationsID()

InfluxDB2\Service\AuthorizationsService::deleteAuthorizationsID (   $auth_id,
  $zap_trace_span = null 
)

Operation deleteAuthorizationsID

Delete an authorization

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

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteAuthorizationsIDAsync()

InfluxDB2\Service\AuthorizationsService::deleteAuthorizationsIDAsync (   $auth_id,
  $zap_trace_span = null 
)

Operation deleteAuthorizationsIDAsync

Delete an authorization

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteAuthorizationsIDAsyncWithHttpInfo()

InfluxDB2\Service\AuthorizationsService::deleteAuthorizationsIDAsyncWithHttpInfo (   $auth_id,
  $zap_trace_span = null 
)

Operation deleteAuthorizationsIDAsyncWithHttpInfo

Delete an authorization

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteAuthorizationsIDRequest()

InfluxDB2\Service\AuthorizationsService::deleteAuthorizationsIDRequest (   $auth_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'deleteAuthorizationsID'

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

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ deleteAuthorizationsIDWithHttpInfo()

InfluxDB2\Service\AuthorizationsService::deleteAuthorizationsIDWithHttpInfo (   $auth_id,
  $zap_trace_span = null 
)

Operation deleteAuthorizationsIDWithHttpInfo

Delete an authorization

Parameters
string$auth_idThe ID of the authorization 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)

◆ getAuthorizations()

InfluxDB2\Service\AuthorizationsService::getAuthorizations (   $zap_trace_span = null,
  $user_id = null,
  $user = null,
  $org_id = null,
  $org = null 
)

Operation getAuthorizations

List all authorizations

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$user_idOnly show authorizations that belong to a user ID. (optional)
string$userOnly show authorizations that belong to a user name. (optional)
string$org_idOnly show authorizations that belong to an organization ID. (optional)
string$orgOnly show authorizations that belong to a organization name. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Authorizations|\InfluxDB2\Model\Error

◆ getAuthorizationsAsync()

InfluxDB2\Service\AuthorizationsService::getAuthorizationsAsync (   $zap_trace_span = null,
  $user_id = null,
  $user = null,
  $org_id = null,
  $org = null 
)

Operation getAuthorizationsAsync

List all authorizations

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$user_idOnly show authorizations that belong to a user ID. (optional)
string$userOnly show authorizations that belong to a user name. (optional)
string$org_idOnly show authorizations that belong to an organization ID. (optional)
string$orgOnly show authorizations that belong to a organization name. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getAuthorizationsAsyncWithHttpInfo()

InfluxDB2\Service\AuthorizationsService::getAuthorizationsAsyncWithHttpInfo (   $zap_trace_span = null,
  $user_id = null,
  $user = null,
  $org_id = null,
  $org = null 
)

Operation getAuthorizationsAsyncWithHttpInfo

List all authorizations

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$user_idOnly show authorizations that belong to a user ID. (optional)
string$userOnly show authorizations that belong to a user name. (optional)
string$org_idOnly show authorizations that belong to an organization ID. (optional)
string$orgOnly show authorizations that belong to a organization name. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getAuthorizationsID()

InfluxDB2\Service\AuthorizationsService::getAuthorizationsID (   $auth_id,
  $zap_trace_span = null 
)

Operation getAuthorizationsID

Retrieve an authorization

Parameters
string$auth_idThe ID of the authorization to get. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Authorization|\InfluxDB2\Model\Error

◆ getAuthorizationsIDAsync()

InfluxDB2\Service\AuthorizationsService::getAuthorizationsIDAsync (   $auth_id,
  $zap_trace_span = null 
)

Operation getAuthorizationsIDAsync

Retrieve an authorization

Parameters
string$auth_idThe ID of the authorization to get. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getAuthorizationsIDAsyncWithHttpInfo()

InfluxDB2\Service\AuthorizationsService::getAuthorizationsIDAsyncWithHttpInfo (   $auth_id,
  $zap_trace_span = null 
)

Operation getAuthorizationsIDAsyncWithHttpInfo

Retrieve an authorization

Parameters
string$auth_idThe ID of the authorization to get. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getAuthorizationsIDRequest()

InfluxDB2\Service\AuthorizationsService::getAuthorizationsIDRequest (   $auth_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'getAuthorizationsID'

Parameters
string$auth_idThe ID of the authorization to get. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getAuthorizationsIDWithHttpInfo()

InfluxDB2\Service\AuthorizationsService::getAuthorizationsIDWithHttpInfo (   $auth_id,
  $zap_trace_span = null 
)

Operation getAuthorizationsIDWithHttpInfo

Retrieve an authorization

Parameters
string$auth_idThe ID of the authorization to get. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getAuthorizationsRequest()

InfluxDB2\Service\AuthorizationsService::getAuthorizationsRequest (   $zap_trace_span = null,
  $user_id = null,
  $user = null,
  $org_id = null,
  $org = null 
)
protected

Create request for operation 'getAuthorizations'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$user_idOnly show authorizations that belong to a user ID. (optional)
string$userOnly show authorizations that belong to a user name. (optional)
string$org_idOnly show authorizations that belong to an organization ID. (optional)
string$orgOnly show authorizations that belong to a organization name. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getAuthorizationsWithHttpInfo()

InfluxDB2\Service\AuthorizationsService::getAuthorizationsWithHttpInfo (   $zap_trace_span = null,
  $user_id = null,
  $user = null,
  $org_id = null,
  $org = null 
)

Operation getAuthorizationsWithHttpInfo

List all authorizations

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$user_idOnly show authorizations that belong to a user ID. (optional)
string$userOnly show authorizations that belong to a user name. (optional)
string$org_idOnly show authorizations that belong to an organization ID. (optional)
string$orgOnly show authorizations that belong to a organization name. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getConfig()

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

◆ patchAuthorizationsID()

InfluxDB2\Service\AuthorizationsService::patchAuthorizationsID (   $auth_id,
  $authorization_update_request,
  $zap_trace_span = null 
)

Operation patchAuthorizationsID

Update an authorization to be active or inactive

Parameters
string$auth_idThe ID of the authorization to update. (required)
\InfluxDB2\Model\AuthorizationUpdateRequest$authorization_update_requestAuthorization to update (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Authorization|\InfluxDB2\Model\Error

◆ patchAuthorizationsIDAsync()

InfluxDB2\Service\AuthorizationsService::patchAuthorizationsIDAsync (   $auth_id,
  $authorization_update_request,
  $zap_trace_span = null 
)

Operation patchAuthorizationsIDAsync

Update an authorization to be active or inactive

Parameters
string$auth_idThe ID of the authorization to update. (required)
\InfluxDB2\Model\AuthorizationUpdateRequest$authorization_update_requestAuthorization to update (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ patchAuthorizationsIDAsyncWithHttpInfo()

InfluxDB2\Service\AuthorizationsService::patchAuthorizationsIDAsyncWithHttpInfo (   $auth_id,
  $authorization_update_request,
  $zap_trace_span = null 
)

Operation patchAuthorizationsIDAsyncWithHttpInfo

Update an authorization to be active or inactive

Parameters
string$auth_idThe ID of the authorization to update. (required)
\InfluxDB2\Model\AuthorizationUpdateRequest$authorization_update_requestAuthorization to update (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ patchAuthorizationsIDRequest()

InfluxDB2\Service\AuthorizationsService::patchAuthorizationsIDRequest (   $auth_id,
  $authorization_update_request,
  $zap_trace_span = null 
)
protected

Create request for operation 'patchAuthorizationsID'

Parameters
string$auth_idThe ID of the authorization to update. (required)
\InfluxDB2\Model\AuthorizationUpdateRequest$authorization_update_requestAuthorization to update (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ patchAuthorizationsIDWithHttpInfo()

InfluxDB2\Service\AuthorizationsService::patchAuthorizationsIDWithHttpInfo (   $auth_id,
  $authorization_update_request,
  $zap_trace_span = null 
)

Operation patchAuthorizationsIDWithHttpInfo

Update an authorization to be active or inactive

Parameters
string$auth_idThe ID of the authorization to update. (required)
\InfluxDB2\Model\AuthorizationUpdateRequest$authorization_update_requestAuthorization to update (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ postAuthorizations()

InfluxDB2\Service\AuthorizationsService::postAuthorizations (   $authorization_post_request,
  $zap_trace_span = null 
)

Operation postAuthorizations

Create an authorization

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

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Authorization|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ postAuthorizationsAsync()

InfluxDB2\Service\AuthorizationsService::postAuthorizationsAsync (   $authorization_post_request,
  $zap_trace_span = null 
)

Operation postAuthorizationsAsync

Create an authorization

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postAuthorizationsAsyncWithHttpInfo()

InfluxDB2\Service\AuthorizationsService::postAuthorizationsAsyncWithHttpInfo (   $authorization_post_request,
  $zap_trace_span = null 
)

Operation postAuthorizationsAsyncWithHttpInfo

Create an authorization

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postAuthorizationsRequest()

InfluxDB2\Service\AuthorizationsService::postAuthorizationsRequest (   $authorization_post_request,
  $zap_trace_span = null 
)
protected

Create request for operation 'postAuthorizations'

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

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ postAuthorizationsWithHttpInfo()

InfluxDB2\Service\AuthorizationsService::postAuthorizationsWithHttpInfo (   $authorization_post_request,
  $zap_trace_span = null 
)

Operation postAuthorizationsWithHttpInfo

Create an authorization

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

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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