Package com.oracle.bmc.apiaccesscontrol

Interface PrivilegedApiControlAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

PrivilegedApiControlAsyncClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20241130")
public interface PrivilegedApiControlAsync
extends AutoCloseable

This service is used to restrict the control plane service apis; so that everybody won’t be able to access those apis.

There are two main resouces defined as a part of this service 1. PrivilegedApiControl: This is created by the customer which defines which service apis are controlled and who can access it. 2. PrivilegedApiRequest: This is a request object again created by the customer operators who seek access to those privileged apis. After a request is obtained based on the PrivilegedAccessControl for which the api belongs to, either it can be approved so that the requested person can execute the service apis or it will wait for the customer to approve it.

Method Summary

Modifier and Type	Method	Description
Future<ChangePrivilegedApiControlCompartmentResponse>	changePrivilegedApiControlCompartment(ChangePrivilegedApiControlCompartmentRequest request, AsyncHandler<ChangePrivilegedApiControlCompartmentRequest,ChangePrivilegedApiControlCompartmentResponse> handler)	Moves a PrivilegedApiControl into a different compartment within the same tenancy.
Future<CreatePrivilegedApiControlResponse>	createPrivilegedApiControl(CreatePrivilegedApiControlRequest request, AsyncHandler<CreatePrivilegedApiControlRequest,CreatePrivilegedApiControlResponse> handler)	Creates a PrivilegedApiControl.
Future<DeletePrivilegedApiControlResponse>	deletePrivilegedApiControl(DeletePrivilegedApiControlRequest request, AsyncHandler<DeletePrivilegedApiControlRequest,DeletePrivilegedApiControlResponse> handler)	Deletes a PrivilegedApiControl.
String	getEndpoint()	Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetPrivilegedApiControlResponse>	getPrivilegedApiControl(GetPrivilegedApiControlRequest request, AsyncHandler<GetPrivilegedApiControlRequest,GetPrivilegedApiControlResponse> handler)	Gets information about a PrivilegedApiControl.
Future<ListPrivilegedApiControlsResponse>	listPrivilegedApiControls(ListPrivilegedApiControlsRequest request, AsyncHandler<ListPrivilegedApiControlsRequest,ListPrivilegedApiControlsResponse> handler)	Gets a list of PrivilegedApiControls.
void	refreshClient()	Rebuilds the client from scratch.
void	setEndpoint(String endpoint)	Sets the endpoint to call (ex, https://www.example.com).
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<UpdatePrivilegedApiControlResponse>	updatePrivilegedApiControl(UpdatePrivilegedApiControlRequest request, AsyncHandler<UpdatePrivilegedApiControlRequest,UpdatePrivilegedApiControlResponse> handler)	Updates a PrivilegedApiControl.
void	useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)	Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

refreshClient

void refreshClient()

Rebuilds the client from scratch.

Useful to refresh certificates.

setEndpoint

void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:

endpoint - The endpoint of the serice.

getEndpoint

String getEndpoint()

Gets the set endpoint for REST call (ex, https://www.example.com)

setRegion

void setRegion(Region region)

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.

Parameters:

region - The region of the service.

setRegion

void setRegion(String regionId)

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.

Parameters:

regionId - The public region ID.

useRealmSpecificEndpointTemplate

void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)

Determines whether realm specific endpoint should be used or not.

Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

Parameters:

realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

changePrivilegedApiControlCompartment

Future<ChangePrivilegedApiControlCompartmentResponse> changePrivilegedApiControlCompartment(ChangePrivilegedApiControlCompartmentRequest request,
                                                                                            AsyncHandler<ChangePrivilegedApiControlCompartmentRequest,ChangePrivilegedApiControlCompartmentResponse> handler)

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.

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.

createPrivilegedApiControl

Future<CreatePrivilegedApiControlResponse> createPrivilegedApiControl(CreatePrivilegedApiControlRequest request,
                                                                      AsyncHandler<CreatePrivilegedApiControlRequest,CreatePrivilegedApiControlResponse> handler)

Creates a PrivilegedApiControl.

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.

deletePrivilegedApiControl

Future<DeletePrivilegedApiControlResponse> deletePrivilegedApiControl(DeletePrivilegedApiControlRequest request,
                                                                      AsyncHandler<DeletePrivilegedApiControlRequest,DeletePrivilegedApiControlResponse> handler)

Deletes a PrivilegedApiControl.

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.

getPrivilegedApiControl

Future<GetPrivilegedApiControlResponse> getPrivilegedApiControl(GetPrivilegedApiControlRequest request,
                                                                AsyncHandler<GetPrivilegedApiControlRequest,GetPrivilegedApiControlResponse> handler)

Gets information about a PrivilegedApiControl.

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.

listPrivilegedApiControls

Future<ListPrivilegedApiControlsResponse> listPrivilegedApiControls(ListPrivilegedApiControlsRequest request,
                                                                    AsyncHandler<ListPrivilegedApiControlsRequest,ListPrivilegedApiControlsResponse> handler)

Gets a list of PrivilegedApiControls.

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.

updatePrivilegedApiControl

Future<UpdatePrivilegedApiControlResponse> updatePrivilegedApiControl(UpdatePrivilegedApiControlRequest request,
                                                                      AsyncHandler<UpdatePrivilegedApiControlRequest,UpdatePrivilegedApiControlResponse> handler)

Updates a PrivilegedApiControl.

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.