• InfluxDB.Client API
Show / Hide Table of Contents
  • InfluxDB.Client
    • AuthorizationsApi
    • BucketsApi
    • ChecksApi
    • DeleteApi
    • IAuthorizationsApi
    • IBucketsApi
    • IChecksApi
    • IDeleteApi
    • IDomainObjectMapper
    • IInfluxDBClient
    • IInvokableScriptsApi
    • ILabelsApi
    • InfluxDBClient
    • InfluxDBClientFactory
    • InfluxDBClientOptions
    • InfluxDBClientOptions.AuthenticationScheme
    • InfluxDBClientOptions.Builder
    • INotificationEndpointsApi
    • INotificationRulesApi
    • InvokableScriptsApi
    • IOrganizationsApi
    • IQueryApi
    • IQueryApiSync
    • IScraperTargetsApi
    • ISourcesApi
    • ITasksApi
    • ITelegrafsApi
    • IUsersApi
    • IWriteApi
    • IWriteApiAsync
    • LabelsApi
    • NotificationEndpointsApi
    • NotificationRulesApi
    • OrganizationsApi
    • QueryApi
    • QueryApiSync
    • ScraperTargetsApi
    • SourcesApi
    • TasksApi
    • TelegrafsApi
    • UsersApi
    • WriteApi
    • WriteApiAsync
    • WriteOptions
    • WriteOptions.Builder
  • InfluxDB.Client.Api.Domain
    • AddResourceMemberRequestBody
    • AnalyzeQueryResponse
    • AnalyzeQueryResponseErrors
    • ArrayExpression
    • ArrayExpression.ArrayExpressionElementsAdapter
    • ASTResponse
    • Authorization
    • AuthorizationLinks
    • AuthorizationPostRequest
    • Authorizations
    • AuthorizationUpdateRequest
    • AuthorizationUpdateRequest.StatusEnum
    • Axes
    • Axis
    • Axis.BaseEnum
    • AxisScale
    • BadStatement
    • BandViewProperties
    • BandViewProperties.HoverDimensionEnum
    • BandViewProperties.ShapeEnum
    • BandViewProperties.TypeEnum
    • BinaryExpression
    • BinaryExpression.BinaryExpressionLeftAdapter
    • BinaryExpression.BinaryExpressionRightAdapter
    • Block
    • Block.BlockBodyAdapter
    • BooleanLiteral
    • Bucket
    • Bucket.TypeEnum
    • BucketLinks
    • BucketMetadataManifest
    • BucketRetentionRules
    • BucketRetentionRules.TypeEnum
    • Buckets
    • BucketShardMapping
    • BuilderAggregateFunctionType
    • BuilderConfig
    • BuilderConfigAggregateWindow
    • BuilderFunctionsType
    • BuilderTagsType
    • BuiltinStatement
    • CallExpression
    • CallExpression.CallExpressionArgumentsAdapter
    • CallExpression.CallExpressionCalleeAdapter
    • Cell
    • CellLinks
    • CellUpdate
    • CellWithViewProperties
    • Check
    • CheckBase
    • CheckBase.LastRunStatusEnum
    • CheckBaseLinks
    • CheckDiscriminator
    • CheckPatch
    • CheckPatch.StatusEnum
    • Checks
    • CheckStatusLevel
    • CheckViewProperties
    • CheckViewProperties.ShapeEnum
    • CheckViewProperties.TypeEnum
    • ConditionalExpression
    • ConditionalExpression.ConditionalExpressionAlternateAdapter
    • ConditionalExpression.ConditionalExpressionConsequentAdapter
    • ConditionalExpression.ConditionalExpressionTestAdapter
    • Config
    • ConstantVariableProperties
    • ConstantVariableProperties.TypeEnum
    • CreateCell
    • CreateDashboardRequest
    • CustomCheck
    • CustomCheck.TypeEnum
    • Dashboard
    • DashboardColor
    • DashboardColor.TypeEnum
    • DashboardLinks
    • DashboardMeta
    • DashboardQuery
    • Dashboards
    • DashboardWithViewProperties
    • DateTimeLiteral
    • DBRP
    • DBRPCreate
    • DBRPGet
    • DBRPs
    • DBRPUpdate
    • DeadmanCheck
    • DeadmanCheck.TypeEnum
    • DecimalPlaces
    • DeletePredicateRequest
    • Dialect
    • Dialect.AnnotationsEnum
    • Dialect.DateTimeFormatEnum
    • DictExpression
    • DictItem
    • DictItem.DictItemKeyAdapter
    • DictItem.DictItemValAdapter
    • Duration
    • DurationLiteral
    • Error
    • Error.CodeEnum
    • Expression
    • ExpressionStatement
    • ExpressionStatement.ExpressionStatementExpressionAdapter
    • Field
    • Field.TypeEnum
    • File
    • File.FileBodyAdapter
    • FloatLiteral
    • FluxResponse
    • FluxSuggestion
    • FluxSuggestions
    • FunctionExpression
    • FunctionExpression.FunctionExpressionBodyAdapter
    • GaugeViewProperties
    • GaugeViewProperties.ShapeEnum
    • GaugeViewProperties.TypeEnum
    • GreaterThreshold
    • GreaterThreshold.TypeEnum
    • HealthCheck
    • HealthCheck.StatusEnum
    • HeatmapViewProperties
    • HeatmapViewProperties.ShapeEnum
    • HeatmapViewProperties.TypeEnum
    • HistogramViewProperties
    • HistogramViewProperties.PositionEnum
    • HistogramViewProperties.ShapeEnum
    • HistogramViewProperties.TypeEnum
    • HTTPNotificationEndpoint
    • HTTPNotificationEndpoint.AuthMethodEnum
    • HTTPNotificationEndpoint.MethodEnum
    • HTTPNotificationRule
    • HTTPNotificationRuleBase
    • HTTPNotificationRuleBase.TypeEnum
    • Identifier
    • ImportDeclaration
    • IndexExpression
    • IndexExpression.IndexExpressionArrayAdapter
    • IndexExpression.IndexExpressionIndexAdapter
    • IntegerLiteral
    • IsOnboarding
    • Label
    • LabelCreateRequest
    • LabelMapping
    • LabelResponse
    • LabelsResponse
    • LabelUpdate
    • LanguageRequest
    • LegacyAuthorizationPostRequest
    • LesserThreshold
    • LesserThreshold.TypeEnum
    • LinePlusSingleStatProperties
    • LinePlusSingleStatProperties.HoverDimensionEnum
    • LinePlusSingleStatProperties.PositionEnum
    • LinePlusSingleStatProperties.ShapeEnum
    • LinePlusSingleStatProperties.TypeEnum
    • LineProtocolError
    • LineProtocolError.CodeEnum
    • LineProtocolLengthError
    • LineProtocolLengthError.CodeEnum
    • Links
    • ListStacksResponse
    • LogEvent
    • LogicalExpression
    • LogicalExpression.LogicalExpressionLeftAdapter
    • LogicalExpression.LogicalExpressionRightAdapter
    • Logs
    • MapVariableProperties
    • MapVariableProperties.TypeEnum
    • MarkdownViewProperties
    • MarkdownViewProperties.ShapeEnum
    • MarkdownViewProperties.TypeEnum
    • MemberAssignment
    • MemberAssignment.MemberAssignmentInitAdapter
    • MemberExpression
    • MemberExpression.MemberExpressionObjectAdapter
    • MemberExpression.MemberExpressionPropertyAdapter
    • MetadataBackup
    • MosaicViewProperties
    • MosaicViewProperties.HoverDimensionEnum
    • MosaicViewProperties.ShapeEnum
    • MosaicViewProperties.TypeEnum
    • Node
    • NotificationEndpoint
    • NotificationEndpointBase
    • NotificationEndpointBase.StatusEnum
    • NotificationEndpointBaseLinks
    • NotificationEndpointDiscriminator
    • NotificationEndpoints
    • NotificationEndpointType
    • NotificationEndpointUpdate
    • NotificationEndpointUpdate.StatusEnum
    • NotificationRule
    • NotificationRuleBase
    • NotificationRuleBase.LastRunStatusEnum
    • NotificationRuleBaseLinks
    • NotificationRuleDiscriminator
    • NotificationRules
    • NotificationRuleUpdate
    • NotificationRuleUpdate.StatusEnum
    • ObjectExpression
    • OnboardingRequest
    • OnboardingResponse
    • OptionStatement
    • OptionStatement.OptionStatementAssignmentAdapter
    • Organization
    • Organization.StatusEnum
    • OrganizationLinks
    • Organizations
    • Package
    • PackageClause
    • PagerDutyNotificationEndpoint
    • PagerDutyNotificationRule
    • PagerDutyNotificationRuleBase
    • PagerDutyNotificationRuleBase.TypeEnum
    • ParenExpression
    • ParenExpression.ParenExpressionExpressionAdapter
    • PasswordResetBody
    • PatchBucketRequest
    • PatchDashboardRequest
    • PatchOrganizationRequest
    • PatchRetentionRule
    • PatchRetentionRule.TypeEnum
    • PatchStackRequest
    • PatchStackRequestAdditionalResources
    • Permission
    • Permission.ActionEnum
    • PermissionResource
    • PipeExpression
    • PipeExpression.PipeExpressionArgumentAdapter
    • PipeLiteral
    • PostBucketRequest
    • PostOrganizationRequest
    • PostRestoreKVResponse
    • PostStackRequest
    • PostUser
    • PostUser.StatusEnum
    • Property
    • Property.PropertyKeyAdapter
    • Property.PropertyValueAdapter
    • PropertyKey
    • Query
    • Query.TypeEnum
    • QueryEditMode
    • QueryVariableProperties
    • QueryVariableProperties.TypeEnum
    • QueryVariablePropertiesValues
    • RangeThreshold
    • RangeThreshold.TypeEnum
    • Ready
    • Ready.StatusEnum
    • RegexpLiteral
    • RemoteConnection
    • RemoteConnectionCreationRequest
    • RemoteConnections
    • RemoteConnectionUpdateRequest
    • RenamableField
    • Replication
    • ReplicationCreationRequest
    • Replications
    • ReplicationUpdateRequest
    • ResourceMember
    • ResourceMember.RoleEnum
    • ResourceMembers
    • ResourceOwner
    • ResourceOwner.RoleEnum
    • ResourceOwners
    • RestoredBucketMappings
    • RetentionPolicyManifest
    • ReturnStatement
    • ReturnStatement.ReturnStatementArgumentAdapter
    • Routes
    • RoutesExternal
    • RoutesQuery
    • RoutesSystem
    • RuleStatusLevel
    • Run
    • Run.StatusEnum
    • RunLinks
    • RunManually
    • Runs
    • ScatterViewProperties
    • ScatterViewProperties.ShapeEnum
    • ScatterViewProperties.TypeEnum
    • SchemaType
    • ScraperTargetRequest
    • ScraperTargetRequest.TypeEnum
    • ScraperTargetResponse
    • ScraperTargetResponseLinks
    • ScraperTargetResponses
    • Script
    • ScriptCreateRequest
    • ScriptInvocationParams
    • ScriptLanguage
    • Scripts
    • ScriptUpdateRequest
    • SecretKeys
    • SecretKeysResponse
    • SecretKeysResponseLinks
    • ShardGroupManifest
    • ShardManifest
    • ShardOwner
    • SimpleTableViewProperties
    • SimpleTableViewProperties.ShapeEnum
    • SimpleTableViewProperties.TypeEnum
    • SingleStatViewProperties
    • SingleStatViewProperties.ShapeEnum
    • SingleStatViewProperties.TypeEnum
    • SlackNotificationEndpoint
    • SlackNotificationRule
    • SlackNotificationRuleBase
    • SlackNotificationRuleBase.TypeEnum
    • SMTPNotificationRule
    • SMTPNotificationRuleBase
    • SMTPNotificationRuleBase.TypeEnum
    • Source
    • Source.LanguagesEnum
    • Source.TypeEnum
    • SourceLinks
    • Sources
    • Stack
    • StackAssociations
    • StackEvents
    • StackLinks
    • StackResources
    • Statement
    • StaticLegend
    • StatusRule
    • StringLiteral
    • SubscriptionManifest
    • TableViewProperties
    • TableViewProperties.ShapeEnum
    • TableViewProperties.TypeEnum
    • TableViewPropertiesTableOptions
    • TableViewPropertiesTableOptions.WrappingEnum
    • TagRule
    • TagRule.OperatorEnum
    • TaskCreateRequest
    • TaskLinks
    • Tasks
    • TaskStatusType
    • TaskType
    • TaskType.LastRunStatusEnum
    • TaskUpdateRequest
    • Telegraf
    • TelegrafLinks
    • TelegrafPlugin
    • TelegrafPlugin.TypeEnum
    • TelegrafPluginRequest
    • TelegrafPluginRequestPlugins
    • TelegrafPlugins
    • TelegrafRequest
    • TelegrafRequestMetadata
    • Telegrafs
    • TelegramNotificationEndpoint
    • TelegramNotificationRule
    • TelegramNotificationRuleBase
    • TelegramNotificationRuleBase.ParseModeEnum
    • TelegramNotificationRuleBase.TypeEnum
    • TemplateApply
    • TemplateApplyRemotes
    • TemplateApplyTemplate
    • TemplateChart
    • TemplateChart.TemplateChartPropertiesAdapter
    • TemplateExportByID
    • TemplateExportByIDOrgIDs
    • TemplateExportByIDResourceFilters
    • TemplateExportByIDResources
    • TemplateKind
    • TemplateSummary
    • TemplateSummaryDiff
    • TemplateSummaryDiffBuckets
    • TemplateSummaryDiffBucketsNewOld
    • TemplateSummaryDiffChecks
    • TemplateSummaryDiffChecks.TemplateSummary_diff_checksNewAdapter
    • TemplateSummaryDiffChecks.TemplateSummary_diff_checksOldAdapter
    • TemplateSummaryDiffDashboards
    • TemplateSummaryDiffDashboardsNewOld
    • TemplateSummaryDiffLabelMappings
    • TemplateSummaryDiffLabels
    • TemplateSummaryDiffLabelsNewOld
    • TemplateSummaryDiffNotificationEndpoints
    • TemplateSummaryDiffNotificationEndpoints.TemplateSummary_diff_notificationEndpointsNewAdapter
    • TemplateSummaryDiffNotificationEndpoints.TemplateSummary_diff_notificationEndpointsOldAdapter
    • TemplateSummaryDiffNotificationRules
    • TemplateSummaryDiffNotificationRulesNewOld
    • TemplateSummaryDiffTasks
    • TemplateSummaryDiffTasksNewOld
    • TemplateSummaryDiffTelegrafConfigs
    • TemplateSummaryDiffVariables
    • TemplateSummaryDiffVariablesNewOld
    • TemplateSummaryDiffVariablesNewOld.TemplateSummary_Diff_variables_new_oldArgsAdapter
    • TemplateSummaryErrors
    • TemplateSummaryLabel
    • TemplateSummaryLabelProperties
    • TemplateSummarySummary
    • TemplateSummarySummaryBuckets
    • TemplateSummarySummaryDashboards
    • TemplateSummarySummaryLabelMappings
    • TemplateSummarySummaryNotificationRules
    • TemplateSummarySummaryStatusRules
    • TemplateSummarySummaryTagRules
    • TemplateSummarySummaryTasks
    • TemplateSummarySummaryVariables
    • TemplateSummarySummaryVariables.TemplateSummary_summary_variablesArgumentsAdapter
    • TestStatement
    • Threshold
    • ThresholdBase
    • ThresholdCheck
    • ThresholdCheck.TypeEnum
    • ThresholdCheckTags
    • UnaryExpression
    • UnaryExpression.UnaryExpressionArgumentAdapter
    • UnsignedIntegerLiteral
    • User
    • User.StatusEnum
    • UserLinks
    • Users
    • UsersLinks
    • Variable
    • Variable.VariableArgumentsAdapter
    • VariableAssignment
    • VariableAssignment.VariableAssignmentInitAdapter
    • VariableLinks
    • VariableProperties
    • Variables
    • View
    • View.ViewPropertiesAdapter
    • ViewLinks
    • ViewProperties
    • Views
    • WritePrecision
    • XYGeom
    • XYViewProperties
    • XYViewProperties.HoverDimensionEnum
    • XYViewProperties.PositionEnum
    • XYViewProperties.ShapeEnum
    • XYViewProperties.TypeEnum
  • InfluxDB.Client.Api.Service
    • AuthorizationsService
    • BackupService
    • BucketsService
    • CellsService
    • ChecksService
    • ConfigService
    • DashboardsService
    • DBRPsService
    • DeleteService
    • HealthService
    • IAuthorizationsService
    • IBackupService
    • IBucketsService
    • ICellsService
    • IChecksService
    • IConfigService
    • IDashboardsService
    • IDBRPsService
    • IDeleteService
    • IHealthService
    • IInvokableScriptsService
    • ILabelsService
    • ILegacyAuthorizationsService
    • IMetricsService
    • INotificationEndpointsService
    • INotificationRulesService
    • InvokableScriptsService
    • IOrganizationsService
    • IPingService
    • IQueryService
    • IReadyService
    • IRemoteConnectionsService
    • IReplicationsService
    • IResourcesService
    • IRestoreService
    • IRoutesService
    • IRulesService
    • IScraperTargetsService
    • ISecretsService
    • ISetupService
    • ISigninService
    • ISignoutService
    • ISourcesService
    • ITasksService
    • ITelegrafPluginsService
    • ITelegrafsService
    • ITemplatesService
    • IUsersService
    • IVariablesService
    • IViewsService
    • IWriteService
    • LabelsService
    • LegacyAuthorizationsService
    • MetricsService
    • NotificationEndpointsService
    • NotificationRulesService
    • OrganizationsService
    • PingService
    • QueryService
    • ReadyService
    • RemoteConnectionsService
    • ReplicationsService
    • ResourcesService
    • RestoreService
    • RoutesService
    • RulesService
    • ScraperTargetsService
    • SecretsService
    • SetupService
    • SigninService
    • SignoutService
    • SourcesService
    • TasksService
    • TelegrafPluginsService
    • TelegrafsService
    • TemplatesService
    • UsersService
    • VariablesService
    • ViewsService
    • WriteService
  • InfluxDB.Client.Core
    • Arguments
    • Column
    • LogLevel
    • Measurement
  • InfluxDB.Client.Core.Exceptions
    • BadGatewayException
    • BadRequestException
    • ForbiddenException
    • HttpException
    • HttpNotImplementedException
    • InfluxException
    • InternalServerErrorException
    • MethodNotAllowedException
    • NotAcceptableException
    • NotFoundException
    • PaymentRequiredException
    • ProxyAuthenticationRequiredException
    • RequestEntityTooLargeException
    • RequestTimeoutException
    • ServiceUnavailableException
    • TooManyRequestsException
    • UnauthorizedException
    • UnprocessableEntityException
  • InfluxDB.Client.Core.Flux.Domain
    • FluxColumn
    • FluxRecord
    • FluxTable
  • InfluxDB.Client.Core.Flux.Exceptions
    • FluxCsvParserException
    • FluxQueryException
  • InfluxDB.Client.Core.Flux.Serialization
    • AnnotatedCsvParser
    • IAnnotatedCsvParser
  • InfluxDB.Client.Domain
    • FindOptions
  • InfluxDB.Client.Flux
    • FluxClient
    • FluxClientFactory
    • FluxConnectionOptions
    • FluxConnectionOptions.AuthenticationType
    • IFluxClient
  • InfluxDB.Client.Linq
    • DefaultMemberNameResolver
    • IMemberNameResolver
    • InfluxDBQueryable<T>
    • MemberType
    • QueryableExtensions
    • QueryableOptimizerSettings
  • InfluxDB.Client.Writes
    • AbstractWriteEvent
    • InfluxDBEventArgs
    • PointData
    • PointData.Builder
    • PointSettings
    • WriteErrorEvent
    • WriteRetriableErrorEvent
    • WriteRuntimeExceptionEvent
    • WriteSuccessEvent

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

In This Article
Back to top Generated by DocFX