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

Public Member Functions

 __construct (ClientInterface $client=null, Configuration $config=null, HeaderSelector $selector=null)
 
 getConfig ()
 
 getOrgsIDSecrets ($org_id, $zap_trace_span=null)
 
 getOrgsIDSecretsWithHttpInfo ($org_id, $zap_trace_span=null)
 
 getOrgsIDSecretsAsync ($org_id, $zap_trace_span=null)
 
 getOrgsIDSecretsAsyncWithHttpInfo ($org_id, $zap_trace_span=null)
 
 patchOrgsIDSecrets ($org_id, $request_body, $zap_trace_span=null)
 
 patchOrgsIDSecretsWithHttpInfo ($org_id, $request_body, $zap_trace_span=null)
 
 patchOrgsIDSecretsAsync ($org_id, $request_body, $zap_trace_span=null)
 
 patchOrgsIDSecretsAsyncWithHttpInfo ($org_id, $request_body, $zap_trace_span=null)
 
 postOrgsIDSecrets ($org_id, $secret_keys, $zap_trace_span=null)
 
 postOrgsIDSecretsWithHttpInfo ($org_id, $secret_keys, $zap_trace_span=null)
 
 postOrgsIDSecretsAsync ($org_id, $secret_keys, $zap_trace_span=null)
 
 postOrgsIDSecretsAsyncWithHttpInfo ($org_id, $secret_keys, $zap_trace_span=null)
 

Protected Member Functions

 getOrgsIDSecretsRequest ($org_id, $zap_trace_span=null)
 
 patchOrgsIDSecretsRequest ($org_id, $request_body, $zap_trace_span=null)
 
 postOrgsIDSecretsRequest ($org_id, $secret_keys, $zap_trace_span=null)
 
 createHttpClientOption ()
 

Protected Attributes

 $client
 
 $config
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ createHttpClientOption()

InfluxDB2\Service\SecretsService::createHttpClientOption ( )
protected

Create http client option

Exceptions

RuntimeException on file opening failure

Returns
array of http client options

◆ getConfig()

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

◆ getOrgsIDSecrets()

InfluxDB2\Service\SecretsService::getOrgsIDSecrets (   $org_id,
  $zap_trace_span = null 
)

Operation getOrgsIDSecrets

List all secret keys for an organization

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

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\SecretKeysResponse|\InfluxDB2\Model\Error

◆ getOrgsIDSecretsAsync()

InfluxDB2\Service\SecretsService::getOrgsIDSecretsAsync (   $org_id,
  $zap_trace_span = null 
)

Operation getOrgsIDSecretsAsync

List all secret keys for an organization

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getOrgsIDSecretsAsyncWithHttpInfo()

InfluxDB2\Service\SecretsService::getOrgsIDSecretsAsyncWithHttpInfo (   $org_id,
  $zap_trace_span = null 
)

Operation getOrgsIDSecretsAsyncWithHttpInfo

List all secret keys for an organization

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getOrgsIDSecretsRequest()

InfluxDB2\Service\SecretsService::getOrgsIDSecretsRequest (   $org_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'getOrgsIDSecrets'

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

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getOrgsIDSecretsWithHttpInfo()

InfluxDB2\Service\SecretsService::getOrgsIDSecretsWithHttpInfo (   $org_id,
  $zap_trace_span = null 
)

Operation getOrgsIDSecretsWithHttpInfo

List all secret keys for an organization

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

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ patchOrgsIDSecrets()

InfluxDB2\Service\SecretsService::patchOrgsIDSecrets (   $org_id,
  $request_body,
  $zap_trace_span = null 
)

Operation patchOrgsIDSecrets

Update secrets in an organization

Parameters
string$org_idThe organization ID. (required)
map[string,string]$request_body Secret key value pairs to update/add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ patchOrgsIDSecretsAsync()

InfluxDB2\Service\SecretsService::patchOrgsIDSecretsAsync (   $org_id,
  $request_body,
  $zap_trace_span = null 
)

Operation patchOrgsIDSecretsAsync

Update secrets in an organization

Parameters
string$org_idThe organization ID. (required)
map[string,string]$request_body Secret key value pairs to update/add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ patchOrgsIDSecretsAsyncWithHttpInfo()

InfluxDB2\Service\SecretsService::patchOrgsIDSecretsAsyncWithHttpInfo (   $org_id,
  $request_body,
  $zap_trace_span = null 
)

Operation patchOrgsIDSecretsAsyncWithHttpInfo

Update secrets in an organization

Parameters
string$org_idThe organization ID. (required)
map[string,string]$request_body Secret key value pairs to update/add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ patchOrgsIDSecretsRequest()

InfluxDB2\Service\SecretsService::patchOrgsIDSecretsRequest (   $org_id,
  $request_body,
  $zap_trace_span = null 
)
protected

Create request for operation 'patchOrgsIDSecrets'

Parameters
string$org_idThe organization ID. (required)
map[string,string]$request_body Secret key value pairs to update/add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ patchOrgsIDSecretsWithHttpInfo()

InfluxDB2\Service\SecretsService::patchOrgsIDSecretsWithHttpInfo (   $org_id,
  $request_body,
  $zap_trace_span = null 
)

Operation patchOrgsIDSecretsWithHttpInfo

Update secrets in an organization

Parameters
string$org_idThe organization ID. (required)
map[string,string]$request_body Secret key value pairs to update/add (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)

◆ postOrgsIDSecrets()

InfluxDB2\Service\SecretsService::postOrgsIDSecrets (   $org_id,
  $secret_keys,
  $zap_trace_span = null 
)

Operation postOrgsIDSecrets

Delete secrets from an organization

Parameters
string$org_idThe organization ID. (required)
\InfluxDB2\Model\SecretKeys$secret_keysSecret key to delete (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ postOrgsIDSecretsAsync()

InfluxDB2\Service\SecretsService::postOrgsIDSecretsAsync (   $org_id,
  $secret_keys,
  $zap_trace_span = null 
)

Operation postOrgsIDSecretsAsync

Delete secrets from an organization

Parameters
string$org_idThe organization ID. (required)
\InfluxDB2\Model\SecretKeys$secret_keysSecret key to delete (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postOrgsIDSecretsAsyncWithHttpInfo()

InfluxDB2\Service\SecretsService::postOrgsIDSecretsAsyncWithHttpInfo (   $org_id,
  $secret_keys,
  $zap_trace_span = null 
)

Operation postOrgsIDSecretsAsyncWithHttpInfo

Delete secrets from an organization

Parameters
string$org_idThe organization ID. (required)
\InfluxDB2\Model\SecretKeys$secret_keysSecret key to delete (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postOrgsIDSecretsRequest()

InfluxDB2\Service\SecretsService::postOrgsIDSecretsRequest (   $org_id,
  $secret_keys,
  $zap_trace_span = null 
)
protected

Create request for operation 'postOrgsIDSecrets'

Parameters
string$org_idThe organization ID. (required)
\InfluxDB2\Model\SecretKeys$secret_keysSecret key to delete (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ postOrgsIDSecretsWithHttpInfo()

InfluxDB2\Service\SecretsService::postOrgsIDSecretsWithHttpInfo (   $org_id,
  $secret_keys,
  $zap_trace_span = null 
)

Operation postOrgsIDSecretsWithHttpInfo

Delete secrets from an organization

Parameters
string$org_idThe organization ID. (required)
\InfluxDB2\Model\SecretKeys$secret_keysSecret key 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)

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