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

Public Member Functions

 __construct (ClientInterface $client=null, Configuration $config=null, HeaderSelector $selector=null)
 
 getConfig ()
 
 deleteOrgsID ($org_id, $zap_trace_span=null)
 
 deleteOrgsIDWithHttpInfo ($org_id, $zap_trace_span=null)
 
 deleteOrgsIDAsync ($org_id, $zap_trace_span=null)
 
 deleteOrgsIDAsyncWithHttpInfo ($org_id, $zap_trace_span=null)
 
 deleteOrgsIDMembersID ($user_id, $org_id, $zap_trace_span=null)
 
 deleteOrgsIDMembersIDWithHttpInfo ($user_id, $org_id, $zap_trace_span=null)
 
 deleteOrgsIDMembersIDAsync ($user_id, $org_id, $zap_trace_span=null)
 
 deleteOrgsIDMembersIDAsyncWithHttpInfo ($user_id, $org_id, $zap_trace_span=null)
 
 deleteOrgsIDOwnersID ($user_id, $org_id, $zap_trace_span=null)
 
 deleteOrgsIDOwnersIDWithHttpInfo ($user_id, $org_id, $zap_trace_span=null)
 
 deleteOrgsIDOwnersIDAsync ($user_id, $org_id, $zap_trace_span=null)
 
 deleteOrgsIDOwnersIDAsyncWithHttpInfo ($user_id, $org_id, $zap_trace_span=null)
 
 getOrgs ($zap_trace_span=null, $offset=null, $limit=20, $descending=false, $org=null, $org_id=null, $user_id=null)
 
 getOrgsWithHttpInfo ($zap_trace_span=null, $offset=null, $limit=20, $descending=false, $org=null, $org_id=null, $user_id=null)
 
 getOrgsAsync ($zap_trace_span=null, $offset=null, $limit=20, $descending=false, $org=null, $org_id=null, $user_id=null)
 
 getOrgsAsyncWithHttpInfo ($zap_trace_span=null, $offset=null, $limit=20, $descending=false, $org=null, $org_id=null, $user_id=null)
 
 getOrgsID ($org_id, $zap_trace_span=null)
 
 getOrgsIDWithHttpInfo ($org_id, $zap_trace_span=null)
 
 getOrgsIDAsync ($org_id, $zap_trace_span=null)
 
 getOrgsIDAsyncWithHttpInfo ($org_id, $zap_trace_span=null)
 
 getOrgsIDMembers ($org_id, $zap_trace_span=null)
 
 getOrgsIDMembersWithHttpInfo ($org_id, $zap_trace_span=null)
 
 getOrgsIDMembersAsync ($org_id, $zap_trace_span=null)
 
 getOrgsIDMembersAsyncWithHttpInfo ($org_id, $zap_trace_span=null)
 
 getOrgsIDOwners ($org_id, $zap_trace_span=null)
 
 getOrgsIDOwnersWithHttpInfo ($org_id, $zap_trace_span=null)
 
 getOrgsIDOwnersAsync ($org_id, $zap_trace_span=null)
 
 getOrgsIDOwnersAsyncWithHttpInfo ($org_id, $zap_trace_span=null)
 
 patchOrgsID ($org_id, $patch_organization_request, $zap_trace_span=null)
 
 patchOrgsIDWithHttpInfo ($org_id, $patch_organization_request, $zap_trace_span=null)
 
 patchOrgsIDAsync ($org_id, $patch_organization_request, $zap_trace_span=null)
 
 patchOrgsIDAsyncWithHttpInfo ($org_id, $patch_organization_request, $zap_trace_span=null)
 
 postOrgs ($post_organization_request, $zap_trace_span=null)
 
 postOrgsWithHttpInfo ($post_organization_request, $zap_trace_span=null)
 
 postOrgsAsync ($post_organization_request, $zap_trace_span=null)
 
 postOrgsAsyncWithHttpInfo ($post_organization_request, $zap_trace_span=null)
 
 postOrgsIDMembers ($org_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 postOrgsIDMembersWithHttpInfo ($org_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 postOrgsIDMembersAsync ($org_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 postOrgsIDMembersAsyncWithHttpInfo ($org_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 postOrgsIDOwners ($org_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 postOrgsIDOwnersWithHttpInfo ($org_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 postOrgsIDOwnersAsync ($org_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 postOrgsIDOwnersAsyncWithHttpInfo ($org_id, $add_resource_member_request_body, $zap_trace_span=null)
 

Protected Member Functions

 deleteOrgsIDRequest ($org_id, $zap_trace_span=null)
 
 deleteOrgsIDMembersIDRequest ($user_id, $org_id, $zap_trace_span=null)
 
 deleteOrgsIDOwnersIDRequest ($user_id, $org_id, $zap_trace_span=null)
 
 getOrgsRequest ($zap_trace_span=null, $offset=null, $limit=20, $descending=false, $org=null, $org_id=null, $user_id=null)
 
 getOrgsIDRequest ($org_id, $zap_trace_span=null)
 
 getOrgsIDMembersRequest ($org_id, $zap_trace_span=null)
 
 getOrgsIDOwnersRequest ($org_id, $zap_trace_span=null)
 
 patchOrgsIDRequest ($org_id, $patch_organization_request, $zap_trace_span=null)
 
 postOrgsRequest ($post_organization_request, $zap_trace_span=null)
 
 postOrgsIDMembersRequest ($org_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 postOrgsIDOwnersRequest ($org_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 createHttpClientOption ()
 

Protected Attributes

 $client
 
 $config
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ createHttpClientOption()

InfluxDB2\Service\OrganizationsService::createHttpClientOption ( )
protected

Create http client option

Exceptions

RuntimeException on file opening failure

Returns
array of http client options

◆ deleteOrgsID()

InfluxDB2\Service\OrganizationsService::deleteOrgsID (   $org_id,
  $zap_trace_span = null 
)

Operation deleteOrgsID

Delete an organization

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

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteOrgsIDAsync()

InfluxDB2\Service\OrganizationsService::deleteOrgsIDAsync (   $org_id,
  $zap_trace_span = null 
)

Operation deleteOrgsIDAsync

Delete an organization

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteOrgsIDAsyncWithHttpInfo()

InfluxDB2\Service\OrganizationsService::deleteOrgsIDAsyncWithHttpInfo (   $org_id,
  $zap_trace_span = null 
)

Operation deleteOrgsIDAsyncWithHttpInfo

Delete an organization

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteOrgsIDMembersID()

InfluxDB2\Service\OrganizationsService::deleteOrgsIDMembersID (   $user_id,
  $org_id,
  $zap_trace_span = null 
)

Operation deleteOrgsIDMembersID

Remove a member from an organization

Parameters
string$user_idThe ID of the member to remove. (required)
string$org_idThe organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteOrgsIDMembersIDAsync()

InfluxDB2\Service\OrganizationsService::deleteOrgsIDMembersIDAsync (   $user_id,
  $org_id,
  $zap_trace_span = null 
)

Operation deleteOrgsIDMembersIDAsync

Remove a member from an organization

Parameters
string$user_idThe ID of the member to remove. (required)
string$org_idThe organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteOrgsIDMembersIDAsyncWithHttpInfo()

InfluxDB2\Service\OrganizationsService::deleteOrgsIDMembersIDAsyncWithHttpInfo (   $user_id,
  $org_id,
  $zap_trace_span = null 
)

Operation deleteOrgsIDMembersIDAsyncWithHttpInfo

Remove a member from an organization

Parameters
string$user_idThe ID of the member to remove. (required)
string$org_idThe organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteOrgsIDMembersIDRequest()

InfluxDB2\Service\OrganizationsService::deleteOrgsIDMembersIDRequest (   $user_id,
  $org_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'deleteOrgsIDMembersID'

Parameters
string$user_idThe ID of the member to remove. (required)
string$org_idThe organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ deleteOrgsIDMembersIDWithHttpInfo()

InfluxDB2\Service\OrganizationsService::deleteOrgsIDMembersIDWithHttpInfo (   $user_id,
  $org_id,
  $zap_trace_span = null 
)

Operation deleteOrgsIDMembersIDWithHttpInfo

Remove a member from an organization

Parameters
string$user_idThe ID of the member to remove. (required)
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 null, HTTP status code, HTTP response headers (array of strings)

◆ deleteOrgsIDOwnersID()

InfluxDB2\Service\OrganizationsService::deleteOrgsIDOwnersID (   $user_id,
  $org_id,
  $zap_trace_span = null 
)

Operation deleteOrgsIDOwnersID

Remove an owner from an organization

Parameters
string$user_idThe ID of the owner to remove. (required)
string$org_idThe organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteOrgsIDOwnersIDAsync()

InfluxDB2\Service\OrganizationsService::deleteOrgsIDOwnersIDAsync (   $user_id,
  $org_id,
  $zap_trace_span = null 
)

Operation deleteOrgsIDOwnersIDAsync

Remove an owner from an organization

Parameters
string$user_idThe ID of the owner to remove. (required)
string$org_idThe organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteOrgsIDOwnersIDAsyncWithHttpInfo()

InfluxDB2\Service\OrganizationsService::deleteOrgsIDOwnersIDAsyncWithHttpInfo (   $user_id,
  $org_id,
  $zap_trace_span = null 
)

Operation deleteOrgsIDOwnersIDAsyncWithHttpInfo

Remove an owner from an organization

Parameters
string$user_idThe ID of the owner to remove. (required)
string$org_idThe organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ deleteOrgsIDOwnersIDRequest()

InfluxDB2\Service\OrganizationsService::deleteOrgsIDOwnersIDRequest (   $user_id,
  $org_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'deleteOrgsIDOwnersID'

Parameters
string$user_idThe ID of the owner to remove. (required)
string$org_idThe organization ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ deleteOrgsIDOwnersIDWithHttpInfo()

InfluxDB2\Service\OrganizationsService::deleteOrgsIDOwnersIDWithHttpInfo (   $user_id,
  $org_id,
  $zap_trace_span = null 
)

Operation deleteOrgsIDOwnersIDWithHttpInfo

Remove an owner from an organization

Parameters
string$user_idThe ID of the owner to remove. (required)
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 null, HTTP status code, HTTP response headers (array of strings)

◆ deleteOrgsIDRequest()

InfluxDB2\Service\OrganizationsService::deleteOrgsIDRequest (   $org_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'deleteOrgsID'

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

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ deleteOrgsIDWithHttpInfo()

InfluxDB2\Service\OrganizationsService::deleteOrgsIDWithHttpInfo (   $org_id,
  $zap_trace_span = null 
)

Operation deleteOrgsIDWithHttpInfo

Delete an organization

Parameters
string$org_idThe ID of the organization 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)

◆ getConfig()

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

◆ getOrgs()

InfluxDB2\Service\OrganizationsService::getOrgs (   $zap_trace_span = null,
  $offset = null,
  $limit = 20,
  $descending = false,
  $org = null,
  $org_id = null,
  $user_id = null 
)

Operation getOrgs

List all organizations

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$offsetoffset (optional)
int$limitlimit (optional, default to 20)
bool$descendingdescending (optional, default to false)
string$orgFilter organizations to a specific organization name. (optional)
string$org_idFilter organizations to a specific organization ID. (optional)
string$user_idFilter organizations to a specific user ID. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Organizations|\InfluxDB2\Model\Error

◆ getOrgsAsync()

InfluxDB2\Service\OrganizationsService::getOrgsAsync (   $zap_trace_span = null,
  $offset = null,
  $limit = 20,
  $descending = false,
  $org = null,
  $org_id = null,
  $user_id = null 
)

Operation getOrgsAsync

List all organizations

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$offset(optional)
int$limit(optional, default to 20)
bool$descending(optional, default to false)
string$orgFilter organizations to a specific organization name. (optional)
string$org_idFilter organizations to a specific organization ID. (optional)
string$user_idFilter organizations to a specific user ID. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getOrgsAsyncWithHttpInfo()

InfluxDB2\Service\OrganizationsService::getOrgsAsyncWithHttpInfo (   $zap_trace_span = null,
  $offset = null,
  $limit = 20,
  $descending = false,
  $org = null,
  $org_id = null,
  $user_id = null 
)

Operation getOrgsAsyncWithHttpInfo

List all organizations

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$offset(optional)
int$limit(optional, default to 20)
bool$descending(optional, default to false)
string$orgFilter organizations to a specific organization name. (optional)
string$org_idFilter organizations to a specific organization ID. (optional)
string$user_idFilter organizations to a specific user ID. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getOrgsID()

InfluxDB2\Service\OrganizationsService::getOrgsID (   $org_id,
  $zap_trace_span = null 
)

Operation getOrgsID

Retrieve an organization

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

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Organization|\InfluxDB2\Model\Error

◆ getOrgsIDAsync()

InfluxDB2\Service\OrganizationsService::getOrgsIDAsync (   $org_id,
  $zap_trace_span = null 
)

Operation getOrgsIDAsync

Retrieve an organization

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getOrgsIDAsyncWithHttpInfo()

InfluxDB2\Service\OrganizationsService::getOrgsIDAsyncWithHttpInfo (   $org_id,
  $zap_trace_span = null 
)

Operation getOrgsIDAsyncWithHttpInfo

Retrieve an organization

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getOrgsIDMembers()

InfluxDB2\Service\OrganizationsService::getOrgsIDMembers (   $org_id,
  $zap_trace_span = null 
)

Operation getOrgsIDMembers

List all members of 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\ResourceMembers|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ getOrgsIDMembersAsync()

InfluxDB2\Service\OrganizationsService::getOrgsIDMembersAsync (   $org_id,
  $zap_trace_span = null 
)

Operation getOrgsIDMembersAsync

List all members of an organization

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getOrgsIDMembersAsyncWithHttpInfo()

InfluxDB2\Service\OrganizationsService::getOrgsIDMembersAsyncWithHttpInfo (   $org_id,
  $zap_trace_span = null 
)

Operation getOrgsIDMembersAsyncWithHttpInfo

List all members of an organization

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getOrgsIDMembersRequest()

InfluxDB2\Service\OrganizationsService::getOrgsIDMembersRequest (   $org_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'getOrgsIDMembers'

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

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getOrgsIDMembersWithHttpInfo()

InfluxDB2\Service\OrganizationsService::getOrgsIDMembersWithHttpInfo (   $org_id,
  $zap_trace_span = null 
)

Operation getOrgsIDMembersWithHttpInfo

List all members of 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\ResourceMembers|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ getOrgsIDOwners()

InfluxDB2\Service\OrganizationsService::getOrgsIDOwners (   $org_id,
  $zap_trace_span = null 
)

Operation getOrgsIDOwners

List all owners of 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\ResourceOwners|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error

◆ getOrgsIDOwnersAsync()

InfluxDB2\Service\OrganizationsService::getOrgsIDOwnersAsync (   $org_id,
  $zap_trace_span = null 
)

Operation getOrgsIDOwnersAsync

List all owners of an organization

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getOrgsIDOwnersAsyncWithHttpInfo()

InfluxDB2\Service\OrganizationsService::getOrgsIDOwnersAsyncWithHttpInfo (   $org_id,
  $zap_trace_span = null 
)

Operation getOrgsIDOwnersAsyncWithHttpInfo

List all owners of an organization

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ getOrgsIDOwnersRequest()

InfluxDB2\Service\OrganizationsService::getOrgsIDOwnersRequest (   $org_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'getOrgsIDOwners'

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

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getOrgsIDOwnersWithHttpInfo()

InfluxDB2\Service\OrganizationsService::getOrgsIDOwnersWithHttpInfo (   $org_id,
  $zap_trace_span = null 
)

Operation getOrgsIDOwnersWithHttpInfo

List all owners of 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\ResourceOwners|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ getOrgsIDRequest()

InfluxDB2\Service\OrganizationsService::getOrgsIDRequest (   $org_id,
  $zap_trace_span = null 
)
protected

Create request for operation 'getOrgsID'

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

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getOrgsIDWithHttpInfo()

InfluxDB2\Service\OrganizationsService::getOrgsIDWithHttpInfo (   $org_id,
  $zap_trace_span = null 
)

Operation getOrgsIDWithHttpInfo

Retrieve an organization

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

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getOrgsRequest()

InfluxDB2\Service\OrganizationsService::getOrgsRequest (   $zap_trace_span = null,
  $offset = null,
  $limit = 20,
  $descending = false,
  $org = null,
  $org_id = null,
  $user_id = null 
)
protected

Create request for operation 'getOrgs'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$offset(optional)
int$limit(optional, default to 20)
bool$descending(optional, default to false)
string$orgFilter organizations to a specific organization name. (optional)
string$org_idFilter organizations to a specific organization ID. (optional)
string$user_idFilter organizations to a specific user ID. (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ getOrgsWithHttpInfo()

InfluxDB2\Service\OrganizationsService::getOrgsWithHttpInfo (   $zap_trace_span = null,
  $offset = null,
  $limit = 20,
  $descending = false,
  $org = null,
  $org_id = null,
  $user_id = null 
)

Operation getOrgsWithHttpInfo

List all organizations

Parameters
string$zap_trace_spanOpenTracing span context (optional)
int$offset(optional)
int$limit(optional, default to 20)
bool$descending(optional, default to false)
string$orgFilter organizations to a specific organization name. (optional)
string$org_idFilter organizations to a specific organization ID. (optional)
string$user_idFilter organizations to a specific user ID. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ patchOrgsID()

InfluxDB2\Service\OrganizationsService::patchOrgsID (   $org_id,
  $patch_organization_request,
  $zap_trace_span = null 
)

Operation patchOrgsID

Update an organization

Parameters
string$org_idThe ID of the organization to get. (required)
\InfluxDB2\Model\PatchOrganizationRequest$patch_organization_requestOrganization update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Organization|\InfluxDB2\Model\Error

◆ patchOrgsIDAsync()

InfluxDB2\Service\OrganizationsService::patchOrgsIDAsync (   $org_id,
  $patch_organization_request,
  $zap_trace_span = null 
)

Operation patchOrgsIDAsync

Update an organization

Parameters
string$org_idThe ID of the organization to get. (required)
\InfluxDB2\Model\PatchOrganizationRequest$patch_organization_requestOrganization update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ patchOrgsIDAsyncWithHttpInfo()

InfluxDB2\Service\OrganizationsService::patchOrgsIDAsyncWithHttpInfo (   $org_id,
  $patch_organization_request,
  $zap_trace_span = null 
)

Operation patchOrgsIDAsyncWithHttpInfo

Update an organization

Parameters
string$org_idThe ID of the organization to get. (required)
\InfluxDB2\Model\PatchOrganizationRequest$patch_organization_requestOrganization update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ patchOrgsIDRequest()

InfluxDB2\Service\OrganizationsService::patchOrgsIDRequest (   $org_id,
  $patch_organization_request,
  $zap_trace_span = null 
)
protected

Create request for operation 'patchOrgsID'

Parameters
string$org_idThe ID of the organization to get. (required)
\InfluxDB2\Model\PatchOrganizationRequest$patch_organization_requestOrganization update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ patchOrgsIDWithHttpInfo()

InfluxDB2\Service\OrganizationsService::patchOrgsIDWithHttpInfo (   $org_id,
  $patch_organization_request,
  $zap_trace_span = null 
)

Operation patchOrgsIDWithHttpInfo

Update an organization

Parameters
string$org_idThe ID of the organization to get. (required)
\InfluxDB2\Model\PatchOrganizationRequest$patch_organization_requestOrganization update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ postOrgs()

InfluxDB2\Service\OrganizationsService::postOrgs (   $post_organization_request,
  $zap_trace_span = null 
)

Operation postOrgs

Create an organization

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

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\Organization|\InfluxDB2\Model\Error

◆ postOrgsAsync()

InfluxDB2\Service\OrganizationsService::postOrgsAsync (   $post_organization_request,
  $zap_trace_span = null 
)

Operation postOrgsAsync

Create an organization

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postOrgsAsyncWithHttpInfo()

InfluxDB2\Service\OrganizationsService::postOrgsAsyncWithHttpInfo (   $post_organization_request,
  $zap_trace_span = null 
)

Operation postOrgsAsyncWithHttpInfo

Create an organization

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

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postOrgsIDMembers()

InfluxDB2\Service\OrganizationsService::postOrgsIDMembers (   $org_id,
  $add_resource_member_request_body,
  $zap_trace_span = null 
)

Operation postOrgsIDMembers

Add a member to an organization

Parameters
string$org_idThe organization ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as member (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\ResourceMember|\InfluxDB2\Model\Error

◆ postOrgsIDMembersAsync()

InfluxDB2\Service\OrganizationsService::postOrgsIDMembersAsync (   $org_id,
  $add_resource_member_request_body,
  $zap_trace_span = null 
)

Operation postOrgsIDMembersAsync

Add a member to an organization

Parameters
string$org_idThe organization ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as member (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postOrgsIDMembersAsyncWithHttpInfo()

InfluxDB2\Service\OrganizationsService::postOrgsIDMembersAsyncWithHttpInfo (   $org_id,
  $add_resource_member_request_body,
  $zap_trace_span = null 
)

Operation postOrgsIDMembersAsyncWithHttpInfo

Add a member to an organization

Parameters
string$org_idThe organization ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as member (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postOrgsIDMembersRequest()

InfluxDB2\Service\OrganizationsService::postOrgsIDMembersRequest (   $org_id,
  $add_resource_member_request_body,
  $zap_trace_span = null 
)
protected

Create request for operation 'postOrgsIDMembers'

Parameters
string$org_idThe organization ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as member (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ postOrgsIDMembersWithHttpInfo()

InfluxDB2\Service\OrganizationsService::postOrgsIDMembersWithHttpInfo (   $org_id,
  $add_resource_member_request_body,
  $zap_trace_span = null 
)

Operation postOrgsIDMembersWithHttpInfo

Add a member to an organization

Parameters
string$org_idThe organization ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as member (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ postOrgsIDOwners()

InfluxDB2\Service\OrganizationsService::postOrgsIDOwners (   $org_id,
  $add_resource_member_request_body,
  $zap_trace_span = null 
)

Operation postOrgsIDOwners

Add an owner to an organization

Parameters
string$org_idThe organization ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as owner (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\ResourceOwner|\InfluxDB2\Model\Error

◆ postOrgsIDOwnersAsync()

InfluxDB2\Service\OrganizationsService::postOrgsIDOwnersAsync (   $org_id,
  $add_resource_member_request_body,
  $zap_trace_span = null 
)

Operation postOrgsIDOwnersAsync

Add an owner to an organization

Parameters
string$org_idThe organization ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as owner (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postOrgsIDOwnersAsyncWithHttpInfo()

InfluxDB2\Service\OrganizationsService::postOrgsIDOwnersAsyncWithHttpInfo (   $org_id,
  $add_resource_member_request_body,
  $zap_trace_span = null 
)

Operation postOrgsIDOwnersAsyncWithHttpInfo

Add an owner to an organization

Parameters
string$org_idThe organization ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as owner (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Promise\PromiseInterface

◆ postOrgsIDOwnersRequest()

InfluxDB2\Service\OrganizationsService::postOrgsIDOwnersRequest (   $org_id,
  $add_resource_member_request_body,
  $zap_trace_span = null 
)
protected

Create request for operation 'postOrgsIDOwners'

Parameters
string$org_idThe organization ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as owner (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ postOrgsIDOwnersWithHttpInfo()

InfluxDB2\Service\OrganizationsService::postOrgsIDOwnersWithHttpInfo (   $org_id,
  $add_resource_member_request_body,
  $zap_trace_span = null 
)

Operation postOrgsIDOwnersWithHttpInfo

Add an owner to an organization

Parameters
string$org_idThe organization ID. (required)
\InfluxDB2\Model\AddResourceMemberRequestBody$add_resource_member_request_bodyUser to add as owner (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ postOrgsRequest()

InfluxDB2\Service\OrganizationsService::postOrgsRequest (   $post_organization_request,
  $zap_trace_span = null 
)
protected

Create request for operation 'postOrgs'

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

InvalidArgumentException

Returns
\GuzzleHttp\Psr7\Request

◆ postOrgsWithHttpInfo()

InfluxDB2\Service\OrganizationsService::postOrgsWithHttpInfo (   $post_organization_request,
  $zap_trace_span = null 
)

Operation postOrgsWithHttpInfo

Create an organization

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

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

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