com.oracle.bmc.cloudbridge

Class CommonClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.cloudbridge.CommonClient

All Implemented Interfaces:

Common, AutoCloseable

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

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static CommonClient.Builder	builder() Create a builder for this client.
CancelWorkRequestResponse	cancelWorkRequest(CancelWorkRequestRequest request) Cancels the work request with the given ID.
void	close()
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
CommonPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
CommonWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
GetWorkRequestResponse	getWorkRequest(GetWorkRequestRequest request) Gets details of the work request with the given ID.
ListWorkRequestErrorsResponse	listWorkRequestErrors(ListWorkRequestErrorsRequest request) Returns a (paginated) list of errors for the work request with the given ID.
ListWorkRequestLogsResponse	listWorkRequestLogs(ListWorkRequestLogsRequest request) Returns a (paginated) list of logs for the work request with the given ID.
ListWorkRequestsResponse	listWorkRequests(ListWorkRequestsRequest request) 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.
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.
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.Common

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Common.

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

CommonClient

@Deprecated
public CommonClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

CommonClient

@Deprecated
public CommonClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

CommonClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

CommonClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

CommonClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

CommonClient

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

CommonClient

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

CommonClient

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

Method Detail

builder

public static CommonClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: Common

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 Common

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: Common

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 Common

Parameters:

regionId - The public region ID.

cancelWorkRequest

public CancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)

Description copied from interface: Common

Cancels the work request with the given ID.

Specified by:

cancelWorkRequest in interface Common

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWorkRequest

public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

Description copied from interface: Common

Gets details of the work request with the given ID.

Specified by:

getWorkRequest in interface Common

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestErrors

public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

Description copied from interface: Common

Returns a (paginated) list of errors for the work request with the given ID.

Specified by:

listWorkRequestErrors in interface Common

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestLogs

public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)

Description copied from interface: Common

Returns a (paginated) list of logs for the work request with the given ID.

Specified by:

listWorkRequestLogs in interface Common

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequests

public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)

Description copied from interface: Common

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface Common

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public CommonWaiters getWaiters()

Description copied from interface: Common

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

Specified by:

getWaiters in interface Common

Returns:

The service waiters.

getPaginators

public CommonPaginators getPaginators()

Description copied from interface: Common

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 Common

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