Class ScraperTargetsService
Represents a collection of functions to interact with the API endpoints
Inheritance
Implements
Namespace: InfluxDB.Client.Api.Service
Assembly: InfluxDB.Client.dll
Syntax
public class ScraperTargetsService : object, IScraperTargetsService, IApiAccessor
Constructors
ScraperTargetsService(Configuration)
Initializes a new instance of the ScraperTargetsService class using Configuration object
Declaration
public ScraperTargetsService(Configuration configuration = null)
Parameters
Type | Name | Description |
---|---|---|
InfluxDB.Client.Api.Client.Configuration | configuration | An instance of Configuration |
ScraperTargetsService(String)
Initializes a new instance of the ScraperTargetsService class.
Declaration
public ScraperTargetsService(string basePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | basePath |
Properties
Configuration
Gets or sets the configuration object
Declaration
public Configuration Configuration { get; set; }
Property Value
Type | Description |
---|---|
InfluxDB.Client.Api.Client.Configuration | An instance of the Configuration |
ExceptionFactory
Provides a factory method hook for the creation of exceptions.
Declaration
public ExceptionFactory ExceptionFactory { get; set; }
Property Value
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ExceptionFactory |
Methods
AddDefaultHeader(String, String)
Add default header.
Declaration
public void AddDefaultHeader(string key, string value)
Parameters
Type | Name | Description |
---|---|---|
System.String | key | Header field name. |
System.String | value | Header field value. |
DefaultHeader()
Gets the default header.
Declaration
public IDictionary<string, string> DefaultHeader()
Returns
Type | Description |
---|---|
IDictionary<System.String, System.String> | Dictionary of HTTP header |
DeleteScrapersID(String, String)
Delete a scraper target
Declaration
public void DeleteScrapersID(string scraperTargetID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The identifier of the scraper target. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteScrapersIDAsync(String, String, CancellationToken)
Delete a scraper target
Declaration
public System.Threading.Tasks.Task DeleteScrapersIDAsync(string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The identifier of the scraper target. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Task of void |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteScrapersIDAsyncWithHttpInfo(String, String, CancellationToken)
Delete a scraper target
Declaration
public async System.Threading.Tasks.Task<ApiResponse<object>> DeleteScrapersIDAsyncWithHttpInfo(string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The identifier of the scraper target. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<System.Object>> | Task of ApiResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteScrapersIDAsyncWithIRestResponse(String, String, CancellationToken)
Delete a scraper target
Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteScrapersIDAsyncWithIRestResponse(string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The identifier of the scraper target. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | Task of RestResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteScrapersIDLabelsID(String, String, String)
Delete a label from a scraper target
Declaration
public void DeleteScrapersIDLabelsID(string scraperTargetID, string labelID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
System.String | labelID | The label ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteScrapersIDLabelsIDAsync(String, String, String, CancellationToken)
Delete a label from a scraper target
Declaration
public System.Threading.Tasks.Task DeleteScrapersIDLabelsIDAsync(string scraperTargetID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
System.String | labelID | The label ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Task of void |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteScrapersIDLabelsIDAsyncWithHttpInfo(String, String, String, CancellationToken)
Delete a label from a scraper target
Declaration
public async System.Threading.Tasks.Task<ApiResponse<object>> DeleteScrapersIDLabelsIDAsyncWithHttpInfo(string scraperTargetID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
System.String | labelID | The label ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<System.Object>> | Task of ApiResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteScrapersIDLabelsIDAsyncWithIRestResponse(String, String, String, CancellationToken)
Delete a label from a scraper target
Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteScrapersIDLabelsIDAsyncWithIRestResponse(string scraperTargetID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
System.String | labelID | The label ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | Task of RestResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteScrapersIDLabelsIDWithHttpInfo(String, String, String)
Delete a label from a scraper target
Declaration
public ApiResponse<object> DeleteScrapersIDLabelsIDWithHttpInfo(string scraperTargetID, string labelID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
System.String | labelID | The label ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<System.Object> | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteScrapersIDLabelsIDWithIRestResponse(String, String, String)
Delete a label from a scraper target
Declaration
public RestResponse DeleteScrapersIDLabelsIDWithIRestResponse(string scraperTargetID, string labelID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
System.String | labelID | The label ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestResponse | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteScrapersIDLabelsIDWithIRestResponseAsync(String, String, String, CancellationToken)
Delete a label from a scraper target
Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteScrapersIDLabelsIDWithIRestResponseAsync(string scraperTargetID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
System.String | labelID | The label ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteScrapersIDLabelsIDWithRestRequest(String, String, String)
Delete a label from a scraper target
Declaration
public RestRequest DeleteScrapersIDLabelsIDWithRestRequest(string scraperTargetID, string labelID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
System.String | labelID | The label ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestRequest | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteScrapersIDMembersID(String, String, String)
Remove a member from a scraper target
Declaration
public void DeleteScrapersIDMembersID(string userID, string scraperTargetID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | userID | The ID of member to remove. |
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteScrapersIDMembersIDAsync(String, String, String, CancellationToken)
Remove a member from a scraper target
Declaration
public System.Threading.Tasks.Task DeleteScrapersIDMembersIDAsync(string userID, string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | userID | The ID of member to remove. |
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Task of void |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteScrapersIDMembersIDAsyncWithHttpInfo(String, String, String, CancellationToken)
Remove a member from a scraper target
Declaration
public async System.Threading.Tasks.Task<ApiResponse<object>> DeleteScrapersIDMembersIDAsyncWithHttpInfo(string userID, string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | userID | The ID of member to remove. |
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<System.Object>> | Task of ApiResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteScrapersIDMembersIDAsyncWithIRestResponse(String, String, String, CancellationToken)
Remove a member from a scraper target
Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteScrapersIDMembersIDAsyncWithIRestResponse(string userID, string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | userID | The ID of member to remove. |
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | Task of RestResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteScrapersIDMembersIDWithHttpInfo(String, String, String)
Remove a member from a scraper target
Declaration
public ApiResponse<object> DeleteScrapersIDMembersIDWithHttpInfo(string userID, string scraperTargetID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | userID | The ID of member to remove. |
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<System.Object> | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteScrapersIDMembersIDWithIRestResponse(String, String, String)
Remove a member from a scraper target
Declaration
public RestResponse DeleteScrapersIDMembersIDWithIRestResponse(string userID, string scraperTargetID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | userID | The ID of member to remove. |
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestResponse | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteScrapersIDMembersIDWithIRestResponseAsync(String, String, String, CancellationToken)
Remove a member from a scraper target
Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteScrapersIDMembersIDWithIRestResponseAsync(string userID, string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | userID | The ID of member to remove. |
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteScrapersIDMembersIDWithRestRequest(String, String, String)
Remove a member from a scraper target
Declaration
public RestRequest DeleteScrapersIDMembersIDWithRestRequest(string userID, string scraperTargetID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | userID | The ID of member to remove. |
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestRequest | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteScrapersIDOwnersID(String, String, String)
Remove an owner from a scraper target
Declaration
public void DeleteScrapersIDOwnersID(string userID, string scraperTargetID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | userID | The ID of owner to remove. |
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteScrapersIDOwnersIDAsync(String, String, String, CancellationToken)
Remove an owner from a scraper target
Declaration
public System.Threading.Tasks.Task DeleteScrapersIDOwnersIDAsync(string userID, string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | userID | The ID of owner to remove. |
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Task of void |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteScrapersIDOwnersIDAsyncWithHttpInfo(String, String, String, CancellationToken)
Remove an owner from a scraper target
Declaration
public async System.Threading.Tasks.Task<ApiResponse<object>> DeleteScrapersIDOwnersIDAsyncWithHttpInfo(string userID, string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | userID | The ID of owner to remove. |
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<System.Object>> | Task of ApiResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteScrapersIDOwnersIDAsyncWithIRestResponse(String, String, String, CancellationToken)
Remove an owner from a scraper target
Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteScrapersIDOwnersIDAsyncWithIRestResponse(string userID, string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | userID | The ID of owner to remove. |
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | Task of RestResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteScrapersIDOwnersIDWithHttpInfo(String, String, String)
Remove an owner from a scraper target
Declaration
public ApiResponse<object> DeleteScrapersIDOwnersIDWithHttpInfo(string userID, string scraperTargetID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | userID | The ID of owner to remove. |
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<System.Object> | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteScrapersIDOwnersIDWithIRestResponse(String, String, String)
Remove an owner from a scraper target
Declaration
public RestResponse DeleteScrapersIDOwnersIDWithIRestResponse(string userID, string scraperTargetID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | userID | The ID of owner to remove. |
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestResponse | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteScrapersIDOwnersIDWithIRestResponseAsync(String, String, String, CancellationToken)
Remove an owner from a scraper target
Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteScrapersIDOwnersIDWithIRestResponseAsync(string userID, string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | userID | The ID of owner to remove. |
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteScrapersIDOwnersIDWithRestRequest(String, String, String)
Remove an owner from a scraper target
Declaration
public RestRequest DeleteScrapersIDOwnersIDWithRestRequest(string userID, string scraperTargetID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | userID | The ID of owner to remove. |
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestRequest | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteScrapersIDWithHttpInfo(String, String)
Delete a scraper target
Declaration
public ApiResponse<object> DeleteScrapersIDWithHttpInfo(string scraperTargetID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The identifier of the scraper target. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<System.Object> | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteScrapersIDWithIRestResponse(String, String)
Delete a scraper target
Declaration
public RestResponse DeleteScrapersIDWithIRestResponse(string scraperTargetID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The identifier of the scraper target. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestResponse | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteScrapersIDWithIRestResponseAsync(String, String, CancellationToken)
Delete a scraper target
Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteScrapersIDWithIRestResponseAsync(string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The identifier of the scraper target. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteScrapersIDWithRestRequest(String, String)
Delete a scraper target
Declaration
public RestRequest DeleteScrapersIDWithRestRequest(string scraperTargetID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The identifier of the scraper target. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestRequest | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetBasePath()
Gets the base path of the API client.
Declaration
public string GetBasePath()
Returns
Type | Description |
---|---|
System.String | The base path |
GetScrapers(String, String, List<String>, String, String)
List all scraper targets
Declaration
public ScraperTargetResponses GetScrapers(string zapTraceSpan = null, string name = null, List<string> id = null, string orgID = null, string org = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | zapTraceSpan | OpenTracing span context (optional) |
System.String | name | Specifies the name of the scraper target. (optional) |
List<System.String> | id | List of scraper target IDs to return. If both |
System.String | orgID | Specifies the organization ID of the scraper target. (optional) |
System.String | org | Specifies the organization name of the scraper target. (optional) |
Returns
Type | Description |
---|---|
ScraperTargetResponses | ScraperTargetResponses |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersAsync(String, String, List<String>, String, String, CancellationToken)
List all scraper targets
Declaration
public async System.Threading.Tasks.Task<ScraperTargetResponses> GetScrapersAsync(string zapTraceSpan = null, string name = null, List<string> id = null, string orgID = null, string org = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | zapTraceSpan | OpenTracing span context (optional) |
System.String | name | Specifies the name of the scraper target. (optional) |
List<System.String> | id | List of scraper target IDs to return. If both |
System.String | orgID | Specifies the organization ID of the scraper target. (optional) |
System.String | org | Specifies the organization name of the scraper target. (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ScraperTargetResponses> | Task of ScraperTargetResponses |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersAsyncWithHttpInfo(String, String, List<String>, String, String, CancellationToken)
List all scraper targets
Declaration
public async System.Threading.Tasks.Task<ApiResponse<ScraperTargetResponses>> GetScrapersAsyncWithHttpInfo(string zapTraceSpan = null, string name = null, List<string> id = null, string orgID = null, string org = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | zapTraceSpan | OpenTracing span context (optional) |
System.String | name | Specifies the name of the scraper target. (optional) |
List<System.String> | id | List of scraper target IDs to return. If both |
System.String | orgID | Specifies the organization ID of the scraper target. (optional) |
System.String | org | Specifies the organization name of the scraper target. (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<ScraperTargetResponses>> | Task of ApiResponse (ScraperTargetResponses) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersAsyncWithIRestResponse(String, String, List<String>, String, String, CancellationToken)
List all scraper targets
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetScrapersAsyncWithIRestResponse(string zapTraceSpan = null, string name = null, List<string> id = null, string orgID = null, string org = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | zapTraceSpan | OpenTracing span context (optional) |
System.String | name | Specifies the name of the scraper target. (optional) |
List<System.String> | id | List of scraper target IDs to return. If both |
System.String | orgID | Specifies the organization ID of the scraper target. (optional) |
System.String | org | Specifies the organization name of the scraper target. (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | Task of RestResponse (ScraperTargetResponses) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersID(String, String)
Retrieve a scraper target
Declaration
public ScraperTargetResponse GetScrapersID(string scraperTargetID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The identifier of the scraper target. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
ScraperTargetResponse | ScraperTargetResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersIDAsync(String, String, CancellationToken)
Retrieve a scraper target
Declaration
public async System.Threading.Tasks.Task<ScraperTargetResponse> GetScrapersIDAsync(string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The identifier of the scraper target. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ScraperTargetResponse> | Task of ScraperTargetResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersIDAsyncWithHttpInfo(String, String, CancellationToken)
Retrieve a scraper target
Declaration
public async System.Threading.Tasks.Task<ApiResponse<ScraperTargetResponse>> GetScrapersIDAsyncWithHttpInfo(string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The identifier of the scraper target. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<ScraperTargetResponse>> | Task of ApiResponse (ScraperTargetResponse) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersIDAsyncWithIRestResponse(String, String, CancellationToken)
Retrieve a scraper target
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetScrapersIDAsyncWithIRestResponse(string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The identifier of the scraper target. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | Task of RestResponse (ScraperTargetResponse) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersIDLabels(String, String)
List all labels for a scraper target
Declaration
public LabelsResponse GetScrapersIDLabels(string scraperTargetID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
LabelsResponse | LabelsResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersIDLabelsAsync(String, String, CancellationToken)
List all labels for a scraper target
Declaration
public async System.Threading.Tasks.Task<LabelsResponse> GetScrapersIDLabelsAsync(string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<LabelsResponse> | Task of LabelsResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersIDLabelsAsyncWithHttpInfo(String, String, CancellationToken)
List all labels for a scraper target
Declaration
public async System.Threading.Tasks.Task<ApiResponse<LabelsResponse>> GetScrapersIDLabelsAsyncWithHttpInfo(string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<LabelsResponse>> | Task of ApiResponse (LabelsResponse) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersIDLabelsAsyncWithIRestResponse(String, String, CancellationToken)
List all labels for a scraper target
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetScrapersIDLabelsAsyncWithIRestResponse(string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | Task of RestResponse (LabelsResponse) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersIDLabelsWithHttpInfo(String, String)
List all labels for a scraper target
Declaration
public ApiResponse<LabelsResponse> GetScrapersIDLabelsWithHttpInfo(string scraperTargetID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<LabelsResponse> | ApiResponse of LabelsResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersIDLabelsWithIRestResponse(String, String)
List all labels for a scraper target
Declaration
public RestResponse GetScrapersIDLabelsWithIRestResponse(string scraperTargetID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestResponse | ApiResponse of LabelsResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersIDLabelsWithIRestResponseAsync(String, String, CancellationToken)
List all labels for a scraper target
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetScrapersIDLabelsWithIRestResponseAsync(string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | ApiResponse of LabelsResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersIDLabelsWithRestRequest(String, String)
List all labels for a scraper target
Declaration
public RestRequest GetScrapersIDLabelsWithRestRequest(string scraperTargetID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestRequest | ApiResponse of LabelsResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersIDMembers(String, String)
List all users with member privileges for a scraper target
Declaration
public ResourceMembers GetScrapersIDMembers(string scraperTargetID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
ResourceMembers | ResourceMembers |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersIDMembersAsync(String, String, CancellationToken)
List all users with member privileges for a scraper target
Declaration
public async System.Threading.Tasks.Task<ResourceMembers> GetScrapersIDMembersAsync(string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ResourceMembers> | Task of ResourceMembers |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersIDMembersAsyncWithHttpInfo(String, String, CancellationToken)
List all users with member privileges for a scraper target
Declaration
public async System.Threading.Tasks.Task<ApiResponse<ResourceMembers>> GetScrapersIDMembersAsyncWithHttpInfo(string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<ResourceMembers>> | Task of ApiResponse (ResourceMembers) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersIDMembersAsyncWithIRestResponse(String, String, CancellationToken)
List all users with member privileges for a scraper target
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetScrapersIDMembersAsyncWithIRestResponse(string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | Task of RestResponse (ResourceMembers) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersIDMembersWithHttpInfo(String, String)
List all users with member privileges for a scraper target
Declaration
public ApiResponse<ResourceMembers> GetScrapersIDMembersWithHttpInfo(string scraperTargetID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<ResourceMembers> | ApiResponse of ResourceMembers |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersIDMembersWithIRestResponse(String, String)
List all users with member privileges for a scraper target
Declaration
public RestResponse GetScrapersIDMembersWithIRestResponse(string scraperTargetID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestResponse | ApiResponse of ResourceMembers |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersIDMembersWithIRestResponseAsync(String, String, CancellationToken)
List all users with member privileges for a scraper target
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetScrapersIDMembersWithIRestResponseAsync(string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | ApiResponse of ResourceMembers |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersIDMembersWithRestRequest(String, String)
List all users with member privileges for a scraper target
Declaration
public RestRequest GetScrapersIDMembersWithRestRequest(string scraperTargetID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestRequest | ApiResponse of ResourceMembers |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersIDOwners(String, String)
List all owners of a scraper target
Declaration
public ResourceOwners GetScrapersIDOwners(string scraperTargetID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
ResourceOwners | ResourceOwners |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersIDOwnersAsync(String, String, CancellationToken)
List all owners of a scraper target
Declaration
public async System.Threading.Tasks.Task<ResourceOwners> GetScrapersIDOwnersAsync(string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ResourceOwners> | Task of ResourceOwners |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersIDOwnersAsyncWithHttpInfo(String, String, CancellationToken)
List all owners of a scraper target
Declaration
public async System.Threading.Tasks.Task<ApiResponse<ResourceOwners>> GetScrapersIDOwnersAsyncWithHttpInfo(string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<ResourceOwners>> | Task of ApiResponse (ResourceOwners) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersIDOwnersAsyncWithIRestResponse(String, String, CancellationToken)
List all owners of a scraper target
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetScrapersIDOwnersAsyncWithIRestResponse(string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | Task of RestResponse (ResourceOwners) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersIDOwnersWithHttpInfo(String, String)
List all owners of a scraper target
Declaration
public ApiResponse<ResourceOwners> GetScrapersIDOwnersWithHttpInfo(string scraperTargetID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<ResourceOwners> | ApiResponse of ResourceOwners |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersIDOwnersWithIRestResponse(String, String)
List all owners of a scraper target
Declaration
public RestResponse GetScrapersIDOwnersWithIRestResponse(string scraperTargetID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestResponse | ApiResponse of ResourceOwners |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersIDOwnersWithIRestResponseAsync(String, String, CancellationToken)
List all owners of a scraper target
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetScrapersIDOwnersWithIRestResponseAsync(string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | ApiResponse of ResourceOwners |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersIDOwnersWithRestRequest(String, String)
List all owners of a scraper target
Declaration
public RestRequest GetScrapersIDOwnersWithRestRequest(string scraperTargetID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestRequest | ApiResponse of ResourceOwners |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersIDWithHttpInfo(String, String)
Retrieve a scraper target
Declaration
public ApiResponse<ScraperTargetResponse> GetScrapersIDWithHttpInfo(string scraperTargetID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The identifier of the scraper target. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<ScraperTargetResponse> | ApiResponse of ScraperTargetResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersIDWithIRestResponse(String, String)
Retrieve a scraper target
Declaration
public RestResponse GetScrapersIDWithIRestResponse(string scraperTargetID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The identifier of the scraper target. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestResponse | ApiResponse of ScraperTargetResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersIDWithIRestResponseAsync(String, String, CancellationToken)
Retrieve a scraper target
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetScrapersIDWithIRestResponseAsync(string scraperTargetID, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The identifier of the scraper target. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | ApiResponse of ScraperTargetResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersIDWithRestRequest(String, String)
Retrieve a scraper target
Declaration
public RestRequest GetScrapersIDWithRestRequest(string scraperTargetID, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The identifier of the scraper target. |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestRequest | ApiResponse of ScraperTargetResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersWithHttpInfo(String, String, List<String>, String, String)
List all scraper targets
Declaration
public ApiResponse<ScraperTargetResponses> GetScrapersWithHttpInfo(string zapTraceSpan = null, string name = null, List<string> id = null, string orgID = null, string org = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | zapTraceSpan | OpenTracing span context (optional) |
System.String | name | Specifies the name of the scraper target. (optional) |
List<System.String> | id | List of scraper target IDs to return. If both |
System.String | orgID | Specifies the organization ID of the scraper target. (optional) |
System.String | org | Specifies the organization name of the scraper target. (optional) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<ScraperTargetResponses> | ApiResponse of ScraperTargetResponses |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersWithIRestResponse(String, String, List<String>, String, String)
List all scraper targets
Declaration
public RestResponse GetScrapersWithIRestResponse(string zapTraceSpan = null, string name = null, List<string> id = null, string orgID = null, string org = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | zapTraceSpan | OpenTracing span context (optional) |
System.String | name | Specifies the name of the scraper target. (optional) |
List<System.String> | id | List of scraper target IDs to return. If both |
System.String | orgID | Specifies the organization ID of the scraper target. (optional) |
System.String | org | Specifies the organization name of the scraper target. (optional) |
Returns
Type | Description |
---|---|
RestResponse | ApiResponse of ScraperTargetResponses |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersWithIRestResponseAsync(String, String, List<String>, String, String, CancellationToken)
List all scraper targets
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetScrapersWithIRestResponseAsync(string zapTraceSpan = null, string name = null, List<string> id = null, string orgID = null, string org = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | zapTraceSpan | OpenTracing span context (optional) |
System.String | name | Specifies the name of the scraper target. (optional) |
List<System.String> | id | List of scraper target IDs to return. If both |
System.String | orgID | Specifies the organization ID of the scraper target. (optional) |
System.String | org | Specifies the organization name of the scraper target. (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | ApiResponse of ScraperTargetResponses |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetScrapersWithRestRequest(String, String, List<String>, String, String)
List all scraper targets
Declaration
public RestRequest GetScrapersWithRestRequest(string zapTraceSpan = null, string name = null, List<string> id = null, string orgID = null, string org = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | zapTraceSpan | OpenTracing span context (optional) |
System.String | name | Specifies the name of the scraper target. (optional) |
List<System.String> | id | List of scraper target IDs to return. If both |
System.String | orgID | Specifies the organization ID of the scraper target. (optional) |
System.String | org | Specifies the organization name of the scraper target. (optional) |
Returns
Type | Description |
---|---|
RestRequest | ApiResponse of ScraperTargetResponses |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchScrapersID(String, ScraperTargetRequest, String)
Update a scraper target
Declaration
public ScraperTargetResponse PatchScrapersID(string scraperTargetID, ScraperTargetRequest scraperTargetRequest, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The identifier of the scraper target. |
ScraperTargetRequest | scraperTargetRequest | Scraper target update to apply |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
ScraperTargetResponse | ScraperTargetResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchScrapersIDAsync(String, ScraperTargetRequest, String, CancellationToken)
Update a scraper target
Declaration
public async System.Threading.Tasks.Task<ScraperTargetResponse> PatchScrapersIDAsync(string scraperTargetID, ScraperTargetRequest scraperTargetRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The identifier of the scraper target. |
ScraperTargetRequest | scraperTargetRequest | Scraper target update to apply |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ScraperTargetResponse> | Task of ScraperTargetResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchScrapersIDAsyncWithHttpInfo(String, ScraperTargetRequest, String, CancellationToken)
Update a scraper target
Declaration
public async System.Threading.Tasks.Task<ApiResponse<ScraperTargetResponse>> PatchScrapersIDAsyncWithHttpInfo(string scraperTargetID, ScraperTargetRequest scraperTargetRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The identifier of the scraper target. |
ScraperTargetRequest | scraperTargetRequest | Scraper target update to apply |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<ScraperTargetResponse>> | Task of ApiResponse (ScraperTargetResponse) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchScrapersIDAsyncWithIRestResponse(String, ScraperTargetRequest, String, CancellationToken)
Update a scraper target
Declaration
public async System.Threading.Tasks.Task<RestResponse> PatchScrapersIDAsyncWithIRestResponse(string scraperTargetID, ScraperTargetRequest scraperTargetRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The identifier of the scraper target. |
ScraperTargetRequest | scraperTargetRequest | Scraper target update to apply |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | Task of RestResponse (ScraperTargetResponse) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchScrapersIDWithHttpInfo(String, ScraperTargetRequest, String)
Update a scraper target
Declaration
public ApiResponse<ScraperTargetResponse> PatchScrapersIDWithHttpInfo(string scraperTargetID, ScraperTargetRequest scraperTargetRequest, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The identifier of the scraper target. |
ScraperTargetRequest | scraperTargetRequest | Scraper target update to apply |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<ScraperTargetResponse> | ApiResponse of ScraperTargetResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchScrapersIDWithIRestResponse(String, ScraperTargetRequest, String)
Update a scraper target
Declaration
public RestResponse PatchScrapersIDWithIRestResponse(string scraperTargetID, ScraperTargetRequest scraperTargetRequest, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The identifier of the scraper target. |
ScraperTargetRequest | scraperTargetRequest | Scraper target update to apply |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestResponse | ApiResponse of ScraperTargetResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchScrapersIDWithIRestResponseAsync(String, ScraperTargetRequest, String, CancellationToken)
Update a scraper target
Declaration
public async System.Threading.Tasks.Task<RestResponse> PatchScrapersIDWithIRestResponseAsync(string scraperTargetID, ScraperTargetRequest scraperTargetRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The identifier of the scraper target. |
ScraperTargetRequest | scraperTargetRequest | Scraper target update to apply |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | ApiResponse of ScraperTargetResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchScrapersIDWithRestRequest(String, ScraperTargetRequest, String)
Update a scraper target
Declaration
public RestRequest PatchScrapersIDWithRestRequest(string scraperTargetID, ScraperTargetRequest scraperTargetRequest, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The identifier of the scraper target. |
ScraperTargetRequest | scraperTargetRequest | Scraper target update to apply |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestRequest | ApiResponse of ScraperTargetResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostScrapers(ScraperTargetRequest, String)
Create a scraper target
Declaration
public ScraperTargetResponse PostScrapers(ScraperTargetRequest scraperTargetRequest, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
ScraperTargetRequest | scraperTargetRequest | Scraper target to create |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
ScraperTargetResponse | ScraperTargetResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostScrapersAsync(ScraperTargetRequest, String, CancellationToken)
Create a scraper target
Declaration
public async System.Threading.Tasks.Task<ScraperTargetResponse> PostScrapersAsync(ScraperTargetRequest scraperTargetRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
ScraperTargetRequest | scraperTargetRequest | Scraper target to create |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ScraperTargetResponse> | Task of ScraperTargetResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostScrapersAsyncWithHttpInfo(ScraperTargetRequest, String, CancellationToken)
Create a scraper target
Declaration
public async System.Threading.Tasks.Task<ApiResponse<ScraperTargetResponse>> PostScrapersAsyncWithHttpInfo(ScraperTargetRequest scraperTargetRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
ScraperTargetRequest | scraperTargetRequest | Scraper target to create |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<ScraperTargetResponse>> | Task of ApiResponse (ScraperTargetResponse) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostScrapersAsyncWithIRestResponse(ScraperTargetRequest, String, CancellationToken)
Create a scraper target
Declaration
public async System.Threading.Tasks.Task<RestResponse> PostScrapersAsyncWithIRestResponse(ScraperTargetRequest scraperTargetRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
ScraperTargetRequest | scraperTargetRequest | Scraper target to create |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | Task of RestResponse (ScraperTargetResponse) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostScrapersIDLabels(String, LabelMapping, String)
Add a label to a scraper target
Declaration
public LabelResponse PostScrapersIDLabels(string scraperTargetID, LabelMapping labelMapping, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
LabelMapping | labelMapping | Label to add |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
LabelResponse | LabelResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostScrapersIDLabelsAsync(String, LabelMapping, String, CancellationToken)
Add a label to a scraper target
Declaration
public async System.Threading.Tasks.Task<LabelResponse> PostScrapersIDLabelsAsync(string scraperTargetID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
LabelMapping | labelMapping | Label to add |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<LabelResponse> | Task of LabelResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostScrapersIDLabelsAsyncWithHttpInfo(String, LabelMapping, String, CancellationToken)
Add a label to a scraper target
Declaration
public async System.Threading.Tasks.Task<ApiResponse<LabelResponse>> PostScrapersIDLabelsAsyncWithHttpInfo(string scraperTargetID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
LabelMapping | labelMapping | Label to add |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<LabelResponse>> | Task of ApiResponse (LabelResponse) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostScrapersIDLabelsAsyncWithIRestResponse(String, LabelMapping, String, CancellationToken)
Add a label to a scraper target
Declaration
public async System.Threading.Tasks.Task<RestResponse> PostScrapersIDLabelsAsyncWithIRestResponse(string scraperTargetID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
LabelMapping | labelMapping | Label to add |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | Task of RestResponse (LabelResponse) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostScrapersIDLabelsWithHttpInfo(String, LabelMapping, String)
Add a label to a scraper target
Declaration
public ApiResponse<LabelResponse> PostScrapersIDLabelsWithHttpInfo(string scraperTargetID, LabelMapping labelMapping, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
LabelMapping | labelMapping | Label to add |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<LabelResponse> | ApiResponse of LabelResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostScrapersIDLabelsWithIRestResponse(String, LabelMapping, String)
Add a label to a scraper target
Declaration
public RestResponse PostScrapersIDLabelsWithIRestResponse(string scraperTargetID, LabelMapping labelMapping, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
LabelMapping | labelMapping | Label to add |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestResponse | ApiResponse of LabelResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostScrapersIDLabelsWithIRestResponseAsync(String, LabelMapping, String, CancellationToken)
Add a label to a scraper target
Declaration
public async System.Threading.Tasks.Task<RestResponse> PostScrapersIDLabelsWithIRestResponseAsync(string scraperTargetID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
LabelMapping | labelMapping | Label to add |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | ApiResponse of LabelResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostScrapersIDLabelsWithRestRequest(String, LabelMapping, String)
Add a label to a scraper target
Declaration
public RestRequest PostScrapersIDLabelsWithRestRequest(string scraperTargetID, LabelMapping labelMapping, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
LabelMapping | labelMapping | Label to add |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestRequest | ApiResponse of LabelResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostScrapersIDMembers(String, AddResourceMemberRequestBody, String)
Add a member to a scraper target
Declaration
public ResourceMember PostScrapersIDMembers(string scraperTargetID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
AddResourceMemberRequestBody | addResourceMemberRequestBody | User to add as member |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
ResourceMember | ResourceMember |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostScrapersIDMembersAsync(String, AddResourceMemberRequestBody, String, CancellationToken)
Add a member to a scraper target
Declaration
public async System.Threading.Tasks.Task<ResourceMember> PostScrapersIDMembersAsync(string scraperTargetID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
AddResourceMemberRequestBody | addResourceMemberRequestBody | User to add as member |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ResourceMember> | Task of ResourceMember |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostScrapersIDMembersAsyncWithHttpInfo(String, AddResourceMemberRequestBody, String, CancellationToken)
Add a member to a scraper target
Declaration
public async System.Threading.Tasks.Task<ApiResponse<ResourceMember>> PostScrapersIDMembersAsyncWithHttpInfo(string scraperTargetID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
AddResourceMemberRequestBody | addResourceMemberRequestBody | User to add as member |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<ResourceMember>> | Task of ApiResponse (ResourceMember) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostScrapersIDMembersAsyncWithIRestResponse(String, AddResourceMemberRequestBody, String, CancellationToken)
Add a member to a scraper target
Declaration
public async System.Threading.Tasks.Task<RestResponse> PostScrapersIDMembersAsyncWithIRestResponse(string scraperTargetID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
AddResourceMemberRequestBody | addResourceMemberRequestBody | User to add as member |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | Task of RestResponse (ResourceMember) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostScrapersIDMembersWithHttpInfo(String, AddResourceMemberRequestBody, String)
Add a member to a scraper target
Declaration
public ApiResponse<ResourceMember> PostScrapersIDMembersWithHttpInfo(string scraperTargetID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
AddResourceMemberRequestBody | addResourceMemberRequestBody | User to add as member |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<ResourceMember> | ApiResponse of ResourceMember |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostScrapersIDMembersWithIRestResponse(String, AddResourceMemberRequestBody, String)
Add a member to a scraper target
Declaration
public RestResponse PostScrapersIDMembersWithIRestResponse(string scraperTargetID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
AddResourceMemberRequestBody | addResourceMemberRequestBody | User to add as member |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestResponse | ApiResponse of ResourceMember |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostScrapersIDMembersWithIRestResponseAsync(String, AddResourceMemberRequestBody, String, CancellationToken)
Add a member to a scraper target
Declaration
public async System.Threading.Tasks.Task<RestResponse> PostScrapersIDMembersWithIRestResponseAsync(string scraperTargetID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
AddResourceMemberRequestBody | addResourceMemberRequestBody | User to add as member |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | ApiResponse of ResourceMember |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostScrapersIDMembersWithRestRequest(String, AddResourceMemberRequestBody, String)
Add a member to a scraper target
Declaration
public RestRequest PostScrapersIDMembersWithRestRequest(string scraperTargetID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
AddResourceMemberRequestBody | addResourceMemberRequestBody | User to add as member |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestRequest | ApiResponse of ResourceMember |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostScrapersIDOwners(String, AddResourceMemberRequestBody, String)
Add an owner to a scraper target
Declaration
public ResourceOwner PostScrapersIDOwners(string scraperTargetID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
AddResourceMemberRequestBody | addResourceMemberRequestBody | User to add as owner |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
ResourceOwner | ResourceOwner |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostScrapersIDOwnersAsync(String, AddResourceMemberRequestBody, String, CancellationToken)
Add an owner to a scraper target
Declaration
public async System.Threading.Tasks.Task<ResourceOwner> PostScrapersIDOwnersAsync(string scraperTargetID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
AddResourceMemberRequestBody | addResourceMemberRequestBody | User to add as owner |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<ResourceOwner> | Task of ResourceOwner |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostScrapersIDOwnersAsyncWithHttpInfo(String, AddResourceMemberRequestBody, String, CancellationToken)
Add an owner to a scraper target
Declaration
public async System.Threading.Tasks.Task<ApiResponse<ResourceOwner>> PostScrapersIDOwnersAsyncWithHttpInfo(string scraperTargetID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
AddResourceMemberRequestBody | addResourceMemberRequestBody | User to add as owner |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<ResourceOwner>> | Task of ApiResponse (ResourceOwner) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostScrapersIDOwnersAsyncWithIRestResponse(String, AddResourceMemberRequestBody, String, CancellationToken)
Add an owner to a scraper target
Declaration
public async System.Threading.Tasks.Task<RestResponse> PostScrapersIDOwnersAsyncWithIRestResponse(string scraperTargetID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
AddResourceMemberRequestBody | addResourceMemberRequestBody | User to add as owner |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | Task of RestResponse (ResourceOwner) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostScrapersIDOwnersWithHttpInfo(String, AddResourceMemberRequestBody, String)
Add an owner to a scraper target
Declaration
public ApiResponse<ResourceOwner> PostScrapersIDOwnersWithHttpInfo(string scraperTargetID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
AddResourceMemberRequestBody | addResourceMemberRequestBody | User to add as owner |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<ResourceOwner> | ApiResponse of ResourceOwner |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostScrapersIDOwnersWithIRestResponse(String, AddResourceMemberRequestBody, String)
Add an owner to a scraper target
Declaration
public RestResponse PostScrapersIDOwnersWithIRestResponse(string scraperTargetID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
AddResourceMemberRequestBody | addResourceMemberRequestBody | User to add as owner |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestResponse | ApiResponse of ResourceOwner |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostScrapersIDOwnersWithIRestResponseAsync(String, AddResourceMemberRequestBody, String, CancellationToken)
Add an owner to a scraper target
Declaration
public async System.Threading.Tasks.Task<RestResponse> PostScrapersIDOwnersWithIRestResponseAsync(string scraperTargetID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
AddResourceMemberRequestBody | addResourceMemberRequestBody | User to add as owner |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | ApiResponse of ResourceOwner |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostScrapersIDOwnersWithRestRequest(String, AddResourceMemberRequestBody, String)
Add an owner to a scraper target
Declaration
public RestRequest PostScrapersIDOwnersWithRestRequest(string scraperTargetID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | scraperTargetID | The scraper target ID. |
AddResourceMemberRequestBody | addResourceMemberRequestBody | User to add as owner |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestRequest | ApiResponse of ResourceOwner |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostScrapersWithHttpInfo(ScraperTargetRequest, String)
Create a scraper target
Declaration
public ApiResponse<ScraperTargetResponse> PostScrapersWithHttpInfo(ScraperTargetRequest scraperTargetRequest, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
ScraperTargetRequest | scraperTargetRequest | Scraper target to create |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ApiResponse<ScraperTargetResponse> | ApiResponse of ScraperTargetResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostScrapersWithIRestResponse(ScraperTargetRequest, String)
Create a scraper target
Declaration
public RestResponse PostScrapersWithIRestResponse(ScraperTargetRequest scraperTargetRequest, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
ScraperTargetRequest | scraperTargetRequest | Scraper target to create |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestResponse | ApiResponse of ScraperTargetResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostScrapersWithIRestResponseAsync(ScraperTargetRequest, String, CancellationToken)
Create a scraper target
Declaration
public async System.Threading.Tasks.Task<RestResponse> PostScrapersWithIRestResponseAsync(ScraperTargetRequest scraperTargetRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)
Parameters
Type | Name | Description |
---|---|---|
ScraperTargetRequest | scraperTargetRequest | Scraper target to create |
System.String | zapTraceSpan | OpenTracing span context (optional) |
CancellationToken | cancellationToken | Cancellation token |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<RestResponse> | ApiResponse of ScraperTargetResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostScrapersWithRestRequest(ScraperTargetRequest, String)
Create a scraper target
Declaration
public RestRequest PostScrapersWithRestRequest(ScraperTargetRequest scraperTargetRequest, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
ScraperTargetRequest | scraperTargetRequest | Scraper target to create |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestRequest | ApiResponse of ScraperTargetResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
SetBasePath(String)
Sets the base path of the API client.
Declaration
public void SetBasePath(string basePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | basePath |