com.oracle.bmc.visualbuilder

Class VbInstanceAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.visualbuilder.VbInstanceAsyncClient

All Implemented Interfaces:

VbInstanceAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210601")
public class VbInstanceAsyncClient
extends BaseAsyncClient
implements VbInstanceAsync

Async client implementation for VbInstance service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static VbInstanceAsyncClient.Builder	builder() Create a builder for this client.
Future<ChangeVbInstanceCompartmentResponse>	changeVbInstanceCompartment(ChangeVbInstanceCompartmentRequest request, AsyncHandler<ChangeVbInstanceCompartmentRequest,ChangeVbInstanceCompartmentResponse> handler) Change the compartment for an vb instance
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>	clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
void	close()
Future<CreateVbInstanceResponse>	createVbInstance(CreateVbInstanceRequest request, AsyncHandler<CreateVbInstanceRequest,CreateVbInstanceResponse> handler) Creates a new Vb Instance.
Future<DeleteVbInstanceResponse>	deleteVbInstance(DeleteVbInstanceRequest request, AsyncHandler<DeleteVbInstanceRequest,DeleteVbInstanceResponse> handler) Deletes an Vb Instance resource by identifier.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetVbInstanceResponse>	getVbInstance(GetVbInstanceRequest request, AsyncHandler<GetVbInstanceRequest,GetVbInstanceResponse> handler) Gets a VbInstance by identifier
Future<GetWorkRequestResponse>	getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler) Gets the status of the work request with the given ID.
Future<ListVbInstancesResponse>	listVbInstances(ListVbInstancesRequest request, AsyncHandler<ListVbInstancesRequest,ListVbInstancesResponse> handler) Returns a list of Vb Instances.
Future<ListWorkRequestErrorsResponse>	listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler) Get the errors of a work request.
Future<ListWorkRequestLogsResponse>	listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler) Get the logs of a work request.
Future<ListWorkRequestsResponse>	listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler) 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.
Future<RequestSummarizedApplicationsResponse>	requestSummarizedApplications(RequestSummarizedApplicationsRequest request, AsyncHandler<RequestSummarizedApplicationsRequest,RequestSummarizedApplicationsResponse> handler) Summarizes the applications for a vb instance.
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’).
Future<StartVbInstanceResponse>	startVbInstance(StartVbInstanceRequest request, AsyncHandler<StartVbInstanceRequest,StartVbInstanceResponse> handler) Start an vb instance that was previously in an INACTIVE state.
Future<StopVbInstanceResponse>	stopVbInstance(StopVbInstanceRequest request, AsyncHandler<StopVbInstanceRequest,StopVbInstanceResponse> handler) Stop an vb instance that was previously in an ACTIVE state.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
Future<UpdateVbInstanceResponse>	updateVbInstance(UpdateVbInstanceRequest request, AsyncHandler<UpdateVbInstanceRequest,UpdateVbInstanceResponse> handler) Updates the Vb Instance.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

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.visualbuilder.VbInstanceAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for VbInstance.

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

VbInstanceAsyncClient

@Deprecated
public VbInstanceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

VbInstanceAsyncClient

@Deprecated
public VbInstanceAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                         ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

VbInstanceAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

VbInstanceAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

VbInstanceAsyncClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

VbInstanceAsyncClient

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

VbInstanceAsyncClient

@Deprecated
public VbInstanceAsyncClient(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 VbInstanceAsyncClient.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 VbInstanceAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: VbInstanceAsync

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 VbInstanceAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: VbInstanceAsync

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 VbInstanceAsync

Parameters:

regionId - The public region ID.

changeVbInstanceCompartment

public Future<ChangeVbInstanceCompartmentResponse> changeVbInstanceCompartment(ChangeVbInstanceCompartmentRequest request,
                                                                               AsyncHandler<ChangeVbInstanceCompartmentRequest,ChangeVbInstanceCompartmentResponse> handler)

Description copied from interface: VbInstanceAsync

Change the compartment for an vb instance

Specified by:

changeVbInstanceCompartment in interface VbInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createVbInstance

public Future<CreateVbInstanceResponse> createVbInstance(CreateVbInstanceRequest request,
                                                         AsyncHandler<CreateVbInstanceRequest,CreateVbInstanceResponse> handler)

Description copied from interface: VbInstanceAsync

Creates a new Vb Instance.

Specified by:

createVbInstance in interface VbInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteVbInstance

public Future<DeleteVbInstanceResponse> deleteVbInstance(DeleteVbInstanceRequest request,
                                                         AsyncHandler<DeleteVbInstanceRequest,DeleteVbInstanceResponse> handler)

Description copied from interface: VbInstanceAsync

Deletes an Vb Instance resource by identifier.

Specified by:

deleteVbInstance in interface VbInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getVbInstance

public Future<GetVbInstanceResponse> getVbInstance(GetVbInstanceRequest request,
                                                   AsyncHandler<GetVbInstanceRequest,GetVbInstanceResponse> handler)

Description copied from interface: VbInstanceAsync

Gets a VbInstance by identifier

Specified by:

getVbInstance in interface VbInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getWorkRequest

public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request,
                                                     AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)

Description copied from interface: VbInstanceAsync

Gets the status of the work request with the given ID.

Specified by:

getWorkRequest in interface VbInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listVbInstances

public Future<ListVbInstancesResponse> listVbInstances(ListVbInstancesRequest request,
                                                       AsyncHandler<ListVbInstancesRequest,ListVbInstancesResponse> handler)

Description copied from interface: VbInstanceAsync

Returns a list of Vb Instances.

Specified by:

listVbInstances in interface VbInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listWorkRequestErrors

public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request,
                                                                   AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)

Description copied from interface: VbInstanceAsync

Get the errors of a work request.

Specified by:

listWorkRequestErrors in interface VbInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listWorkRequestLogs

public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request,
                                                               AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)

Description copied from interface: VbInstanceAsync

Get the logs of a work request.

Specified by:

listWorkRequestLogs in interface VbInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listWorkRequests

public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request,
                                                         AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)

Description copied from interface: VbInstanceAsync

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface VbInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

requestSummarizedApplications

public Future<RequestSummarizedApplicationsResponse> requestSummarizedApplications(RequestSummarizedApplicationsRequest request,
                                                                                   AsyncHandler<RequestSummarizedApplicationsRequest,RequestSummarizedApplicationsResponse> handler)

Description copied from interface: VbInstanceAsync

Summarizes the applications for a vb instance.

Specified by:

requestSummarizedApplications in interface VbInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

startVbInstance

public Future<StartVbInstanceResponse> startVbInstance(StartVbInstanceRequest request,
                                                       AsyncHandler<StartVbInstanceRequest,StartVbInstanceResponse> handler)

Description copied from interface: VbInstanceAsync

Start an vb instance that was previously in an INACTIVE state. If the previous state is not INACTIVE, then the state of the vbInstance will not be changed and a 409 response returned.

Specified by:

startVbInstance in interface VbInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

stopVbInstance

public Future<StopVbInstanceResponse> stopVbInstance(StopVbInstanceRequest request,
                                                     AsyncHandler<StopVbInstanceRequest,StopVbInstanceResponse> handler)

Description copied from interface: VbInstanceAsync

Stop an vb instance that was previously in an ACTIVE state. If the previous state is not ACTIVE, then the state of the vbInstance will not be changed and a 409 response returned.

Specified by:

stopVbInstance in interface VbInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateVbInstance

public Future<UpdateVbInstanceResponse> updateVbInstance(UpdateVbInstanceRequest request,
                                                         AsyncHandler<UpdateVbInstanceRequest,UpdateVbInstanceResponse> handler)

Description copied from interface: VbInstanceAsync

Updates the Vb Instance.

Specified by:

updateVbInstance in interface VbInstanceAsync

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

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

clientCall

protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                           Supplier<RESP_BUILDER> responseBuilder)