com.oracle.bmc.osmanagementhub

Class LifecycleEnvironmentAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.osmanagementhub.LifecycleEnvironmentAsyncClient

All Implemented Interfaces:

LifecycleEnvironmentAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220901")
public class LifecycleEnvironmentAsyncClient
extends BaseAsyncClient
implements LifecycleEnvironmentAsync

Async client implementation for LifecycleEnvironment 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	LifecycleEnvironmentAsyncClient.Builder Builder class for this client.

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Future<AttachManagedInstancesToLifecycleStageResponse>	attachManagedInstancesToLifecycleStage(AttachManagedInstancesToLifecycleStageRequest request, AsyncHandler<AttachManagedInstancesToLifecycleStageRequest,AttachManagedInstancesToLifecycleStageResponse> handler) Attach(add) managed instances to a lifecycle stage.
static LifecycleEnvironmentAsyncClient.Builder	builder() Create a builder for this client.
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<CreateLifecycleEnvironmentResponse>	createLifecycleEnvironment(CreateLifecycleEnvironmentRequest request, AsyncHandler<CreateLifecycleEnvironmentRequest,CreateLifecycleEnvironmentResponse> handler) Creates a new lifecycle environment.
Future<DeleteLifecycleEnvironmentResponse>	deleteLifecycleEnvironment(DeleteLifecycleEnvironmentRequest request, AsyncHandler<DeleteLifecycleEnvironmentRequest,DeleteLifecycleEnvironmentResponse> handler) Deletes a lifecycle environment.
Future<DetachManagedInstancesFromLifecycleStageResponse>	detachManagedInstancesFromLifecycleStage(DetachManagedInstancesFromLifecycleStageRequest request, AsyncHandler<DetachManagedInstancesFromLifecycleStageRequest,DetachManagedInstancesFromLifecycleStageResponse> handler) Detach(remove) managed instance from a lifecycle stage.
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Future<GetLifecycleEnvironmentResponse>	getLifecycleEnvironment(GetLifecycleEnvironmentRequest request, AsyncHandler<GetLifecycleEnvironmentRequest,GetLifecycleEnvironmentResponse> handler) Gets information about the specified lifecycle environment.
Future<GetLifecycleStageResponse>	getLifecycleStage(GetLifecycleStageRequest request, AsyncHandler<GetLifecycleStageRequest,GetLifecycleStageResponse> handler) Gets information about the specified lifecycle stage.
Future<ListLifecycleEnvironmentsResponse>	listLifecycleEnvironments(ListLifecycleEnvironmentsRequest request, AsyncHandler<ListLifecycleEnvironmentsRequest,ListLifecycleEnvironmentsResponse> handler) Lists lifecycle environments that match the specified compartment or lifecycle environment OCID.
Future<ListLifecycleStageInstalledPackagesResponse>	listLifecycleStageInstalledPackages(ListLifecycleStageInstalledPackagesRequest request, AsyncHandler<ListLifecycleStageInstalledPackagesRequest,ListLifecycleStageInstalledPackagesResponse> handler) Lists installed packages on managed instances in a specified lifecycle stage.
Future<ListLifecycleStagesResponse>	listLifecycleStages(ListLifecycleStagesRequest request, AsyncHandler<ListLifecycleStagesRequest,ListLifecycleStagesResponse> handler) Lists lifecycle stages that match the specified compartment or lifecycle stage OCID.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
Future<PromoteSoftwareSourceToLifecycleStageResponse>	promoteSoftwareSourceToLifecycleStage(PromoteSoftwareSourceToLifecycleStageRequest request, AsyncHandler<PromoteSoftwareSourceToLifecycleStageRequest,PromoteSoftwareSourceToLifecycleStageResponse> handler) Updates the versioned custom software source content for specified lifecycle stage.
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.
Future<UpdateLifecycleEnvironmentResponse>	updateLifecycleEnvironment(UpdateLifecycleEnvironmentRequest request, AsyncHandler<UpdateLifecycleEnvironmentRequest,UpdateLifecycleEnvironmentResponse> handler) Updates the specified lifecycle environment’s name, description, stages, or tags.
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.osmanagementhub.LifecycleEnvironmentAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for LifecycleEnvironment.

Constructor Detail

LifecycleEnvironmentAsyncClient

@Deprecated
public LifecycleEnvironmentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

LifecycleEnvironmentAsyncClient

@Deprecated
public LifecycleEnvironmentAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                                   ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

LifecycleEnvironmentAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

LifecycleEnvironmentAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

LifecycleEnvironmentAsyncClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

LifecycleEnvironmentAsyncClient

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

LifecycleEnvironmentAsyncClient

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

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: LifecycleEnvironmentAsync

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 LifecycleEnvironmentAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: LifecycleEnvironmentAsync

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 LifecycleEnvironmentAsync

Parameters:

regionId - The public region ID.

attachManagedInstancesToLifecycleStage

public Future<AttachManagedInstancesToLifecycleStageResponse> attachManagedInstancesToLifecycleStage(AttachManagedInstancesToLifecycleStageRequest request,
                                                                                                     AsyncHandler<AttachManagedInstancesToLifecycleStageRequest,AttachManagedInstancesToLifecycleStageResponse> handler)

Description copied from interface: LifecycleEnvironmentAsync

Attach(add) managed instances to a lifecycle stage. Once added operations can be applied to all managed instances in the lifecycle stage.

Specified by:

attachManagedInstancesToLifecycleStage in interface LifecycleEnvironmentAsync

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.

createLifecycleEnvironment

public Future<CreateLifecycleEnvironmentResponse> createLifecycleEnvironment(CreateLifecycleEnvironmentRequest request,
                                                                             AsyncHandler<CreateLifecycleEnvironmentRequest,CreateLifecycleEnvironmentResponse> handler)

Description copied from interface: LifecycleEnvironmentAsync

Creates a new lifecycle environment.

Specified by:

createLifecycleEnvironment in interface LifecycleEnvironmentAsync

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.

deleteLifecycleEnvironment

public Future<DeleteLifecycleEnvironmentResponse> deleteLifecycleEnvironment(DeleteLifecycleEnvironmentRequest request,
                                                                             AsyncHandler<DeleteLifecycleEnvironmentRequest,DeleteLifecycleEnvironmentResponse> handler)

Description copied from interface: LifecycleEnvironmentAsync

Deletes a lifecycle environment.

Specified by:

deleteLifecycleEnvironment in interface LifecycleEnvironmentAsync

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.

detachManagedInstancesFromLifecycleStage

public Future<DetachManagedInstancesFromLifecycleStageResponse> detachManagedInstancesFromLifecycleStage(DetachManagedInstancesFromLifecycleStageRequest request,
                                                                                                         AsyncHandler<DetachManagedInstancesFromLifecycleStageRequest,DetachManagedInstancesFromLifecycleStageResponse> handler)

Description copied from interface: LifecycleEnvironmentAsync

Detach(remove) managed instance from a lifecycle stage.

Specified by:

detachManagedInstancesFromLifecycleStage in interface LifecycleEnvironmentAsync

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.

getLifecycleEnvironment

public Future<GetLifecycleEnvironmentResponse> getLifecycleEnvironment(GetLifecycleEnvironmentRequest request,
                                                                       AsyncHandler<GetLifecycleEnvironmentRequest,GetLifecycleEnvironmentResponse> handler)

Description copied from interface: LifecycleEnvironmentAsync

Gets information about the specified lifecycle environment.

Specified by:

getLifecycleEnvironment in interface LifecycleEnvironmentAsync

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.

getLifecycleStage

public Future<GetLifecycleStageResponse> getLifecycleStage(GetLifecycleStageRequest request,
                                                           AsyncHandler<GetLifecycleStageRequest,GetLifecycleStageResponse> handler)

Description copied from interface: LifecycleEnvironmentAsync

Gets information about the specified lifecycle stage.

Specified by:

getLifecycleStage in interface LifecycleEnvironmentAsync

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.

listLifecycleEnvironments

public Future<ListLifecycleEnvironmentsResponse> listLifecycleEnvironments(ListLifecycleEnvironmentsRequest request,
                                                                           AsyncHandler<ListLifecycleEnvironmentsRequest,ListLifecycleEnvironmentsResponse> handler)

Description copied from interface: LifecycleEnvironmentAsync

Lists lifecycle environments that match the specified compartment or lifecycle environment OCID. Filter the list against a variety of criteria including but not limited to its name, status, architecture, and OS family.

Specified by:

listLifecycleEnvironments in interface LifecycleEnvironmentAsync

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.

listLifecycleStageInstalledPackages

public Future<ListLifecycleStageInstalledPackagesResponse> listLifecycleStageInstalledPackages(ListLifecycleStageInstalledPackagesRequest request,
                                                                                               AsyncHandler<ListLifecycleStageInstalledPackagesRequest,ListLifecycleStageInstalledPackagesResponse> handler)

Description copied from interface: LifecycleEnvironmentAsync

Lists installed packages on managed instances in a specified lifecycle stage. Filter the list against a variety of criteria including but not limited to the package name.

Specified by:

listLifecycleStageInstalledPackages in interface LifecycleEnvironmentAsync

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.

listLifecycleStages

public Future<ListLifecycleStagesResponse> listLifecycleStages(ListLifecycleStagesRequest request,
                                                               AsyncHandler<ListLifecycleStagesRequest,ListLifecycleStagesResponse> handler)

Description copied from interface: LifecycleEnvironmentAsync

Lists lifecycle stages that match the specified compartment or lifecycle stage OCID. Filter the list against a variety of criteria including but not limited to its name, status, architecture, and OS family.

Specified by:

listLifecycleStages in interface LifecycleEnvironmentAsync

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.

promoteSoftwareSourceToLifecycleStage

public Future<PromoteSoftwareSourceToLifecycleStageResponse> promoteSoftwareSourceToLifecycleStage(PromoteSoftwareSourceToLifecycleStageRequest request,
                                                                                                   AsyncHandler<PromoteSoftwareSourceToLifecycleStageRequest,PromoteSoftwareSourceToLifecycleStageResponse> handler)

Description copied from interface: LifecycleEnvironmentAsync

Updates the versioned custom software source content for specified lifecycle stage.

Specified by:

promoteSoftwareSourceToLifecycleStage in interface LifecycleEnvironmentAsync

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.

updateLifecycleEnvironment

public Future<UpdateLifecycleEnvironmentResponse> updateLifecycleEnvironment(UpdateLifecycleEnvironmentRequest request,
                                                                             AsyncHandler<UpdateLifecycleEnvironmentRequest,UpdateLifecycleEnvironmentResponse> handler)

Description copied from interface: LifecycleEnvironmentAsync

Updates the specified lifecycle environment’s name, description, stages, or tags.

Specified by:

updateLifecycleEnvironment in interface LifecycleEnvironmentAsync

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

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)