VnMonitoring (Oracle Cloud Infrastructure Java SDK

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

VnMonitoringClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public interface VnMonitoring
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.

This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ChangePathAnalyzerTestCompartmentResponse`	`changePathAnalyzerTestCompartment(ChangePathAnalyzerTestCompartmentRequest request)` Moves a `PathAnalyzerTest` resource from one compartment to another based on the identifier.
`CreatePathAnalyzerTestResponse`	`createPathAnalyzerTest(CreatePathAnalyzerTestRequest request)` Creates a new `PathAnalyzerTest` resource.
`DeletePathAnalyzerTestResponse`	`deletePathAnalyzerTest(DeletePathAnalyzerTestRequest request)` Deletes a `PathAnalyzerTest` resource using its identifier.
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`VnMonitoringPaginators`	`getPaginators()` Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`GetPathAnalysisResponse`	`getPathAnalysis(GetPathAnalysisRequest request)` Use this method to initiate a Network Path Analyzer analysis.
`GetPathAnalyzerTestResponse`	`getPathAnalyzerTest(GetPathAnalyzerTestRequest request)` Gets a `PathAnalyzerTest` using its identifier.
`VnMonitoringWaiters`	`getWaiters()` Gets the pre-configured waiters available for resources for this service.
`GetWorkRequestResponse`	`getWorkRequest(GetWorkRequestRequest request)` Gets the details of a work request.
`ListPathAnalyzerTestsResponse`	`listPathAnalyzerTests(ListPathAnalyzerTestsRequest request)` Returns a list of all `PathAnalyzerTests` in a compartment.
`ListWorkRequestErrorsResponse`	`listWorkRequestErrors(ListWorkRequestErrorsRequest request)` Returns a (paginated) list of errors for the work request with the given ID.
`ListWorkRequestLogsResponse`	`listWorkRequestLogs(ListWorkRequestLogsRequest request)` Returns a (paginated) list of logs for the work request with the given ID.
`ListWorkRequestResultsResponse`	`listWorkRequestResults(ListWorkRequestResultsRequest request)` Returns a (paginated) list of results for a successful work request.
`ListWorkRequestsResponse`	`listWorkRequests(ListWorkRequestsRequest request)` 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’).
`UpdatePathAnalyzerTestResponse`	`updatePathAnalyzerTest(UpdatePathAnalyzerTestRequest request)` 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 service.
  - 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
```
ChangePathAnalyzerTestCompartmentResponse changePathAnalyzerTestCompartment(ChangePathAnalyzerTestCompartmentRequest request)
```
    Moves a PathAnalyzerTest resource from one compartment to another based on the identifier.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ChangePathAnalyzerTestCompartment API.
  - createPathAnalyzerTest
```
CreatePathAnalyzerTestResponse createPathAnalyzerTest(CreatePathAnalyzerTestRequest request)
```
    Creates a new PathAnalyzerTest resource.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use CreatePathAnalyzerTest API.
  - deletePathAnalyzerTest
```
DeletePathAnalyzerTestResponse deletePathAnalyzerTest(DeletePathAnalyzerTestRequest request)
```
    Deletes a PathAnalyzerTest resource using its identifier.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use DeletePathAnalyzerTest API.
  - getPathAnalysis
```
GetPathAnalysisResponse getPathAnalysis(GetPathAnalysisRequest request)
```
    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
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetPathAnalysis API.
  - getPathAnalyzerTest
```
GetPathAnalyzerTestResponse getPathAnalyzerTest(GetPathAnalyzerTestRequest request)
```
    Gets a PathAnalyzerTest using its identifier.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetPathAnalyzerTest API.
  - getWorkRequest
```
GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
```
    Gets the details of a work request.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use GetWorkRequest API.
  - listPathAnalyzerTests
```
ListPathAnalyzerTestsResponse listPathAnalyzerTests(ListPathAnalyzerTestsRequest request)
```
    Returns a list of all PathAnalyzerTests in a compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListPathAnalyzerTests API.
  - listWorkRequestErrors
```
ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
```
    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
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListWorkRequestErrors API.
  - listWorkRequestLogs
```
ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
```
    Returns a (paginated) list of logs for the work request with the given ID.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListWorkRequestLogs API.
  - listWorkRequestResults
```
ListWorkRequestResultsResponse listWorkRequestResults(ListWorkRequestResultsRequest request)
```
    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
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListWorkRequestResults API.
  - listWorkRequests
```
ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
```
    Lists the work requests in a compartment.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use ListWorkRequests API.
  - updatePathAnalyzerTest
```
UpdatePathAnalyzerTestResponse updatePathAnalyzerTest(UpdatePathAnalyzerTestRequest request)
```
    Updates a PathAnalyzerTest using its identifier.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click here to see how to use UpdatePathAnalyzerTest API.
  - getWaiters
```
VnMonitoringWaiters getWaiters()
```
    Gets the pre-configured waiters available for resources for this service.
    
    Returns:
    
    The service waiters.
  - getPaginators
```
VnMonitoringPaginators getPaginators()
```
    Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.
    
    Returns:
    
    The service paginators.

Interface VnMonitoring

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

changePathAnalyzerTestCompartment

createPathAnalyzerTest

deletePathAnalyzerTest

getPathAnalysis

getPathAnalyzerTest

getWorkRequest

listPathAnalyzerTests

listWorkRequestErrors

listWorkRequestLogs

listWorkRequestResults

listWorkRequests

updatePathAnalyzerTest

getWaiters

getPaginators