com.oracle.bmc.apmsynthetics

Class ApmSyntheticClient

java.lang.Object

com.oracle.bmc.apmsynthetics.ApmSyntheticClient

All Implemented Interfaces:

ApmSynthetic, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200630")
public class ApmSyntheticClient
extends Object
implements ApmSynthetic

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static Service	SERVICE Service instance for ApmSynthetic.

Constructor Summary

Constructors

Modifier	Constructor and Description
	ApmSyntheticClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Creates a new service instance using the given authentication provider and client configuration.
	ApmSyntheticClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Creates a new service instance using the given authentication provider and client configuration.
	ApmSyntheticClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Creates a new service instance using the given authentication provider and client configuration.
	ApmSyntheticClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Creates a new service instance using the given authentication provider and client configuration.
protected	ApmSyntheticClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, RestClientFactoryBuilder restClientFactoryBuilder) Creates a new service instance using the given authentication provider and client configuration.
	ApmSyntheticClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Creates a new service instance using the given authentication provider.
	ApmSyntheticClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Creates a new service instance using the given authentication provider and client configuration.
	ApmSyntheticClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Creates a new service instance using the given authentication provider and client configuration.

Method Summary

Modifier and Type	Method and Description
AggregateNetworkDataResponse	aggregateNetworkData(AggregateNetworkDataRequest request) Gets aggregated network data for given executions.
static ApmSyntheticClient.Builder	builder() Create a builder for this client.
void	close()
CreateDedicatedVantagePointResponse	createDedicatedVantagePoint(CreateDedicatedVantagePointRequest request) Registers a new dedicated vantage point.
CreateMonitorResponse	createMonitor(CreateMonitorRequest request) Creates a new monitor.
CreateScriptResponse	createScript(CreateScriptRequest request) Creates a new script.
DeleteDedicatedVantagePointResponse	deleteDedicatedVantagePoint(DeleteDedicatedVantagePointRequest request) Deregisters the specified dedicated vantage point.
DeleteMonitorResponse	deleteMonitor(DeleteMonitorRequest request) Deletes the specified monitor.
DeleteScriptResponse	deleteScript(DeleteScriptRequest request) Deletes the specified script.
GetDedicatedVantagePointResponse	getDedicatedVantagePoint(GetDedicatedVantagePointRequest request) Gets the details of the dedicated vantage point identified by the OCID.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
GetMonitorResponse	getMonitor(GetMonitorRequest request) Gets the configuration of the monitor identified by the OCID.
GetMonitorResultResponse	getMonitorResult(GetMonitorResultRequest request) Gets the results for a specific execution of a monitor identified by OCID.
ApmSyntheticPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetScriptResponse	getScript(GetScriptRequest request) Gets the configuration of the script identified by the OCID.
ListDedicatedVantagePointsResponse	listDedicatedVantagePoints(ListDedicatedVantagePointsRequest request) Returns a list of dedicated vantage points.
ListMonitorsResponse	listMonitors(ListMonitorsRequest request) Returns a list of monitors.
ListPublicVantagePointsResponse	listPublicVantagePoints(ListPublicVantagePointsRequest request) Returns a list of public vantage points.
ListScriptsResponse	listScripts(ListScriptsRequest request) Returns a list of scripts.
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’).
UpdateDedicatedVantagePointResponse	updateDedicatedVantagePoint(UpdateDedicatedVantagePointRequest request) Updates the dedicated vantage point.
UpdateMonitorResponse	updateMonitor(UpdateMonitorRequest request) Updates the monitor.
UpdateScriptResponse	updateScript(UpdateScriptRequest request) Updates the script.

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE

public static final Service SERVICE

Service instance for ApmSynthetic.

Constructor Detail

ApmSyntheticClient

public ApmSyntheticClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Creates a new service instance using the given authentication provider.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

ApmSyntheticClient

public ApmSyntheticClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration)

Creates a new service instance using the given authentication provider and client configuration.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

ApmSyntheticClient

public ApmSyntheticClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

ApmSyntheticClient

public ApmSyntheticClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration,
                          ClientConfigurator clientConfigurator,
                          RequestSignerFactory defaultRequestSignerFactory)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

ApmSyntheticClient

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

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

ApmSyntheticClient

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

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

ApmSyntheticClient

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

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

ApmSyntheticClient

protected ApmSyntheticClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration,
                             ClientConfigurator clientConfigurator,
                             RequestSignerFactory defaultRequestSignerFactory,
                             Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                             List<ClientConfigurator> additionalClientConfigurators,
                             String endpoint,
                             RestClientFactoryBuilder restClientFactoryBuilder)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed. Use the ApmSyntheticClient.Builder to get access to all these parameters.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

restClientFactoryBuilder - the builder for the RestClientFactory

Method Detail

builder

public static ApmSyntheticClient.Builder builder()

Create a builder for this client.

Returns:

builder

refreshClient

public void refreshClient()

Description copied from interface: ApmSynthetic

Rebuilds the client from scratch. Useful to refresh certificates.

Specified by:

refreshClient in interface ApmSynthetic

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: ApmSynthetic

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

Specified by:

setEndpoint in interface ApmSynthetic

Parameters:

endpoint - The endpoint of the service.

getEndpoint

public String getEndpoint()

Description copied from interface: ApmSynthetic

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

Specified by:

getEndpoint in interface ApmSynthetic

setRegion

public void setRegion(Region region)

Description copied from interface: ApmSynthetic

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 ApmSynthetic

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: ApmSynthetic

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 ApmSynthetic

Parameters:

regionId - The public region ID.

close

public void close()

Specified by:

close in interface AutoCloseable

aggregateNetworkData

public AggregateNetworkDataResponse aggregateNetworkData(AggregateNetworkDataRequest request)

Description copied from interface: ApmSynthetic

Gets aggregated network data for given executions.

Specified by:

aggregateNetworkData in interface ApmSynthetic

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createDedicatedVantagePoint

public CreateDedicatedVantagePointResponse createDedicatedVantagePoint(CreateDedicatedVantagePointRequest request)

Description copied from interface: ApmSynthetic

Registers a new dedicated vantage point.

Specified by:

createDedicatedVantagePoint in interface ApmSynthetic

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createMonitor

public CreateMonitorResponse createMonitor(CreateMonitorRequest request)

Description copied from interface: ApmSynthetic

Creates a new monitor.

Specified by:

createMonitor in interface ApmSynthetic

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createScript

public CreateScriptResponse createScript(CreateScriptRequest request)

Description copied from interface: ApmSynthetic

Creates a new script.

Specified by:

createScript in interface ApmSynthetic

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteDedicatedVantagePoint

public DeleteDedicatedVantagePointResponse deleteDedicatedVantagePoint(DeleteDedicatedVantagePointRequest request)

Description copied from interface: ApmSynthetic

Deregisters the specified dedicated vantage point.

Specified by:

deleteDedicatedVantagePoint in interface ApmSynthetic

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteMonitor

public DeleteMonitorResponse deleteMonitor(DeleteMonitorRequest request)

Description copied from interface: ApmSynthetic

Deletes the specified monitor.

Specified by:

deleteMonitor in interface ApmSynthetic

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteScript

public DeleteScriptResponse deleteScript(DeleteScriptRequest request)

Description copied from interface: ApmSynthetic

Deletes the specified script.

Specified by:

deleteScript in interface ApmSynthetic

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getDedicatedVantagePoint

public GetDedicatedVantagePointResponse getDedicatedVantagePoint(GetDedicatedVantagePointRequest request)

Description copied from interface: ApmSynthetic

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

Specified by:

getDedicatedVantagePoint in interface ApmSynthetic

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getMonitor

public GetMonitorResponse getMonitor(GetMonitorRequest request)

Description copied from interface: ApmSynthetic

Gets the configuration of the monitor identified by the OCID.

Specified by:

getMonitor in interface ApmSynthetic

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getMonitorResult

public GetMonitorResultResponse getMonitorResult(GetMonitorResultRequest request)

Description copied from interface: ApmSynthetic

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

Specified by:

getMonitorResult in interface ApmSynthetic

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getScript

public GetScriptResponse getScript(GetScriptRequest request)

Description copied from interface: ApmSynthetic

Gets the configuration of the script identified by the OCID.

Specified by:

getScript in interface ApmSynthetic

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listDedicatedVantagePoints

public ListDedicatedVantagePointsResponse listDedicatedVantagePoints(ListDedicatedVantagePointsRequest request)

Description copied from interface: ApmSynthetic

Returns a list of dedicated vantage points.

Specified by:

listDedicatedVantagePoints in interface ApmSynthetic

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listMonitors

public ListMonitorsResponse listMonitors(ListMonitorsRequest request)

Description copied from interface: ApmSynthetic

Returns a list of monitors.

Specified by:

listMonitors in interface ApmSynthetic

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listPublicVantagePoints

public ListPublicVantagePointsResponse listPublicVantagePoints(ListPublicVantagePointsRequest request)

Description copied from interface: ApmSynthetic

Returns a list of public vantage points.

Specified by:

listPublicVantagePoints in interface ApmSynthetic

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listScripts

public ListScriptsResponse listScripts(ListScriptsRequest request)

Description copied from interface: ApmSynthetic

Returns a list of scripts.

Specified by:

listScripts in interface ApmSynthetic

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateDedicatedVantagePoint

public UpdateDedicatedVantagePointResponse updateDedicatedVantagePoint(UpdateDedicatedVantagePointRequest request)

Description copied from interface: ApmSynthetic

Updates the dedicated vantage point.

Specified by:

updateDedicatedVantagePoint in interface ApmSynthetic

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateMonitor

public UpdateMonitorResponse updateMonitor(UpdateMonitorRequest request)

Description copied from interface: ApmSynthetic

Updates the monitor.

Specified by:

updateMonitor in interface ApmSynthetic

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateScript

public UpdateScriptResponse updateScript(UpdateScriptRequest request)

Description copied from interface: ApmSynthetic

Updates the script.

Specified by:

updateScript in interface ApmSynthetic

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getPaginators

public ApmSyntheticPaginators getPaginators()

Description copied from interface: ApmSynthetic

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 ApmSynthetic

Returns:

The service paginators.