Package com.oracle.bmc.apiaccesscontrol

Class PrivilegedApiControlClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.apiaccesscontrol.PrivilegedApiControlClient

All Implemented Interfaces:

PrivilegedApiControl, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20241130")
public class PrivilegedApiControlClient
extends BaseSyncClient
implements PrivilegedApiControl

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
String	clientCommonLibraryVersion	Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient	Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE	Service instance for PrivilegedApiControl.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static PrivilegedApiControlClient.Builder	builder()	Create a builder for this client.
ChangePrivilegedApiControlCompartmentResponse	changePrivilegedApiControlCompartment(ChangePrivilegedApiControlCompartmentRequest request)	Moves a PrivilegedApiControl into a different compartment within the same tenancy.
void	close()
CreatePrivilegedApiControlResponse	createPrivilegedApiControl(CreatePrivilegedApiControlRequest request)	Creates a PrivilegedApiControl.
DeletePrivilegedApiControlResponse	deletePrivilegedApiControl(DeletePrivilegedApiControlRequest request)	Deletes a PrivilegedApiControl.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
PrivilegedApiControlPaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetPrivilegedApiControlResponse	getPrivilegedApiControl(GetPrivilegedApiControlRequest request)	Gets information about a PrivilegedApiControl.
PrivilegedApiControlWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
ListPrivilegedApiControlsResponse	listPrivilegedApiControls(ListPrivilegedApiControlsRequest request)	Gets a list of PrivilegedApiControls.
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.
UpdatePrivilegedApiControlResponse	updatePrivilegedApiControl(UpdatePrivilegedApiControlRequest request)	Updates a PrivilegedApiControl.
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 java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.apiaccesscontrol.PrivilegedApiControl

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for PrivilegedApiControl.

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

PrivilegedApiControlClient

@Deprecated
public PrivilegedApiControlClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

PrivilegedApiControlClient

@Deprecated
public PrivilegedApiControlClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                  ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

PrivilegedApiControlClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

PrivilegedApiControlClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

PrivilegedApiControlClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

PrivilegedApiControlClient

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

PrivilegedApiControlClient

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

PrivilegedApiControlClient

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

Method Detail

builder

public static PrivilegedApiControlClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: PrivilegedApiControl

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 PrivilegedApiControl

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: PrivilegedApiControl

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 PrivilegedApiControl

Parameters:

regionId - The public region ID.

changePrivilegedApiControlCompartment

public ChangePrivilegedApiControlCompartmentResponse changePrivilegedApiControlCompartment(ChangePrivilegedApiControlCompartmentRequest request)

Description copied from interface: PrivilegedApiControl

Moves a PrivilegedApiControl into a different compartment within the same tenancy.

For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Specified by:

changePrivilegedApiControlCompartment in interface PrivilegedApiControl

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createPrivilegedApiControl

public CreatePrivilegedApiControlResponse createPrivilegedApiControl(CreatePrivilegedApiControlRequest request)

Description copied from interface: PrivilegedApiControl

Creates a PrivilegedApiControl.

Specified by:

createPrivilegedApiControl in interface PrivilegedApiControl

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deletePrivilegedApiControl

public DeletePrivilegedApiControlResponse deletePrivilegedApiControl(DeletePrivilegedApiControlRequest request)

Description copied from interface: PrivilegedApiControl

Deletes a PrivilegedApiControl.

Specified by:

deletePrivilegedApiControl in interface PrivilegedApiControl

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getPrivilegedApiControl

public GetPrivilegedApiControlResponse getPrivilegedApiControl(GetPrivilegedApiControlRequest request)

Description copied from interface: PrivilegedApiControl

Gets information about a PrivilegedApiControl.

Specified by:

getPrivilegedApiControl in interface PrivilegedApiControl

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listPrivilegedApiControls

public ListPrivilegedApiControlsResponse listPrivilegedApiControls(ListPrivilegedApiControlsRequest request)

Description copied from interface: PrivilegedApiControl

Gets a list of PrivilegedApiControls.

Specified by:

listPrivilegedApiControls in interface PrivilegedApiControl

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updatePrivilegedApiControl

public UpdatePrivilegedApiControlResponse updatePrivilegedApiControl(UpdatePrivilegedApiControlRequest request)

Description copied from interface: PrivilegedApiControl

Updates a PrivilegedApiControl.

Specified by:

updatePrivilegedApiControl in interface PrivilegedApiControl

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public PrivilegedApiControlWaiters getWaiters()

Description copied from interface: PrivilegedApiControl

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

Specified by:

getWaiters in interface PrivilegedApiControl

Returns:

The service waiters.

getPaginators

public PrivilegedApiControlPaginators getPaginators()

Description copied from interface: PrivilegedApiControl

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 PrivilegedApiControl

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