Show / Hide Table of Contents

Class ApmSyntheticClient

Service client instance for ApmSynthetic.

Inheritance
object
ClientBase
RegionalClientBase
ApmSyntheticClient
Implements
IDisposable
Inherited Members
RegionalClientBase.logger
RegionalClientBase.SetRegion(Region)
RegionalClientBase.SetRegion(string)
RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)
RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)
RegionalClientBase.parseEndpointForParameters(string)
ClientBase.restClient
ClientBase.service
ClientBase.userAgent
ClientBase.Dispose()
ClientBase.Dispose(bool)
ClientBase.SetEndpoint(string)
ClientBase.GetEndpoint()
ClientBase.GetUserAgent()
ClientBase.SetRealmSpecificEndpointTemplate(string)
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.ApmsyntheticsService
Assembly: OCI.DotNetSDK.Apmsynthetics.dll
Syntax
public class ApmSyntheticClient : RegionalClientBase, IDisposable

Constructors

ApmSyntheticClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)

Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.

Declaration
public ApmSyntheticClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type Name Description
IBasicAuthenticationDetailsProvider authenticationDetailsProvider

The authentication details provider. Required.

ClientConfiguration clientConfiguration

The client configuration that contains settings to adjust REST client behaviors. Optional.

string endpoint

The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional.

Properties

Paginators

Declaration
public ApmSyntheticPaginators Paginators { get; }
Property Value
Type Description
ApmSyntheticPaginators

Methods

AggregateNetworkData(AggregateNetworkDataRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets aggregated network data for given executions.

Declaration
public Task<AggregateNetworkDataResponse> AggregateNetworkData(AggregateNetworkDataRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
AggregateNetworkDataRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<AggregateNetworkDataResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use AggregateNetworkData API.

CreateDedicatedVantagePoint(CreateDedicatedVantagePointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Registers a new dedicated vantage point.

Declaration
public Task<CreateDedicatedVantagePointResponse> CreateDedicatedVantagePoint(CreateDedicatedVantagePointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateDedicatedVantagePointRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<CreateDedicatedVantagePointResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateDedicatedVantagePoint API.

CreateMonitor(CreateMonitorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new monitor.

Declaration
public Task<CreateMonitorResponse> CreateMonitor(CreateMonitorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateMonitorRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<CreateMonitorResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateMonitor API.

CreateOnPremiseVantagePoint(CreateOnPremiseVantagePointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Registers a new On-premise vantage point.

Declaration
public Task<CreateOnPremiseVantagePointResponse> CreateOnPremiseVantagePoint(CreateOnPremiseVantagePointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateOnPremiseVantagePointRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<CreateOnPremiseVantagePointResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateOnPremiseVantagePoint API.

CreateScript(CreateScriptRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new script.

Declaration
public Task<CreateScriptResponse> CreateScript(CreateScriptRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateScriptRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<CreateScriptResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateScript API.

CreateWorker(CreateWorkerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Registers a new worker.

Declaration
public Task<CreateWorkerResponse> CreateWorker(CreateWorkerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
CreateWorkerRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<CreateWorkerResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateWorker API.

DeleteDedicatedVantagePoint(DeleteDedicatedVantagePointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deregisters the specified dedicated vantage point.

Declaration
public Task<DeleteDedicatedVantagePointResponse> DeleteDedicatedVantagePoint(DeleteDedicatedVantagePointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteDedicatedVantagePointRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<DeleteDedicatedVantagePointResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteDedicatedVantagePoint API.

DeleteMonitor(DeleteMonitorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified monitor.

Declaration
public Task<DeleteMonitorResponse> DeleteMonitor(DeleteMonitorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteMonitorRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<DeleteMonitorResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteMonitor API.

DeleteOnPremiseVantagePoint(DeleteOnPremiseVantagePointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deregisters the specified On-premise vantage point.

Declaration
public Task<DeleteOnPremiseVantagePointResponse> DeleteOnPremiseVantagePoint(DeleteOnPremiseVantagePointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteOnPremiseVantagePointRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<DeleteOnPremiseVantagePointResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteOnPremiseVantagePoint API.

DeleteScript(DeleteScriptRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified script.

Declaration
public Task<DeleteScriptResponse> DeleteScript(DeleteScriptRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteScriptRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<DeleteScriptResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteScript API.

DeleteWorker(DeleteWorkerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deregisters the specified worker.

Declaration
public Task<DeleteWorkerResponse> DeleteWorker(DeleteWorkerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
DeleteWorkerRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<DeleteWorkerResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteWorker API.

GetDedicatedVantagePoint(GetDedicatedVantagePointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of the dedicated vantage point identified by the OCID.

Declaration
public Task<GetDedicatedVantagePointResponse> GetDedicatedVantagePoint(GetDedicatedVantagePointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetDedicatedVantagePointRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetDedicatedVantagePointResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetDedicatedVantagePoint API.

GetMonitor(GetMonitorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the configuration of the monitor identified by the OCID.

Declaration
public Task<GetMonitorResponse> GetMonitor(GetMonitorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetMonitorRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetMonitorResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetMonitor API.

GetMonitorResult(GetMonitorResultRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the results for a specific execution of a monitor identified by OCID. The results are in a HAR file, Screenshot, Console Log, Network details, Diagnostics or Script Content.

Declaration
public Task<GetMonitorResultResponse> GetMonitorResult(GetMonitorResultRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetMonitorResultRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetMonitorResultResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetMonitorResult API.

GetOnPremiseVantagePoint(GetOnPremiseVantagePointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of the On-premise vantage point identified by the OCID.

Declaration
public Task<GetOnPremiseVantagePointResponse> GetOnPremiseVantagePoint(GetOnPremiseVantagePointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetOnPremiseVantagePointRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetOnPremiseVantagePointResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetOnPremiseVantagePoint API.

GetScript(GetScriptRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the configuration of the script identified by the OCID.

Declaration
public Task<GetScriptResponse> GetScript(GetScriptRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetScriptRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetScriptResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetScript API.

GetWorker(GetWorkerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of the worker identified by the OCID.

Declaration
public Task<GetWorkerResponse> GetWorker(GetWorkerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
GetWorkerRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<GetWorkerResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetWorker API.

ListDedicatedVantagePoints(ListDedicatedVantagePointsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of dedicated vantage points.

Declaration
public Task<ListDedicatedVantagePointsResponse> ListDedicatedVantagePoints(ListDedicatedVantagePointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListDedicatedVantagePointsRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListDedicatedVantagePointsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListDedicatedVantagePoints API.

ListMonitors(ListMonitorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of monitors.

Declaration
public Task<ListMonitorsResponse> ListMonitors(ListMonitorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListMonitorsRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListMonitorsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListMonitors API.

ListOnPremiseVantagePoints(ListOnPremiseVantagePointsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of On-premise vantage points.

Declaration
public Task<ListOnPremiseVantagePointsResponse> ListOnPremiseVantagePoints(ListOnPremiseVantagePointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListOnPremiseVantagePointsRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListOnPremiseVantagePointsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListOnPremiseVantagePoints API.

ListPublicVantagePoints(ListPublicVantagePointsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of public vantage points.

Declaration
public Task<ListPublicVantagePointsResponse> ListPublicVantagePoints(ListPublicVantagePointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListPublicVantagePointsRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListPublicVantagePointsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListPublicVantagePoints API.

ListScripts(ListScriptsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of scripts.

Declaration
public Task<ListScriptsResponse> ListScripts(ListScriptsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListScriptsRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListScriptsResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListScripts API.

ListWorkers(ListWorkersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of workers.

Declaration
public Task<ListWorkersResponse> ListWorkers(ListWorkersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
ListWorkersRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<ListWorkersResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListWorkers API.

UpdateDedicatedVantagePoint(UpdateDedicatedVantagePointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the dedicated vantage point.

Declaration
public Task<UpdateDedicatedVantagePointResponse> UpdateDedicatedVantagePoint(UpdateDedicatedVantagePointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateDedicatedVantagePointRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<UpdateDedicatedVantagePointResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateDedicatedVantagePoint API.

UpdateMonitor(UpdateMonitorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the monitor.

Declaration
public Task<UpdateMonitorResponse> UpdateMonitor(UpdateMonitorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateMonitorRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<UpdateMonitorResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateMonitor API.

UpdateOnPremiseVantagePoint(UpdateOnPremiseVantagePointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the On-premise vantage point.

Declaration
public Task<UpdateOnPremiseVantagePointResponse> UpdateOnPremiseVantagePoint(UpdateOnPremiseVantagePointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateOnPremiseVantagePointRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<UpdateOnPremiseVantagePointResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateOnPremiseVantagePoint API.

UpdateScript(UpdateScriptRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the script.

Declaration
public Task<UpdateScriptResponse> UpdateScript(UpdateScriptRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateScriptRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<UpdateScriptResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateScript API.

UpdateWorker(UpdateWorkerRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the worker.

Declaration
public Task<UpdateWorkerResponse> UpdateWorker(UpdateWorkerRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type Name Description
UpdateWorkerRequest request

The request object containing the details to send. Required.

RetryConfiguration retryConfiguration

The retry configuration that will be used by to send this request. Optional.

CancellationToken cancellationToken

The cancellation token to cancel this operation. Optional.

HttpCompletionOption completionOption

The completion option for this operation. Optional.

Returns
Type Description
Task<UpdateWorkerResponse>

A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateWorker API.

Implements

IDisposable
In this article
Back to top