Interface IScraperTargetsApi

Namespace: InfluxDB.Client

Assembly: InfluxDB.Client.dll

Syntax

public interface IScraperTargetsApi

Methods

AddLabelAsync(Label, ScraperTargetResponse, CancellationToken)

Add a ScraperTarget label.

Declaration

Task<Label> AddLabelAsync(Label label, ScraperTargetResponse scraperTargetResponse, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
Label	label	the label of a ScraperTarget
ScraperTargetResponse	scraperTargetResponse	a ScraperTarget of a label
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<Label>	added label

AddLabelAsync(String, String, CancellationToken)

Add a ScraperTarget label.

Declaration

Task<Label> AddLabelAsync(string labelId, string scraperTargetId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	labelId	the ID of a label
System.String	scraperTargetId	the ID of a ScraperTarget
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<Label>	added label

AddMemberAsync(User, ScraperTargetResponse, CancellationToken)

Add a ScraperTarget member.

Declaration

Task<ResourceMember> AddMemberAsync(User member, ScraperTargetResponse scraperTargetResponse, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
User	member	the member of a scraperTarget
ScraperTargetResponse	scraperTargetResponse	the ScraperTarget of a member
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<ResourceMember>	created mapping

AddMemberAsync(String, String, CancellationToken)

Add a ScraperTarget member.

Declaration

Task<ResourceMember> AddMemberAsync(string memberId, string scraperTargetId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	memberId	the ID of a member
System.String	scraperTargetId	the ID of a scraperTarget
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<ResourceMember>	created mapping

AddOwnerAsync(User, ScraperTargetResponse, CancellationToken)

Add a ScraperTarget owner.

Declaration

Task<ResourceOwner> AddOwnerAsync(User owner, ScraperTargetResponse scraperTargetResponse, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
User	owner	the owner of a ScraperTarget
ScraperTargetResponse	scraperTargetResponse	the ScraperTarget of a owner
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<ResourceOwner>	created mapping

AddOwnerAsync(String, String, CancellationToken)

Add a ScraperTarget owner.

Declaration

Task<ResourceOwner> AddOwnerAsync(string ownerId, string scraperTargetId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	ownerId	the ID of a owner
System.String	scraperTargetId	the ID of a ScraperTarget
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<ResourceOwner>	created mapping

CloneScraperTargetAsync(String, ScraperTargetResponse, CancellationToken)

Clone a ScraperTarget.

Declaration

Task<ScraperTargetResponse> CloneScraperTargetAsync(string clonedName, ScraperTargetResponse scraperTargetResponse, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	clonedName	name of cloned ScraperTarget
ScraperTargetResponse	scraperTargetResponse	ScraperTarget to clone
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<ScraperTargetResponse>	cloned ScraperTarget

CloneScraperTargetAsync(String, String, CancellationToken)

Clone a ScraperTarget.

Declaration

Task<ScraperTargetResponse> CloneScraperTargetAsync(string clonedName, string scraperTargetId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	clonedName	name of cloned ScraperTarget
System.String	scraperTargetId	ID of ScraperTarget to clone
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<ScraperTargetResponse>	cloned ScraperTarget

CreateScraperTargetAsync(ScraperTargetRequest, CancellationToken)

Creates a new ScraperTarget and sets Id with the new identifier.

Declaration

Task<ScraperTargetResponse> CreateScraperTargetAsync(ScraperTargetRequest scraperTargetRequest, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
ScraperTargetRequest	scraperTargetRequest	the scraper to create
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<ScraperTargetResponse>	created ScraperTarget

CreateScraperTargetAsync(String, String, String, String, CancellationToken)

Creates a new ScraperTarget and sets Id with the new identifier.

Declaration

Task<ScraperTargetResponse> CreateScraperTargetAsync(string name, string url, string bucketId, string orgId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	name	the name of the new ScraperTarget
System.String	url	the url of the new ScraperTarget
System.String	bucketId	the id of the bucket that its use to writes
System.String	orgId	the id of the organization that owns new ScraperTarget
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<ScraperTargetResponse>	created ScraperTarget

DeleteLabelAsync(Label, ScraperTargetResponse, CancellationToken)

Removes a label from a ScraperTarget.

Declaration

Task DeleteLabelAsync(Label label, ScraperTargetResponse scraperTargetResponse, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
Label	label	the label of a ScraperTarget
ScraperTargetResponse	scraperTargetResponse	a ScraperTarget of a owner
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task	delete has been accepted

DeleteLabelAsync(String, String, CancellationToken)

Removes a label from a ScraperTarget.

Declaration

Task DeleteLabelAsync(string labelId, string scraperTargetId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	labelId	the ID of a label
System.String	scraperTargetId	the ID of a ScraperTarget
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task	delete has been accepted

DeleteMemberAsync(User, ScraperTargetResponse, CancellationToken)

Removes a member from a ScraperTarget.

Declaration

Task DeleteMemberAsync(User member, ScraperTargetResponse scraperTargetResponse, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
User	member	the member of a ScraperTarget
ScraperTargetResponse	scraperTargetResponse	the ScraperTarget of a member
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task	async task

DeleteMemberAsync(String, String, CancellationToken)

Removes a member from a ScraperTarget.

Declaration

Task DeleteMemberAsync(string memberId, string scraperTargetId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	memberId	the ID of a member
System.String	scraperTargetId	the ID of a ScraperTarget
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task	async task

DeleteOwnerAsync(User, ScraperTargetResponse, CancellationToken)

Removes a owner from a ScraperTarget.

Declaration

Task DeleteOwnerAsync(User owner, ScraperTargetResponse scraperTargetResponse, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
User	owner	the owner of a scraperTarget
ScraperTargetResponse	scraperTargetResponse	the ScraperTarget of a owner
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task	async task

DeleteOwnerAsync(String, String, CancellationToken)

Removes a owner from a ScraperTarget.

Declaration

Task DeleteOwnerAsync(string ownerId, string scraperTargetId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	ownerId	the ID of a owner
System.String	scraperTargetId	the ID of a ScraperTarget
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task	async task

DeleteScraperTargetAsync(ScraperTargetResponse, CancellationToken)

Delete a ScraperTarget.

Declaration

Task DeleteScraperTargetAsync(ScraperTargetResponse scraperTargetResponse, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
ScraperTargetResponse	scraperTargetResponse	ScraperTarget to delete
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task	scraper target deleted

DeleteScraperTargetAsync(String, CancellationToken)

Delete a ScraperTarget.

Declaration

Task DeleteScraperTargetAsync(string scraperTargetId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scraperTargetId	ID of ScraperTarget to delete
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task	scraper target deleted

FindScraperTargetByIdAsync(String, CancellationToken)

Retrieve a ScraperTarget.

Declaration

Task<ScraperTargetResponse> FindScraperTargetByIdAsync(string scraperTargetId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scraperTargetId	ID of ScraperTarget to get
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<ScraperTargetResponse>	ScraperTarget details

FindScraperTargetsAsync(CancellationToken)

Get all ScraperTargets.

Declaration

Task<List<ScraperTargetResponse>> FindScraperTargetsAsync(CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<List<ScraperTargetResponse>>	A list of ScraperTargets

FindScraperTargetsByOrgAsync(Organization, CancellationToken)

Get all ScraperTargets.

Declaration

Task<List<ScraperTargetResponse>> FindScraperTargetsByOrgAsync(Organization organization, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
Organization	organization	specifies the organization of the resource
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<List<ScraperTargetResponse>>	A list of ScraperTargets

FindScraperTargetsByOrgIdAsync(String, CancellationToken)

Get all ScraperTargets.

Declaration

Task<List<ScraperTargetResponse>> FindScraperTargetsByOrgIdAsync(string orgId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	orgId	specifies the organization ID of the resource
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<List<ScraperTargetResponse>>	A list of ScraperTargets

GetLabelsAsync(ScraperTargetResponse, CancellationToken)

List all labels of a ScraperTarget.

Declaration

Task<List<Label>> GetLabelsAsync(ScraperTargetResponse scraperTargetResponse, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
ScraperTargetResponse	scraperTargetResponse	a ScraperTarget of the labels
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<List<Label>>	the List all labels of a ScraperTarget

GetLabelsAsync(String, CancellationToken)

List all labels of a ScraperTarget.

Declaration

Task<List<Label>> GetLabelsAsync(string scraperTargetId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scraperTargetId	ID of a ScraperTarget to get labels
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<List<Label>>	the List all labels of a ScraperTarget

GetMembersAsync(ScraperTargetResponse, CancellationToken)

List all members of a ScraperTarget.

Declaration

Task<List<ResourceMember>> GetMembersAsync(ScraperTargetResponse scraperTargetResponse, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
ScraperTargetResponse	scraperTargetResponse	ScraperTarget of the members
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<List<ResourceMember>>	the List all members of a ScraperTarget

GetMembersAsync(String, CancellationToken)

List all members of a ScraperTarget.

Declaration

Task<List<ResourceMember>> GetMembersAsync(string scraperTargetId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scraperTargetId	ID of ScraperTarget to get members
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<List<ResourceMember>>	the List all members of a ScraperTarget

GetOwnersAsync(ScraperTargetResponse, CancellationToken)

List all owners of a ScraperTarget.

Declaration

Task<List<ResourceOwner>> GetOwnersAsync(ScraperTargetResponse scraperTargetResponse, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
ScraperTargetResponse	scraperTargetResponse	ScraperTarget of the owners
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<List<ResourceOwner>>	the List all owners of a ScraperTarget

GetOwnersAsync(String, CancellationToken)

List all owners of a ScraperTarget.

Declaration

Task<List<ResourceOwner>> GetOwnersAsync(string scraperTargetId, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scraperTargetId	ID of a ScraperTarget to get owners
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<List<ResourceOwner>>	the List all owners of a scraperTarget

UpdateScraperTargetAsync(ScraperTargetResponse, CancellationToken)

Update a ScraperTarget.

Declaration

Task<ScraperTargetResponse> UpdateScraperTargetAsync(ScraperTargetResponse scraperTargetResponse, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
ScraperTargetResponse	scraperTargetResponse	ScraperTarget update to apply
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<ScraperTargetResponse>	updated ScraperTarget

UpdateScraperTargetAsync(String, ScraperTargetRequest, CancellationToken)

Update a ScraperTarget.

Declaration

Task<ScraperTargetResponse> UpdateScraperTargetAsync(string scraperTargetId, ScraperTargetRequest scraperTargetRequest, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	scraperTargetId	id of the scraper target (required)
ScraperTargetRequest	scraperTargetRequest	ScraperTargetRequest update to apply
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
Task<ScraperTargetResponse>	updated ScraperTarget