Package com.oracle.bmc.apmsynthetics

Class ApmSyntheticClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.apmsynthetics.ApmSyntheticClient

All Implemented Interfaces:

ApmSynthetic, AutoCloseable

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ApmSyntheticClient.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 ApmSynthetic.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	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.
CreateOnPremiseVantagePointResponse	createOnPremiseVantagePoint(CreateOnPremiseVantagePointRequest request)	Registers a new On-premise vantage point.
CreateScriptResponse	createScript(CreateScriptRequest request)	Creates a new script.
CreateWorkerResponse	createWorker(CreateWorkerRequest request)	Registers a new worker.
DeleteDedicatedVantagePointResponse	deleteDedicatedVantagePoint(DeleteDedicatedVantagePointRequest request)	Deregisters the specified dedicated vantage point.
DeleteMonitorResponse	deleteMonitor(DeleteMonitorRequest request)	Deletes the specified monitor.
DeleteOnPremiseVantagePointResponse	deleteOnPremiseVantagePoint(DeleteOnPremiseVantagePointRequest request)	Deregisters the specified On-premise vantage point.
DeleteScriptResponse	deleteScript(DeleteScriptRequest request)	Deletes the specified script.
DeleteWorkerResponse	deleteWorker(DeleteWorkerRequest request)	Deregisters the specified worker.
String	getClientCommonLibraryVersion()
GetDedicatedVantagePointResponse	getDedicatedVantagePoint(GetDedicatedVantagePointRequest request)	Gets the details of the dedicated vantage point identified by the OCID.
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
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.
GetOnPremiseVantagePointResponse	getOnPremiseVantagePoint(GetOnPremiseVantagePointRequest request)	Gets the details of the On-premise vantage point identified by the 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.
GetWorkerResponse	getWorker(GetWorkerRequest request)	Gets the details of the worker identified by the OCID.
ListDedicatedVantagePointsResponse	listDedicatedVantagePoints(ListDedicatedVantagePointsRequest request)	Returns a list of dedicated vantage points.
ListMonitorsResponse	listMonitors(ListMonitorsRequest request)	Returns a list of monitors.
ListOnPremiseVantagePointsResponse	listOnPremiseVantagePoints(ListOnPremiseVantagePointsRequest request)	Returns a list of On-premise vantage points.
ListPublicVantagePointsResponse	listPublicVantagePoints(ListPublicVantagePointsRequest request)	Returns a list of public vantage points.
ListScriptsResponse	listScripts(ListScriptsRequest request)	Returns a list of scripts.
ListWorkersResponse	listWorkers(ListWorkersRequest request)	Returns a list of workers.
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.
UpdateDedicatedVantagePointResponse	updateDedicatedVantagePoint(UpdateDedicatedVantagePointRequest request)	Updates the dedicated vantage point.
UpdateMonitorResponse	updateMonitor(UpdateMonitorRequest request)	Updates the monitor.
UpdateOnPremiseVantagePointResponse	updateOnPremiseVantagePoint(UpdateOnPremiseVantagePointRequest request)	Updates the On-premise vantage point.
UpdateScriptResponse	updateScript(UpdateScriptRequest request)	Updates the script.
UpdateWorkerResponse	updateWorker(UpdateWorkerRequest request)	Updates the worker.
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 com.oracle.bmc.apmsynthetics.ApmSynthetic

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for ApmSynthetic.

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

ApmSyntheticClient

@Deprecated
public ApmSyntheticClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

ApmSyntheticClient

@Deprecated
public ApmSyntheticClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                          ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

ApmSyntheticClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

ApmSyntheticClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

ApmSyntheticClient

@Deprecated
public ApmSyntheticClient(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 ApmSyntheticClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

ApmSyntheticClient

@Deprecated
public ApmSyntheticClient(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 ApmSyntheticClient.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)

ApmSyntheticClient

@Deprecated
public ApmSyntheticClient(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 ApmSyntheticClient.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

Method Detail

builder

public static ApmSyntheticClient.Builder builder()

Create a builder for this client.

Returns:

builder

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.

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

createOnPremiseVantagePoint

public CreateOnPremiseVantagePointResponse createOnPremiseVantagePoint(CreateOnPremiseVantagePointRequest request)

Description copied from interface: ApmSynthetic

Registers a new On-premise vantage point.

Specified by:

createOnPremiseVantagePoint 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

createWorker

public CreateWorkerResponse createWorker(CreateWorkerRequest request)

Description copied from interface: ApmSynthetic

Registers a new worker.

Specified by:

createWorker 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

deleteOnPremiseVantagePoint

public DeleteOnPremiseVantagePointResponse deleteOnPremiseVantagePoint(DeleteOnPremiseVantagePointRequest request)

Description copied from interface: ApmSynthetic

Deregisters the specified On-premise vantage point.

Specified by:

deleteOnPremiseVantagePoint 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

deleteWorker

public DeleteWorkerResponse deleteWorker(DeleteWorkerRequest request)

Description copied from interface: ApmSynthetic

Deregisters the specified worker.

Specified by:

deleteWorker 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, Network details, Diagnostics or Script Content.

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

getOnPremiseVantagePoint

public GetOnPremiseVantagePointResponse getOnPremiseVantagePoint(GetOnPremiseVantagePointRequest request)

Description copied from interface: ApmSynthetic

Gets the details of the On-premise vantage point identified by the OCID.

Specified by:

getOnPremiseVantagePoint 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

getWorker

public GetWorkerResponse getWorker(GetWorkerRequest request)

Description copied from interface: ApmSynthetic

Gets the details of the worker identified by the OCID.

Specified by:

getWorker 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

listOnPremiseVantagePoints

public ListOnPremiseVantagePointsResponse listOnPremiseVantagePoints(ListOnPremiseVantagePointsRequest request)

Description copied from interface: ApmSynthetic

Returns a list of On-premise vantage points.

Specified by:

listOnPremiseVantagePoints 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

listWorkers

public ListWorkersResponse listWorkers(ListWorkersRequest request)

Description copied from interface: ApmSynthetic

Returns a list of workers.

Specified by:

listWorkers 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

updateOnPremiseVantagePoint

public UpdateOnPremiseVantagePointResponse updateOnPremiseVantagePoint(UpdateOnPremiseVantagePointRequest request)

Description copied from interface: ApmSynthetic

Updates the On-premise vantage point.

Specified by:

updateOnPremiseVantagePoint 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

updateWorker

public UpdateWorkerResponse updateWorker(UpdateWorkerRequest request)

Description copied from interface: ApmSynthetic

Updates the worker.

Specified by:

updateWorker 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.

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()