Package com.oracle.bmc.apiaccesscontrol

Class PrivilegedApiRequestsClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.apiaccesscontrol.PrivilegedApiRequestsClient

All Implemented Interfaces:

PrivilegedApiRequests, AutoCloseable

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

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ApprovePrivilegedApiRequestResponse	approvePrivilegedApiRequest(ApprovePrivilegedApiRequestRequest request)	Approves privilegedApi request.
static PrivilegedApiRequestsClient.Builder	builder()	Create a builder for this client.
void	close()
ClosePrivilegedApiRequestResponse	closePrivilegedApiRequest(ClosePrivilegedApiRequestRequest request)	Closes privilegedApi request.
CreatePrivilegedApiRequestResponse	createPrivilegedApiRequest(CreatePrivilegedApiRequestRequest request)	Creates a PrivilegedApiRequest.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
PrivilegedApiRequestsPaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetPrivilegedApiRequestResponse	getPrivilegedApiRequest(GetPrivilegedApiRequestRequest request)	Gets information about a PrivilegedApiRequest.
PrivilegedApiRequestsWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
ListPrivilegedApiRequestsResponse	listPrivilegedApiRequests(ListPrivilegedApiRequestsRequest request)	Lists all privilegedApi requests in the 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.
RejectPrivilegedApiRequestResponse	rejectPrivilegedApiRequest(RejectPrivilegedApiRequestRequest request)	Rejects privilegedApi request.
RevokePrivilegedApiRequestResponse	revokePrivilegedApiRequest(RevokePrivilegedApiRequestRequest request)	Revokes an already approved privilegedApi request.
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 java.lang.AutoCloseable

close

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

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for PrivilegedApiRequests.

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

PrivilegedApiRequestsClient

@Deprecated
public PrivilegedApiRequestsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

PrivilegedApiRequestsClient

@Deprecated
public PrivilegedApiRequestsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                   ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

PrivilegedApiRequestsClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

PrivilegedApiRequestsClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

PrivilegedApiRequestsClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

PrivilegedApiRequestsClient

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

PrivilegedApiRequestsClient

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

PrivilegedApiRequestsClient

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

Method Detail

builder

public static PrivilegedApiRequestsClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: PrivilegedApiRequests

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 PrivilegedApiRequests

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: PrivilegedApiRequests

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 PrivilegedApiRequests

Parameters:

regionId - The public region ID.

approvePrivilegedApiRequest

public ApprovePrivilegedApiRequestResponse approvePrivilegedApiRequest(ApprovePrivilegedApiRequestRequest request)

Description copied from interface: PrivilegedApiRequests

Approves privilegedApi request.

Specified by:

approvePrivilegedApiRequest in interface PrivilegedApiRequests

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

closePrivilegedApiRequest

public ClosePrivilegedApiRequestResponse closePrivilegedApiRequest(ClosePrivilegedApiRequestRequest request)

Description copied from interface: PrivilegedApiRequests

Closes privilegedApi request.

Specified by:

closePrivilegedApiRequest in interface PrivilegedApiRequests

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createPrivilegedApiRequest

public CreatePrivilegedApiRequestResponse createPrivilegedApiRequest(CreatePrivilegedApiRequestRequest request)

Description copied from interface: PrivilegedApiRequests

Creates a PrivilegedApiRequest.

Specified by:

createPrivilegedApiRequest in interface PrivilegedApiRequests

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getPrivilegedApiRequest

public GetPrivilegedApiRequestResponse getPrivilegedApiRequest(GetPrivilegedApiRequestRequest request)

Description copied from interface: PrivilegedApiRequests

Gets information about a PrivilegedApiRequest.

Specified by:

getPrivilegedApiRequest in interface PrivilegedApiRequests

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listPrivilegedApiRequests

public ListPrivilegedApiRequestsResponse listPrivilegedApiRequests(ListPrivilegedApiRequestsRequest request)

Description copied from interface: PrivilegedApiRequests

Lists all privilegedApi requests in the compartment.

Specified by:

listPrivilegedApiRequests in interface PrivilegedApiRequests

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

rejectPrivilegedApiRequest

public RejectPrivilegedApiRequestResponse rejectPrivilegedApiRequest(RejectPrivilegedApiRequestRequest request)

Description copied from interface: PrivilegedApiRequests

Rejects privilegedApi request.

Specified by:

rejectPrivilegedApiRequest in interface PrivilegedApiRequests

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

revokePrivilegedApiRequest

public RevokePrivilegedApiRequestResponse revokePrivilegedApiRequest(RevokePrivilegedApiRequestRequest request)

Description copied from interface: PrivilegedApiRequests

Revokes an already approved privilegedApi request.

Specified by:

revokePrivilegedApiRequest in interface PrivilegedApiRequests

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public PrivilegedApiRequestsWaiters getWaiters()

Description copied from interface: PrivilegedApiRequests

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

Specified by:

getWaiters in interface PrivilegedApiRequests

Returns:

The service waiters.

getPaginators

public PrivilegedApiRequestsPaginators getPaginators()

Description copied from interface: PrivilegedApiRequests

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 PrivilegedApiRequests

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