com.oracle.bmc.vnmonitoring

Interface VnMonitoringAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

VnMonitoringAsyncClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public interface VnMonitoringAsync
extends AutoCloseable

Use the Network Monitoring API to troubleshoot routing and security issues for resources such as virtual cloud networks (VCNs) and compute instances. For more information, see the console documentation for the Network Path Analyzer tool.

Method Summary

Modifier and Type	Method and Description
Future<ChangePathAnalyzerTestCompartmentResponse>	changePathAnalyzerTestCompartment(ChangePathAnalyzerTestCompartmentRequest request, AsyncHandler<ChangePathAnalyzerTestCompartmentRequest,ChangePathAnalyzerTestCompartmentResponse> handler) Moves a PathAnalyzerTest resource from one compartment to another based on the identifier.
Future<CreatePathAnalyzerTestResponse>	createPathAnalyzerTest(CreatePathAnalyzerTestRequest request, AsyncHandler<CreatePathAnalyzerTestRequest,CreatePathAnalyzerTestResponse> handler) Creates a new PathAnalyzerTest resource.
Future<DeletePathAnalyzerTestResponse>	deletePathAnalyzerTest(DeletePathAnalyzerTestRequest request, AsyncHandler<DeletePathAnalyzerTestRequest,DeletePathAnalyzerTestResponse> handler) Deletes a PathAnalyzerTest resource using its identifier.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetPathAnalysisResponse>	getPathAnalysis(GetPathAnalysisRequest request, AsyncHandler<GetPathAnalysisRequest,GetPathAnalysisResponse> handler) Use this method to initiate a Network Path Analyzer analysis.
Future<GetPathAnalyzerTestResponse>	getPathAnalyzerTest(GetPathAnalyzerTestRequest request, AsyncHandler<GetPathAnalyzerTestRequest,GetPathAnalyzerTestResponse> handler) Gets a PathAnalyzerTest using its identifier.
Future<GetWorkRequestResponse>	getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler) Gets the details of a work request.
Future<ListPathAnalyzerTestsResponse>	listPathAnalyzerTests(ListPathAnalyzerTestsRequest request, AsyncHandler<ListPathAnalyzerTestsRequest,ListPathAnalyzerTestsResponse> handler) Returns a list of all PathAnalyzerTests in a compartment.
Future<ListWorkRequestErrorsResponse>	listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler) Returns a (paginated) list of errors for the work request with the given ID.
Future<ListWorkRequestLogsResponse>	listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler) Returns a (paginated) list of logs for the work request with the given ID.
Future<ListWorkRequestResultsResponse>	listWorkRequestResults(ListWorkRequestResultsRequest request, AsyncHandler<ListWorkRequestResultsRequest,ListWorkRequestResultsResponse> handler) Returns a (paginated) list of results for a successful work request.
Future<ListWorkRequestsResponse>	listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler) Lists the work requests in a compartment.
void	refreshClient() Rebuilds the client from scratch.
void	setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
Future<UpdatePathAnalyzerTestResponse>	updatePathAnalyzerTest(UpdatePathAnalyzerTestRequest request, AsyncHandler<UpdatePathAnalyzerTestRequest,UpdatePathAnalyzerTestResponse> handler) Updates a PathAnalyzerTest using its identifier.
void	useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled) Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

refreshClient

void refreshClient()

Rebuilds the client from scratch. Useful to refresh certificates.

setEndpoint

void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:

endpoint - The endpoint of the serice.

getEndpoint

String getEndpoint()

Gets the set endpoint for REST call (ex, https://www.example.com)

setRegion

void setRegion(Region region)

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.

Parameters:

region - The region of the service.

setRegion

void setRegion(String regionId)

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Parameters:

regionId - The public region ID.

useRealmSpecificEndpointTemplate

void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)

Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

Parameters:

realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

changePathAnalyzerTestCompartment

Future<ChangePathAnalyzerTestCompartmentResponse> changePathAnalyzerTestCompartment(ChangePathAnalyzerTestCompartmentRequest request,
                                                                                    AsyncHandler<ChangePathAnalyzerTestCompartmentRequest,ChangePathAnalyzerTestCompartmentResponse> handler)

Moves a PathAnalyzerTest resource from one compartment to another based on the identifier.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createPathAnalyzerTest

Future<CreatePathAnalyzerTestResponse> createPathAnalyzerTest(CreatePathAnalyzerTestRequest request,
                                                              AsyncHandler<CreatePathAnalyzerTestRequest,CreatePathAnalyzerTestResponse> handler)

Creates a new PathAnalyzerTest resource.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deletePathAnalyzerTest

Future<DeletePathAnalyzerTestResponse> deletePathAnalyzerTest(DeletePathAnalyzerTestRequest request,
                                                              AsyncHandler<DeletePathAnalyzerTestRequest,DeletePathAnalyzerTestResponse> handler)

Deletes a PathAnalyzerTest resource using its identifier.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getPathAnalysis

Future<GetPathAnalysisResponse> getPathAnalysis(GetPathAnalysisRequest request,
                                                AsyncHandler<GetPathAnalysisRequest,GetPathAnalysisResponse> handler)

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.

If the work request status is successful, use listWorkRequestResults with the work request ID to ask for the successful analysis results. If the work request status is failed, use 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.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getPathAnalyzerTest

Future<GetPathAnalyzerTestResponse> getPathAnalyzerTest(GetPathAnalyzerTestRequest request,
                                                        AsyncHandler<GetPathAnalyzerTestRequest,GetPathAnalyzerTestResponse> handler)

Gets a PathAnalyzerTest using its identifier.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getWorkRequest

Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request,
                                              AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)

Gets the details of a work request.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listPathAnalyzerTests

Future<ListPathAnalyzerTestsResponse> listPathAnalyzerTests(ListPathAnalyzerTestsRequest request,
                                                            AsyncHandler<ListPathAnalyzerTestsRequest,ListPathAnalyzerTestsResponse> handler)

Returns a list of all PathAnalyzerTests in a compartment.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listWorkRequestErrors

Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request,
                                                            AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)

Returns a (paginated) list of errors for the work request with the given ID. This information is used to build the final report output.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listWorkRequestLogs

Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request,
                                                        AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)

Returns a (paginated) list of logs for the work request with the given ID.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listWorkRequestResults

Future<ListWorkRequestResultsResponse> listWorkRequestResults(ListWorkRequestResultsRequest request,
                                                              AsyncHandler<ListWorkRequestResultsRequest,ListWorkRequestResultsResponse> handler)

Returns a (paginated) list of results for a successful work request. This information is used to build the final report output.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listWorkRequests

Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request,
                                                  AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)

Lists the work requests in a compartment.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updatePathAnalyzerTest

Future<UpdatePathAnalyzerTestResponse> updatePathAnalyzerTest(UpdatePathAnalyzerTestRequest request,
                                                              AsyncHandler<UpdatePathAnalyzerTestRequest,UpdatePathAnalyzerTestResponse> handler)

Updates a PathAnalyzerTest using its identifier.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.