InfluxDB2\Service\SecretsService Class Reference
Public Member Functions | |
| __construct (DefaultApi $defaultApi) | |
| deleteOrgsIDSecretsID ($org_id, $secret_id, $zap_trace_span=null) | |
| deleteOrgsIDSecretsIDWithHttpInfo ($org_id, $secret_id, $zap_trace_span=null) | |
| getOrgsIDSecrets ($org_id, $zap_trace_span=null) | |
| getOrgsIDSecretsWithHttpInfo ($org_id, $zap_trace_span=null) | |
| patchOrgsIDSecrets ($org_id, $request_body, $zap_trace_span=null) | |
| patchOrgsIDSecretsWithHttpInfo ($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) | |
Protected Member Functions | |
| deleteOrgsIDSecretsIDRequest ($org_id, $secret_id, $zap_trace_span=null) | |
| 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) | |
Protected Attributes | |
| $defaultApi | |
| $headerSelector | |
Constructor & Destructor Documentation
◆ __construct()
| InfluxDB2\Service\SecretsService::__construct | ( | DefaultApi | $defaultApi | ) |
- Parameters
-
DefaultApi $defaultApi HeaderSelector $selector
Member Function Documentation
◆ deleteOrgsIDSecretsID()
| InfluxDB2\Service\SecretsService::deleteOrgsIDSecretsID | ( | $org_id, | |
| $secret_id, | |||
| $zap_trace_span = null ) |
Operation deleteOrgsIDSecretsID
Delete a secret from an organization
- Parameters
-
string $org_id The organization ID. (required) string $secret_id The secret ID. (required) string $zap_trace_span OpenTracing span context (optional)
- Exceptions
-
InfluxDB2\ApiException on non-2xx response
- Exceptions
-
InvalidArgumentException
- Returns
- void
◆ deleteOrgsIDSecretsIDRequest()
|
protected |
Create request for operation 'deleteOrgsIDSecretsID'
- Parameters
-
string $org_id The organization ID. (required) string $secret_id The secret ID. (required) string $zap_trace_span OpenTracing span context (optional)
- Exceptions
-
InvalidArgumentException
- Returns
- \Psr\Http\Message\RequestInterface
◆ deleteOrgsIDSecretsIDWithHttpInfo()
| InfluxDB2\Service\SecretsService::deleteOrgsIDSecretsIDWithHttpInfo | ( | $org_id, | |
| $secret_id, | |||
| $zap_trace_span = null ) |
Operation deleteOrgsIDSecretsIDWithHttpInfo
Delete a secret from an organization
- Parameters
-
string $org_id The organization ID. (required) string $secret_id The secret ID. (required) string $zap_trace_span OpenTracing 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)
◆ getOrgsIDSecrets()
| InfluxDB2\Service\SecretsService::getOrgsIDSecrets | ( | $org_id, | |
| $zap_trace_span = null ) |
Operation getOrgsIDSecrets
List all secret keys for an organization
- Parameters
-
string $org_id The organization ID. (required) string $zap_trace_span OpenTracing span context (optional)
- Exceptions
-
InfluxDB2\ApiException on non-2xx response
- Exceptions
-
InvalidArgumentException
- Returns
- \InfluxDB2\Model\SecretKeysResponse|\InfluxDB2\Model\Error
◆ getOrgsIDSecretsRequest()
|
protected |
Create request for operation 'getOrgsIDSecrets'
- Parameters
-
string $org_id The organization ID. (required) string $zap_trace_span OpenTracing span context (optional)
- Exceptions
-
InvalidArgumentException
- Returns
- \Psr\Http\Message\RequestInterface
◆ getOrgsIDSecretsWithHttpInfo()
| InfluxDB2\Service\SecretsService::getOrgsIDSecretsWithHttpInfo | ( | $org_id, | |
| $zap_trace_span = null ) |
Operation getOrgsIDSecretsWithHttpInfo
List all secret keys for an organization
- Parameters
-
string $org_id The organization ID. (required) string $zap_trace_span OpenTracing 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_id The organization ID. (required) map[string,string] $request_body Secret key value pairs to update/add (required) string $zap_trace_span OpenTracing span context (optional)
- Exceptions
-
InfluxDB2\ApiException on non-2xx response
- Exceptions
-
InvalidArgumentException
- Returns
- void
◆ patchOrgsIDSecretsRequest()
|
protected |
Create request for operation 'patchOrgsIDSecrets'
- Parameters
-
string $org_id The organization ID. (required) map[string,string] $request_body Secret key value pairs to update/add (required) string $zap_trace_span OpenTracing span context (optional)
- Exceptions
-
InvalidArgumentException
- Returns
- \Psr\Http\Message\RequestInterface
◆ patchOrgsIDSecretsWithHttpInfo()
| InfluxDB2\Service\SecretsService::patchOrgsIDSecretsWithHttpInfo | ( | $org_id, | |
| $request_body, | |||
| $zap_trace_span = null ) |
Operation patchOrgsIDSecretsWithHttpInfo
Update secrets in an organization
- Parameters
-
string $org_id The organization ID. (required) map[string,string] $request_body Secret key value pairs to update/add (required) string $zap_trace_span OpenTracing 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_id The organization ID. (required) \InfluxDB2\Model\SecretKeys $secret_keys Secret key to delete (required) string $zap_trace_span OpenTracing span context (optional)
- Exceptions
-
InfluxDB2\ApiException on non-2xx response
- Exceptions
-
InvalidArgumentException
- Returns
- void
◆ postOrgsIDSecretsRequest()
|
protected |
Create request for operation 'postOrgsIDSecrets'
- Parameters
-
string $org_id The organization ID. (required) \InfluxDB2\Model\SecretKeys $secret_keys Secret key to delete (required) string $zap_trace_span OpenTracing span context (optional)
- Exceptions
-
InvalidArgumentException
- Returns
- \Psr\Http\Message\RequestInterface
◆ postOrgsIDSecretsWithHttpInfo()
| InfluxDB2\Service\SecretsService::postOrgsIDSecretsWithHttpInfo | ( | $org_id, | |
| $secret_keys, | |||
| $zap_trace_span = null ) |
Operation postOrgsIDSecretsWithHttpInfo
Delete secrets from an organization
- Parameters
-
string $org_id The organization ID. (required) \InfluxDB2\Model\SecretKeys $secret_keys Secret key to delete (required) string $zap_trace_span OpenTracing 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:
- src/InfluxDB2/Service/SecretsService.php
Generated by
1.13.2