Class VnMonitoringClient
Service client instance for VnMonitoring.
Implements
Inherited Members
Namespace: Oci.VnmonitoringService
Assembly: OCI.DotNetSDK.Vnmonitoring.dll
Syntax
public class VnMonitoringClient : RegionalClientBase, IDisposable
Constructors
VnMonitoringClient(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 VnMonitoringClient(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 VnMonitoringPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
VnMonitoringPaginators |
Waiters
Declaration
public VnMonitoringWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
VnMonitoringWaiters |
Methods
ChangePathAnalyzerTestCompartment(ChangePathAnalyzerTestCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a PathAnalyzerTest
resource from one compartment to another based on the identifier.
Declaration
public Task<ChangePathAnalyzerTestCompartmentResponse> ChangePathAnalyzerTestCompartment(ChangePathAnalyzerTestCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangePathAnalyzerTestCompartmentRequest | 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<ChangePathAnalyzerTestCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangePathAnalyzerTestCompartment API.
CreatePathAnalyzerTest(CreatePathAnalyzerTestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new PathAnalyzerTest
resource.
Declaration
public Task<CreatePathAnalyzerTestResponse> CreatePathAnalyzerTest(CreatePathAnalyzerTestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreatePathAnalyzerTestRequest | 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<CreatePathAnalyzerTestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreatePathAnalyzerTest API.
DeletePathAnalyzerTest(DeletePathAnalyzerTestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a PathAnalyzerTest
resource using its identifier.
Declaration
public Task<DeletePathAnalyzerTestResponse> DeletePathAnalyzerTest(DeletePathAnalyzerTestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeletePathAnalyzerTestRequest | 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<DeletePathAnalyzerTestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeletePathAnalyzerTest API.
GetPathAnalysis(GetPathAnalysisRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Use this method to initiate a Network Path Analyzer analysis. This method returns an opc-work-request-id, and you can poll the status of the work request until it either fails or succeeds. <br/> If the work request status is successful, use {@link #listWorkRequestResults(ListWorkRequestResultsRequest) listWorkRequestResults} with the work request ID to ask for the successful analysis results. If the work request status is failed, use {@link #listWorkRequestErrors(ListWorkRequestErrorsRequest) listWorkRequestErrors} with the work request ID to ask for the analysis failure information. The information returned from either of these methods can be used to build a final report.
Declaration
public Task<GetPathAnalysisResponse> GetPathAnalysis(GetPathAnalysisRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetPathAnalysisRequest | 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<GetPathAnalysisResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetPathAnalysis API.
GetPathAnalyzerTest(GetPathAnalyzerTestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a PathAnalyzerTest
using its identifier.
Declaration
public Task<GetPathAnalyzerTestResponse> GetPathAnalyzerTest(GetPathAnalyzerTestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetPathAnalyzerTestRequest | 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<GetPathAnalyzerTestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetPathAnalyzerTest API.
GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the details of a work request.
Declaration
public Task<GetWorkRequestResponse> GetWorkRequest(GetWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetWorkRequestRequest | 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<GetWorkRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetWorkRequest API.
ListPathAnalyzerTests(ListPathAnalyzerTestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a list of all PathAnalyzerTests
in a compartment.
Declaration
public Task<ListPathAnalyzerTestsResponse> ListPathAnalyzerTests(ListPathAnalyzerTestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListPathAnalyzerTestsRequest | 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<ListPathAnalyzerTestsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListPathAnalyzerTests API.
ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a (paginated) list of errors for the work request with the given ID. This information is used to build the final report output.
Declaration
public Task<ListWorkRequestErrorsResponse> ListWorkRequestErrors(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestErrorsRequest | 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<ListWorkRequestErrorsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequestErrors API.
ListWorkRequestLogs(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a (paginated) list of logs for the work request with the given ID.
Declaration
public Task<ListWorkRequestLogsResponse> ListWorkRequestLogs(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestLogsRequest | 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<ListWorkRequestLogsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequestLogs API.
ListWorkRequestResults(ListWorkRequestResultsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a (paginated) list of results for a successful work request. This information is used to build the final report output.
Declaration
public Task<ListWorkRequestResultsResponse> ListWorkRequestResults(ListWorkRequestResultsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestResultsRequest | 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<ListWorkRequestResultsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequestResults API.
ListWorkRequests(ListWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the work requests in a compartment.
Declaration
public Task<ListWorkRequestsResponse> ListWorkRequests(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestsRequest | 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<ListWorkRequestsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequests API.
UpdatePathAnalyzerTest(UpdatePathAnalyzerTestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a PathAnalyzerTest
using its identifier.
Declaration
public Task<UpdatePathAnalyzerTestResponse> UpdatePathAnalyzerTest(UpdatePathAnalyzerTestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdatePathAnalyzerTestRequest | 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<UpdatePathAnalyzerTestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdatePathAnalyzerTest API.