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

Public Member Functions

 __construct (DefaultApi $defaultApi)
 
 deleteScrapersID ($scraper_target_id, $zap_trace_span=null)
 
 deleteScrapersIDWithHttpInfo ($scraper_target_id, $zap_trace_span=null)
 
 deleteScrapersIDLabelsID ($scraper_target_id, $label_id, $zap_trace_span=null)
 
 deleteScrapersIDLabelsIDWithHttpInfo ($scraper_target_id, $label_id, $zap_trace_span=null)
 
 deleteScrapersIDMembersID ($user_id, $scraper_target_id, $zap_trace_span=null)
 
 deleteScrapersIDMembersIDWithHttpInfo ($user_id, $scraper_target_id, $zap_trace_span=null)
 
 deleteScrapersIDOwnersID ($user_id, $scraper_target_id, $zap_trace_span=null)
 
 deleteScrapersIDOwnersIDWithHttpInfo ($user_id, $scraper_target_id, $zap_trace_span=null)
 
 getScrapers ($zap_trace_span=null, $name=null, $id=null, $org_id=null, $org=null)
 
 getScrapersWithHttpInfo ($zap_trace_span=null, $name=null, $id=null, $org_id=null, $org=null)
 
 getScrapersID ($scraper_target_id, $zap_trace_span=null)
 
 getScrapersIDWithHttpInfo ($scraper_target_id, $zap_trace_span=null)
 
 getScrapersIDLabels ($scraper_target_id, $zap_trace_span=null)
 
 getScrapersIDLabelsWithHttpInfo ($scraper_target_id, $zap_trace_span=null)
 
 getScrapersIDMembers ($scraper_target_id, $zap_trace_span=null)
 
 getScrapersIDMembersWithHttpInfo ($scraper_target_id, $zap_trace_span=null)
 
 getScrapersIDOwners ($scraper_target_id, $zap_trace_span=null)
 
 getScrapersIDOwnersWithHttpInfo ($scraper_target_id, $zap_trace_span=null)
 
 patchScrapersID ($scraper_target_id, $scraper_target_request, $zap_trace_span=null)
 
 patchScrapersIDWithHttpInfo ($scraper_target_id, $scraper_target_request, $zap_trace_span=null)
 
 postScrapers ($scraper_target_request, $zap_trace_span=null)
 
 postScrapersWithHttpInfo ($scraper_target_request, $zap_trace_span=null)
 
 postScrapersIDLabels ($scraper_target_id, $label_mapping, $zap_trace_span=null)
 
 postScrapersIDLabelsWithHttpInfo ($scraper_target_id, $label_mapping, $zap_trace_span=null)
 
 postScrapersIDMembers ($scraper_target_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 postScrapersIDMembersWithHttpInfo ($scraper_target_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 postScrapersIDOwners ($scraper_target_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 postScrapersIDOwnersWithHttpInfo ($scraper_target_id, $add_resource_member_request_body, $zap_trace_span=null)
 

Protected Member Functions

 deleteScrapersIDRequest ($scraper_target_id, $zap_trace_span=null)
 
 deleteScrapersIDLabelsIDRequest ($scraper_target_id, $label_id, $zap_trace_span=null)
 
 deleteScrapersIDMembersIDRequest ($user_id, $scraper_target_id, $zap_trace_span=null)
 
 deleteScrapersIDOwnersIDRequest ($user_id, $scraper_target_id, $zap_trace_span=null)
 
 getScrapersRequest ($zap_trace_span=null, $name=null, $id=null, $org_id=null, $org=null)
 
 getScrapersIDRequest ($scraper_target_id, $zap_trace_span=null)
 
 getScrapersIDLabelsRequest ($scraper_target_id, $zap_trace_span=null)
 
 getScrapersIDMembersRequest ($scraper_target_id, $zap_trace_span=null)
 
 getScrapersIDOwnersRequest ($scraper_target_id, $zap_trace_span=null)
 
 patchScrapersIDRequest ($scraper_target_id, $scraper_target_request, $zap_trace_span=null)
 
 postScrapersRequest ($scraper_target_request, $zap_trace_span=null)
 
 postScrapersIDLabelsRequest ($scraper_target_id, $label_mapping, $zap_trace_span=null)
 
 postScrapersIDMembersRequest ($scraper_target_id, $add_resource_member_request_body, $zap_trace_span=null)
 
 postScrapersIDOwnersRequest ($scraper_target_id, $add_resource_member_request_body, $zap_trace_span=null)
 

Protected Attributes

 $defaultApi
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

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

Member Function Documentation

◆ deleteScrapersID()

InfluxDB2\Service\ScraperTargetsService::deleteScrapersID ( $scraper_target_id,
$zap_trace_span = null )

Operation deleteScrapersID

Delete a scraper target

Parameters
string$scraper_target_idThe identifier of the scraper target. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteScrapersIDLabelsID()

InfluxDB2\Service\ScraperTargetsService::deleteScrapersIDLabelsID ( $scraper_target_id,
$label_id,
$zap_trace_span = null )

Operation deleteScrapersIDLabelsID

Delete a label from a scraper target

Parameters
string$scraper_target_idThe scraper target ID. (required)
string$label_idThe label ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteScrapersIDLabelsIDRequest()

InfluxDB2\Service\ScraperTargetsService::deleteScrapersIDLabelsIDRequest ( $scraper_target_id,
$label_id,
$zap_trace_span = null )
protected

Create request for operation 'deleteScrapersIDLabelsID'

Parameters
string$scraper_target_idThe scraper target ID. (required)
string$label_idThe label ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ deleteScrapersIDLabelsIDWithHttpInfo()

InfluxDB2\Service\ScraperTargetsService::deleteScrapersIDLabelsIDWithHttpInfo ( $scraper_target_id,
$label_id,
$zap_trace_span = null )

Operation deleteScrapersIDLabelsIDWithHttpInfo

Delete a label from a scraper target

Parameters
string$scraper_target_idThe scraper target ID. (required)
string$label_idThe label 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)

◆ deleteScrapersIDMembersID()

InfluxDB2\Service\ScraperTargetsService::deleteScrapersIDMembersID ( $user_id,
$scraper_target_id,
$zap_trace_span = null )

Operation deleteScrapersIDMembersID

Remove a member from a scraper target

Parameters
string$user_idThe ID of member to remove. (required)
string$scraper_target_idThe scraper target ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteScrapersIDMembersIDRequest()

InfluxDB2\Service\ScraperTargetsService::deleteScrapersIDMembersIDRequest ( $user_id,
$scraper_target_id,
$zap_trace_span = null )
protected

Create request for operation 'deleteScrapersIDMembersID'

Parameters
string$user_idThe ID of member to remove. (required)
string$scraper_target_idThe scraper target ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ deleteScrapersIDMembersIDWithHttpInfo()

InfluxDB2\Service\ScraperTargetsService::deleteScrapersIDMembersIDWithHttpInfo ( $user_id,
$scraper_target_id,
$zap_trace_span = null )

Operation deleteScrapersIDMembersIDWithHttpInfo

Remove a member from a scraper target

Parameters
string$user_idThe ID of member to remove. (required)
string$scraper_target_idThe scraper target 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)

◆ deleteScrapersIDOwnersID()

InfluxDB2\Service\ScraperTargetsService::deleteScrapersIDOwnersID ( $user_id,
$scraper_target_id,
$zap_trace_span = null )

Operation deleteScrapersIDOwnersID

Remove an owner from a scraper target

Parameters
string$user_idThe ID of owner to remove. (required)
string$scraper_target_idThe scraper target ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
void

◆ deleteScrapersIDOwnersIDRequest()

InfluxDB2\Service\ScraperTargetsService::deleteScrapersIDOwnersIDRequest ( $user_id,
$scraper_target_id,
$zap_trace_span = null )
protected

Create request for operation 'deleteScrapersIDOwnersID'

Parameters
string$user_idThe ID of owner to remove. (required)
string$scraper_target_idThe scraper target ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ deleteScrapersIDOwnersIDWithHttpInfo()

InfluxDB2\Service\ScraperTargetsService::deleteScrapersIDOwnersIDWithHttpInfo ( $user_id,
$scraper_target_id,
$zap_trace_span = null )

Operation deleteScrapersIDOwnersIDWithHttpInfo

Remove an owner from a scraper target

Parameters
string$user_idThe ID of owner to remove. (required)
string$scraper_target_idThe scraper target 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)

◆ deleteScrapersIDRequest()

InfluxDB2\Service\ScraperTargetsService::deleteScrapersIDRequest ( $scraper_target_id,
$zap_trace_span = null )
protected

Create request for operation 'deleteScrapersID'

Parameters
string$scraper_target_idThe identifier of the scraper target. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ deleteScrapersIDWithHttpInfo()

InfluxDB2\Service\ScraperTargetsService::deleteScrapersIDWithHttpInfo ( $scraper_target_id,
$zap_trace_span = null )

Operation deleteScrapersIDWithHttpInfo

Delete a scraper target

Parameters
string$scraper_target_idThe identifier of the scraper target. (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)

◆ getScrapers()

InfluxDB2\Service\ScraperTargetsService::getScrapers ( $zap_trace_span = null,
$name = null,
$id = null,
$org_id = null,
$org = null )

Operation getScrapers

List all scraper targets

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$nameSpecifies the name of the scraper target. (optional)
string[]$idList of scraper target IDs to return. If both `id` and `owner` are specified, only `id` is used. (optional)
string$org_idSpecifies the organization ID of the scraper target. (optional)
string$orgSpecifies the organization name of the scraper target. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\ScraperTargetResponses

◆ getScrapersID()

InfluxDB2\Service\ScraperTargetsService::getScrapersID ( $scraper_target_id,
$zap_trace_span = null )

Operation getScrapersID

Retrieve a scraper target

Parameters
string$scraper_target_idThe identifier of the scraper target. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\ScraperTargetResponse|\InfluxDB2\Model\Error

◆ getScrapersIDLabels()

InfluxDB2\Service\ScraperTargetsService::getScrapersIDLabels ( $scraper_target_id,
$zap_trace_span = null )

Operation getScrapersIDLabels

List all labels for a scraper target

Parameters
string$scraper_target_idThe scraper target ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\LabelsResponse|\InfluxDB2\Model\Error

◆ getScrapersIDLabelsRequest()

InfluxDB2\Service\ScraperTargetsService::getScrapersIDLabelsRequest ( $scraper_target_id,
$zap_trace_span = null )
protected

Create request for operation 'getScrapersIDLabels'

Parameters
string$scraper_target_idThe scraper target ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getScrapersIDLabelsWithHttpInfo()

InfluxDB2\Service\ScraperTargetsService::getScrapersIDLabelsWithHttpInfo ( $scraper_target_id,
$zap_trace_span = null )

Operation getScrapersIDLabelsWithHttpInfo

List all labels for a scraper target

Parameters
string$scraper_target_idThe scraper target ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getScrapersIDMembers()

InfluxDB2\Service\ScraperTargetsService::getScrapersIDMembers ( $scraper_target_id,
$zap_trace_span = null )

Operation getScrapersIDMembers

List all users with member privileges for a scraper target

Parameters
string$scraper_target_idThe scraper target 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

◆ getScrapersIDMembersRequest()

InfluxDB2\Service\ScraperTargetsService::getScrapersIDMembersRequest ( $scraper_target_id,
$zap_trace_span = null )
protected

Create request for operation 'getScrapersIDMembers'

Parameters
string$scraper_target_idThe scraper target ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getScrapersIDMembersWithHttpInfo()

InfluxDB2\Service\ScraperTargetsService::getScrapersIDMembersWithHttpInfo ( $scraper_target_id,
$zap_trace_span = null )

Operation getScrapersIDMembersWithHttpInfo

List all users with member privileges for a scraper target

Parameters
string$scraper_target_idThe scraper target 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, HTTP status code, HTTP response headers (array of strings)

◆ getScrapersIDOwners()

InfluxDB2\Service\ScraperTargetsService::getScrapersIDOwners ( $scraper_target_id,
$zap_trace_span = null )

Operation getScrapersIDOwners

List all owners of a scraper target

Parameters
string$scraper_target_idThe scraper target 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

◆ getScrapersIDOwnersRequest()

InfluxDB2\Service\ScraperTargetsService::getScrapersIDOwnersRequest ( $scraper_target_id,
$zap_trace_span = null )
protected

Create request for operation 'getScrapersIDOwners'

Parameters
string$scraper_target_idThe scraper target ID. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getScrapersIDOwnersWithHttpInfo()

InfluxDB2\Service\ScraperTargetsService::getScrapersIDOwnersWithHttpInfo ( $scraper_target_id,
$zap_trace_span = null )

Operation getScrapersIDOwnersWithHttpInfo

List all owners of a scraper target

Parameters
string$scraper_target_idThe scraper target 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, HTTP status code, HTTP response headers (array of strings)

◆ getScrapersIDRequest()

InfluxDB2\Service\ScraperTargetsService::getScrapersIDRequest ( $scraper_target_id,
$zap_trace_span = null )
protected

Create request for operation 'getScrapersID'

Parameters
string$scraper_target_idThe identifier of the scraper target. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getScrapersIDWithHttpInfo()

InfluxDB2\Service\ScraperTargetsService::getScrapersIDWithHttpInfo ( $scraper_target_id,
$zap_trace_span = null )

Operation getScrapersIDWithHttpInfo

Retrieve a scraper target

Parameters
string$scraper_target_idThe identifier of the scraper target. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getScrapersRequest()

InfluxDB2\Service\ScraperTargetsService::getScrapersRequest ( $zap_trace_span = null,
$name = null,
$id = null,
$org_id = null,
$org = null )
protected

Create request for operation 'getScrapers'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$nameSpecifies the name of the scraper target. (optional)
string[]$idList of scraper target IDs to return. If both `id` and `owner` are specified, only `id` is used. (optional)
string$org_idSpecifies the organization ID of the scraper target. (optional)
string$orgSpecifies the organization name of the scraper target. (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getScrapersWithHttpInfo()

InfluxDB2\Service\ScraperTargetsService::getScrapersWithHttpInfo ( $zap_trace_span = null,
$name = null,
$id = null,
$org_id = null,
$org = null )

Operation getScrapersWithHttpInfo

List all scraper targets

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$nameSpecifies the name of the scraper target. (optional)
string[]$idList of scraper target IDs to return. If both `id` and `owner` are specified, only `id` is used. (optional)
string$org_idSpecifies the organization ID of the scraper target. (optional)
string$orgSpecifies the organization name of the scraper target. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\ScraperTargetResponses, HTTP status code, HTTP response headers (array of strings)

◆ patchScrapersID()

InfluxDB2\Service\ScraperTargetsService::patchScrapersID ( $scraper_target_id,
$scraper_target_request,
$zap_trace_span = null )

Operation patchScrapersID

Update a scraper target

Parameters
string$scraper_target_idThe identifier of the scraper target. (required)
\InfluxDB2\Model\ScraperTargetRequest$scraper_target_requestScraper target update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\ScraperTargetResponse|\InfluxDB2\Model\Error

◆ patchScrapersIDRequest()

InfluxDB2\Service\ScraperTargetsService::patchScrapersIDRequest ( $scraper_target_id,
$scraper_target_request,
$zap_trace_span = null )
protected

Create request for operation 'patchScrapersID'

Parameters
string$scraper_target_idThe identifier of the scraper target. (required)
\InfluxDB2\Model\ScraperTargetRequest$scraper_target_requestScraper target update to apply (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ patchScrapersIDWithHttpInfo()

InfluxDB2\Service\ScraperTargetsService::patchScrapersIDWithHttpInfo ( $scraper_target_id,
$scraper_target_request,
$zap_trace_span = null )

Operation patchScrapersIDWithHttpInfo

Update a scraper target

Parameters
string$scraper_target_idThe identifier of the scraper target. (required)
\InfluxDB2\Model\ScraperTargetRequest$scraper_target_requestScraper target 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\ScraperTargetResponse|\InfluxDB2\Model\Error, HTTP status code, HTTP response headers (array of strings)

◆ postScrapers()

InfluxDB2\Service\ScraperTargetsService::postScrapers ( $scraper_target_request,
$zap_trace_span = null )

Operation postScrapers

Create a scraper target

Parameters
\InfluxDB2\Model\ScraperTargetRequest$scraper_target_requestScraper target to create (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\ScraperTargetResponse|\InfluxDB2\Model\Error

◆ postScrapersIDLabels()

InfluxDB2\Service\ScraperTargetsService::postScrapersIDLabels ( $scraper_target_id,
$label_mapping,
$zap_trace_span = null )

Operation postScrapersIDLabels

Add a label to a scraper target

Parameters
string$scraper_target_idThe scraper target ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingLabel to add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
\InfluxDB2\Model\LabelResponse|\InfluxDB2\Model\Error

◆ postScrapersIDLabelsRequest()

InfluxDB2\Service\ScraperTargetsService::postScrapersIDLabelsRequest ( $scraper_target_id,
$label_mapping,
$zap_trace_span = null )
protected

Create request for operation 'postScrapersIDLabels'

Parameters
string$scraper_target_idThe scraper target ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingLabel to add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ postScrapersIDLabelsWithHttpInfo()

InfluxDB2\Service\ScraperTargetsService::postScrapersIDLabelsWithHttpInfo ( $scraper_target_id,
$label_mapping,
$zap_trace_span = null )

Operation postScrapersIDLabelsWithHttpInfo

Add a label to a scraper target

Parameters
string$scraper_target_idThe scraper target ID. (required)
\InfluxDB2\Model\LabelMapping$label_mappingLabel to add (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ postScrapersIDMembers()

InfluxDB2\Service\ScraperTargetsService::postScrapersIDMembers ( $scraper_target_id,
$add_resource_member_request_body,
$zap_trace_span = null )

Operation postScrapersIDMembers

Add a member to a scraper target

Parameters
string$scraper_target_idThe scraper target 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

◆ postScrapersIDMembersRequest()

InfluxDB2\Service\ScraperTargetsService::postScrapersIDMembersRequest ( $scraper_target_id,
$add_resource_member_request_body,
$zap_trace_span = null )
protected

Create request for operation 'postScrapersIDMembers'

Parameters
string$scraper_target_idThe scraper target 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
\Psr\Http\Message\RequestInterface

◆ postScrapersIDMembersWithHttpInfo()

InfluxDB2\Service\ScraperTargetsService::postScrapersIDMembersWithHttpInfo ( $scraper_target_id,
$add_resource_member_request_body,
$zap_trace_span = null )

Operation postScrapersIDMembersWithHttpInfo

Add a member to a scraper target

Parameters
string$scraper_target_idThe scraper target 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)

◆ postScrapersIDOwners()

InfluxDB2\Service\ScraperTargetsService::postScrapersIDOwners ( $scraper_target_id,
$add_resource_member_request_body,
$zap_trace_span = null )

Operation postScrapersIDOwners

Add an owner to a scraper target

Parameters
string$scraper_target_idThe scraper target 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

◆ postScrapersIDOwnersRequest()

InfluxDB2\Service\ScraperTargetsService::postScrapersIDOwnersRequest ( $scraper_target_id,
$add_resource_member_request_body,
$zap_trace_span = null )
protected

Create request for operation 'postScrapersIDOwners'

Parameters
string$scraper_target_idThe scraper target 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
\Psr\Http\Message\RequestInterface

◆ postScrapersIDOwnersWithHttpInfo()

InfluxDB2\Service\ScraperTargetsService::postScrapersIDOwnersWithHttpInfo ( $scraper_target_id,
$add_resource_member_request_body,
$zap_trace_span = null )

Operation postScrapersIDOwnersWithHttpInfo

Add an owner to a scraper target

Parameters
string$scraper_target_idThe scraper target 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)

◆ postScrapersRequest()

InfluxDB2\Service\ScraperTargetsService::postScrapersRequest ( $scraper_target_request,
$zap_trace_span = null )
protected

Create request for operation 'postScrapers'

Parameters
\InfluxDB2\Model\ScraperTargetRequest$scraper_target_requestScraper target to create (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ postScrapersWithHttpInfo()

InfluxDB2\Service\ScraperTargetsService::postScrapersWithHttpInfo ( $scraper_target_request,
$zap_trace_span = null )

Operation postScrapersWithHttpInfo

Create a scraper target

Parameters
\InfluxDB2\Model\ScraperTargetRequest$scraper_target_requestScraper target to create (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

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