Package com.oracle.bmc.vnmonitoring

Class VnMonitoringClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.vnmonitoring.VnMonitoringClient

All Implemented Interfaces:

VnMonitoring, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public class VnMonitoringClient
extends BaseSyncClient
implements VnMonitoring

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	VnMonitoringClient.Builder	Builder class for this client.

Field Summary

Fields

Modifier and Type	Field	Description
String	clientCommonLibraryVersion	Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient	Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE	Service instance for VnMonitoring.

Constructor Summary

Constructors

Constructor	Description
VnMonitoringClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)	Deprecated. Use the builder instead.
VnMonitoringClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)	Deprecated. Use the builder instead.
VnMonitoringClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
VnMonitoringClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)	Deprecated. Use the builder instead.
VnMonitoringClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)	Deprecated. Use the builder instead.
VnMonitoringClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)	Deprecated. Use the builder instead.
VnMonitoringClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)	Deprecated. Use the builder instead.
VnMonitoringClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)	Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method	Description
static VnMonitoringClient.Builder	builder()	Create a builder for this client.
ChangePathAnalyzerTestCompartmentResponse	changePathAnalyzerTestCompartment(ChangePathAnalyzerTestCompartmentRequest request)	Moves a PathAnalyzerTest resource from one compartment to another based on the identifier.
void	close()
CreatePathAnalyzerTestResponse	createPathAnalyzerTest(CreatePathAnalyzerTestRequest request)	Creates a new PathAnalyzerTest resource.
DeletePathAnalyzerTestResponse	deletePathAnalyzerTest(DeletePathAnalyzerTestRequest request)	Deletes a PathAnalyzerTest resource using its identifier.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
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	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient()	Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
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’).
void	updateBaseEndpoint(String endpoint)	This method should be used for parameterized endpoint templates only.
UpdatePathAnalyzerTestResponse	updatePathAnalyzerTest(UpdatePathAnalyzerTestRequest request)	Updates a PathAnalyzerTest using its identifier.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)	This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.vnmonitoring.VnMonitoring

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for VnMonitoring.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

VnMonitoringClient

@Deprecated
public VnMonitoringClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see VnMonitoringClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

VnMonitoringClient

@Deprecated
public VnMonitoringClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see VnMonitoringClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

VnMonitoringClient

@Deprecated
public VnMonitoringClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see VnMonitoringClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

VnMonitoringClient

@Deprecated
public VnMonitoringClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator,
                          RequestSignerFactory defaultRequestSignerFactory)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see VnMonitoringClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

VnMonitoringClient

@Deprecated
public VnMonitoringClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator,
                          RequestSignerFactory defaultRequestSignerFactory,
                          List<ClientConfigurator> additionalClientConfigurators)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see VnMonitoringClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

VnMonitoringClient

@Deprecated
public VnMonitoringClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator,
                          RequestSignerFactory defaultRequestSignerFactory,
                          List<ClientConfigurator> additionalClientConfigurators,
                          String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see VnMonitoringClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

VnMonitoringClient

@Deprecated
public VnMonitoringClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator,
                          RequestSignerFactory defaultRequestSignerFactory,
                          Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                          List<ClientConfigurator> additionalClientConfigurators,
                          String endpoint)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see VnMonitoringClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

VnMonitoringClient

@Deprecated
public VnMonitoringClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator,
                          RequestSignerFactory defaultRequestSignerFactory,
                          Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                          List<ClientConfigurator> additionalClientConfigurators,
                          String endpoint,
                          ExecutorService executorService)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see VnMonitoringClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

executorService - VnMonitoringClient.Builder.executorService

Method Detail

builder

public static VnMonitoringClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: VnMonitoring

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.

Specified by:

setRegion in interface VnMonitoring

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: VnMonitoring

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.

Specified by:

setRegion in interface VnMonitoring

Parameters:

regionId - The public region ID.

changePathAnalyzerTestCompartment

public ChangePathAnalyzerTestCompartmentResponse changePathAnalyzerTestCompartment(ChangePathAnalyzerTestCompartmentRequest request)

Description copied from interface: VnMonitoring

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

Specified by:

changePathAnalyzerTestCompartment in interface VnMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createPathAnalyzerTest

public CreatePathAnalyzerTestResponse createPathAnalyzerTest(CreatePathAnalyzerTestRequest request)

Description copied from interface: VnMonitoring

Creates a new PathAnalyzerTest resource.

Specified by:

createPathAnalyzerTest in interface VnMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deletePathAnalyzerTest

public DeletePathAnalyzerTestResponse deletePathAnalyzerTest(DeletePathAnalyzerTestRequest request)

Description copied from interface: VnMonitoring

Deletes a PathAnalyzerTest resource using its identifier.

Specified by:

deletePathAnalyzerTest in interface VnMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getPathAnalysis

public GetPathAnalysisResponse getPathAnalysis(GetPathAnalysisRequest request)

Description copied from interface: VnMonitoring

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.

Specified by:

getPathAnalysis in interface VnMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getPathAnalyzerTest

public GetPathAnalyzerTestResponse getPathAnalyzerTest(GetPathAnalyzerTestRequest request)

Description copied from interface: VnMonitoring

Gets a PathAnalyzerTest using its identifier.

Specified by:

getPathAnalyzerTest in interface VnMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWorkRequest

public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

Description copied from interface: VnMonitoring

Gets the details of a work request.

Specified by:

getWorkRequest in interface VnMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listPathAnalyzerTests

public ListPathAnalyzerTestsResponse listPathAnalyzerTests(ListPathAnalyzerTestsRequest request)

Description copied from interface: VnMonitoring

Returns a list of all PathAnalyzerTests in a compartment.

Specified by:

listPathAnalyzerTests in interface VnMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestErrors

public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

Description copied from interface: VnMonitoring

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

This information is used to build the final report output.

Specified by:

listWorkRequestErrors in interface VnMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestLogs

public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)

Description copied from interface: VnMonitoring

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

Specified by:

listWorkRequestLogs in interface VnMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestResults

public ListWorkRequestResultsResponse listWorkRequestResults(ListWorkRequestResultsRequest request)

Description copied from interface: VnMonitoring

Returns a (paginated) list of results for a successful work request.

This information is used to build the final report output.

Specified by:

listWorkRequestResults in interface VnMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequests

public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)

Description copied from interface: VnMonitoring

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface VnMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updatePathAnalyzerTest

public UpdatePathAnalyzerTestResponse updatePathAnalyzerTest(UpdatePathAnalyzerTestRequest request)

Description copied from interface: VnMonitoring

Updates a PathAnalyzerTest using its identifier.

Specified by:

updatePathAnalyzerTest in interface VnMonitoring

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public VnMonitoringWaiters getWaiters()

Description copied from interface: VnMonitoring

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface VnMonitoring

Returns:

The service waiters.

getPaginators

public VnMonitoringPaginators getPaginators()

Description copied from interface: VnMonitoring

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.

Specified by:

getPaginators in interface VnMonitoring

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template.

The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint.

The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only.

This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient.

This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()