com.oracle.bmc.cloudbridge

Class OcbAgentSvcClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.cloudbridge.OcbAgentSvcClient

All Implemented Interfaces:

OcbAgentSvc, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220509")
public class OcbAgentSvcClient
extends BaseSyncClient
implements OcbAgentSvc

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and 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 OcbAgentSvc.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
AddAgentDependencyResponse	addAgentDependency(AddAgentDependencyRequest request) Add a dependency to the environment.
static OcbAgentSvcClient.Builder	builder() Create a builder for this client.
ChangeAgentCompartmentResponse	changeAgentCompartment(ChangeAgentCompartmentRequest request) Moves an Agent resource from one compartment identifier to another.
ChangeAgentDependencyCompartmentResponse	changeAgentDependencyCompartment(ChangeAgentDependencyCompartmentRequest request) Moves a AgentDependency resource from one compartment identifier to another.
ChangeEnvironmentCompartmentResponse	changeEnvironmentCompartment(ChangeEnvironmentCompartmentRequest request) Moves a source environment resource from one compartment identifier to another.
void	close()
CreateAgentResponse	createAgent(CreateAgentRequest request) Creates an Agent.
CreateAgentDependencyResponse	createAgentDependency(CreateAgentDependencyRequest request) Creates an AgentDependency.
CreateEnvironmentResponse	createEnvironment(CreateEnvironmentRequest request) Creates a source environment.
DeleteAgentResponse	deleteAgent(DeleteAgentRequest request) Deletes an Agent resource identified by an identifier.
DeleteAgentDependencyResponse	deleteAgentDependency(DeleteAgentDependencyRequest request) Deletes the AgentDependency resource based on an identifier.
DeleteEnvironmentResponse	deleteEnvironment(DeleteEnvironmentRequest request) Deletes a the source environment resource identified by an identifier.
GetAgentResponse	getAgent(GetAgentRequest request) Gets an Agent by identifier.
GetAgentDependencyResponse	getAgentDependency(GetAgentDependencyRequest request) Gets an AgentDependency by identifier.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
GetEnvironmentResponse	getEnvironment(GetEnvironmentRequest request) Gets a source environment by identifier.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
OcbAgentSvcPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetPluginResponse	getPlugin(GetPluginRequest request) Gets a plugin by identifier.
OcbAgentSvcWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListAgentDependenciesResponse	listAgentDependencies(ListAgentDependenciesRequest request) Returns a list of AgentDependencies such as AgentDependencyCollection.
ListAgentsResponse	listAgents(ListAgentsRequest request) Returns a list of Agents.
ListApplianceImagesResponse	listApplianceImages(ListApplianceImagesRequest request) Returns a list of Appliance Images.
ListEnvironmentsResponse	listEnvironments(ListEnvironmentsRequest request) Returns a list of source environments.
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.
RemoveAgentDependencyResponse	removeAgentDependency(RemoveAgentDependencyRequest request) Adds a dependency to the source environment.
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’).
UpdateAgentResponse	updateAgent(UpdateAgentRequest request) Updates the Agent.
UpdateAgentDependencyResponse	updateAgentDependency(UpdateAgentDependencyRequest request) Updates the AgentDependency.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
UpdateEnvironmentResponse	updateEnvironment(UpdateEnvironmentRequest request) Updates the source environment.
UpdatePluginResponse	updatePlugin(UpdatePluginRequest request) Updates the plugin.
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.cloudbridge.OcbAgentSvc

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for OcbAgentSvc.

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

OcbAgentSvcClient

@Deprecated
public OcbAgentSvcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

OcbAgentSvcClient

@Deprecated
public OcbAgentSvcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                     ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

OcbAgentSvcClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

OcbAgentSvcClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

OcbAgentSvcClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

OcbAgentSvcClient

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

OcbAgentSvcClient

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

OcbAgentSvcClient

@Deprecated
public OcbAgentSvcClient(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 OcbAgentSvcClient.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 - OcbAgentSvcClient.Builder.executorService

Method Detail

builder

public static OcbAgentSvcClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: OcbAgentSvc

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 OcbAgentSvc

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: OcbAgentSvc

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 OcbAgentSvc

Parameters:

regionId - The public region ID.

addAgentDependency

public AddAgentDependencyResponse addAgentDependency(AddAgentDependencyRequest request)

Description copied from interface: OcbAgentSvc

Add a dependency to the environment. When provided, If-Match is checked against ETag values of the resource.

Specified by:

addAgentDependency in interface OcbAgentSvc

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeAgentCompartment

public ChangeAgentCompartmentResponse changeAgentCompartment(ChangeAgentCompartmentRequest request)

Description copied from interface: OcbAgentSvc

Moves an Agent resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Specified by:

changeAgentCompartment in interface OcbAgentSvc

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeAgentDependencyCompartment

public ChangeAgentDependencyCompartmentResponse changeAgentDependencyCompartment(ChangeAgentDependencyCompartmentRequest request)

Description copied from interface: OcbAgentSvc

Moves a AgentDependency resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Specified by:

changeAgentDependencyCompartment in interface OcbAgentSvc

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeEnvironmentCompartment

public ChangeEnvironmentCompartmentResponse changeEnvironmentCompartment(ChangeEnvironmentCompartmentRequest request)

Description copied from interface: OcbAgentSvc

Moves a source environment resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Specified by:

changeEnvironmentCompartment in interface OcbAgentSvc

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createAgent

public CreateAgentResponse createAgent(CreateAgentRequest request)

Description copied from interface: OcbAgentSvc

Creates an Agent.

Specified by:

createAgent in interface OcbAgentSvc

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createAgentDependency

public CreateAgentDependencyResponse createAgentDependency(CreateAgentDependencyRequest request)

Description copied from interface: OcbAgentSvc

Creates an AgentDependency.

Specified by:

createAgentDependency in interface OcbAgentSvc

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createEnvironment

public CreateEnvironmentResponse createEnvironment(CreateEnvironmentRequest request)

Description copied from interface: OcbAgentSvc

Creates a source environment.

Specified by:

createEnvironment in interface OcbAgentSvc

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteAgent

public DeleteAgentResponse deleteAgent(DeleteAgentRequest request)

Description copied from interface: OcbAgentSvc

Deletes an Agent resource identified by an identifier.

Specified by:

deleteAgent in interface OcbAgentSvc

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteAgentDependency

public DeleteAgentDependencyResponse deleteAgentDependency(DeleteAgentDependencyRequest request)

Description copied from interface: OcbAgentSvc

Deletes the AgentDependency resource based on an identifier.

Specified by:

deleteAgentDependency in interface OcbAgentSvc

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteEnvironment

public DeleteEnvironmentResponse deleteEnvironment(DeleteEnvironmentRequest request)

Description copied from interface: OcbAgentSvc

Deletes a the source environment resource identified by an identifier.

Specified by:

deleteEnvironment in interface OcbAgentSvc

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getAgent

public GetAgentResponse getAgent(GetAgentRequest request)

Description copied from interface: OcbAgentSvc

Gets an Agent by identifier.

Specified by:

getAgent in interface OcbAgentSvc

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getAgentDependency

public GetAgentDependencyResponse getAgentDependency(GetAgentDependencyRequest request)

Description copied from interface: OcbAgentSvc

Gets an AgentDependency by identifier.

Specified by:

getAgentDependency in interface OcbAgentSvc

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getEnvironment

public GetEnvironmentResponse getEnvironment(GetEnvironmentRequest request)

Description copied from interface: OcbAgentSvc

Gets a source environment by identifier.

Specified by:

getEnvironment in interface OcbAgentSvc

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getPlugin

public GetPluginResponse getPlugin(GetPluginRequest request)

Description copied from interface: OcbAgentSvc

Gets a plugin by identifier.

Specified by:

getPlugin in interface OcbAgentSvc

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listAgentDependencies

public ListAgentDependenciesResponse listAgentDependencies(ListAgentDependenciesRequest request)

Description copied from interface: OcbAgentSvc

Returns a list of AgentDependencies such as AgentDependencyCollection.

Specified by:

listAgentDependencies in interface OcbAgentSvc

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listAgents

public ListAgentsResponse listAgents(ListAgentsRequest request)

Description copied from interface: OcbAgentSvc

Returns a list of Agents.

Specified by:

listAgents in interface OcbAgentSvc

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listApplianceImages

public ListApplianceImagesResponse listApplianceImages(ListApplianceImagesRequest request)

Description copied from interface: OcbAgentSvc

Returns a list of Appliance Images.

Specified by:

listApplianceImages in interface OcbAgentSvc

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listEnvironments

public ListEnvironmentsResponse listEnvironments(ListEnvironmentsRequest request)

Description copied from interface: OcbAgentSvc

Returns a list of source environments.

Specified by:

listEnvironments in interface OcbAgentSvc

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

removeAgentDependency

public RemoveAgentDependencyResponse removeAgentDependency(RemoveAgentDependencyRequest request)

Description copied from interface: OcbAgentSvc

Adds a dependency to the source environment. When provided, If-Match is checked against ETag values of the resource.

Specified by:

removeAgentDependency in interface OcbAgentSvc

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateAgent

public UpdateAgentResponse updateAgent(UpdateAgentRequest request)

Description copied from interface: OcbAgentSvc

Updates the Agent.

Specified by:

updateAgent in interface OcbAgentSvc

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateAgentDependency

public UpdateAgentDependencyResponse updateAgentDependency(UpdateAgentDependencyRequest request)

Description copied from interface: OcbAgentSvc

Updates the AgentDependency.

Specified by:

updateAgentDependency in interface OcbAgentSvc

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateEnvironment

public UpdateEnvironmentResponse updateEnvironment(UpdateEnvironmentRequest request)

Description copied from interface: OcbAgentSvc

Updates the source environment.

Specified by:

updateEnvironment in interface OcbAgentSvc

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updatePlugin

public UpdatePluginResponse updatePlugin(UpdatePluginRequest request)

Description copied from interface: OcbAgentSvc

Updates the plugin.

Specified by:

updatePlugin in interface OcbAgentSvc

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public OcbAgentSvcWaiters getWaiters()

Description copied from interface: OcbAgentSvc

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

Specified by:

getWaiters in interface OcbAgentSvc

Returns:

The service waiters.

getPaginators

public OcbAgentSvcPaginators getPaginators()

Description copied from interface: OcbAgentSvc

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 OcbAgentSvc

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