com.oracle.bmc.operatoraccesscontrol

Interface AccessRequests

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AccessRequestsClient

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

Operator Access Control enables you to control the time duration and the actions an Oracle operator can perform on your Exadata Cloud@Customer infrastructure. Using logging service, you can view a near real-time audit report of all actions performed by an Oracle operator.

Use the table of contents and search tool to explore the OperatorAccessControl API.

This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

Modifier and Type	Method and Description
ApproveAccessRequestResponse	approveAccessRequest(ApproveAccessRequestRequest request) Approves an access request.
GetAccessRequestResponse	getAccessRequest(GetAccessRequestRequest request) Gets details of an access request.
GetAuditLogReportResponse	getAuditLogReport(GetAuditLogReportRequest request) Gets the Audit Log Report for the given access requestId.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
AccessRequestsPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
AccessRequestsWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
InteractionRequestResponse	interactionRequest(InteractionRequestRequest request) Posts query for additional information for the given access request.
ListAccessRequestHistoriesResponse	listAccessRequestHistories(ListAccessRequestHistoriesRequest request) Returns a history of all status associated with the accessRequestId.
ListAccessRequestsResponse	listAccessRequests(ListAccessRequestsRequest request) Lists all access requests in the compartment.
ListInteractionsResponse	listInteractions(ListInteractionsRequest request) Lists the MoreInformation interaction between customer and operators.
void	refreshClient() Rebuilds the client from scratch.
RejectAccessRequestResponse	rejectAccessRequest(RejectAccessRequestRequest request) Rejects an access request.
ReviewAccessRequestResponse	reviewAccessRequest(ReviewAccessRequestRequest request) Reviews the access request.
RevokeAccessRequestResponse	revokeAccessRequest(RevokeAccessRequestRequest request) Revokes an already approved access request.
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’).
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 service.

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

approveAccessRequest

ApproveAccessRequestResponse approveAccessRequest(ApproveAccessRequestRequest request)

Approves an access request.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ApproveAccessRequest API.

getAccessRequest

GetAccessRequestResponse getAccessRequest(GetAccessRequestRequest request)

Gets details of an access request.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetAccessRequest API.

getAuditLogReport

GetAuditLogReportResponse getAuditLogReport(GetAuditLogReportRequest request)

Gets the Audit Log Report for the given access requestId.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetAuditLogReport API.

interactionRequest

InteractionRequestResponse interactionRequest(InteractionRequestRequest request)

Posts query for additional information for the given access request.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use InteractionRequest API.

listAccessRequestHistories

ListAccessRequestHistoriesResponse listAccessRequestHistories(ListAccessRequestHistoriesRequest request)

Returns a history of all status associated with the accessRequestId.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListAccessRequestHistories API.

listAccessRequests

ListAccessRequestsResponse listAccessRequests(ListAccessRequestsRequest request)

Lists all access requests in the compartment.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListAccessRequests API.

listInteractions

ListInteractionsResponse listInteractions(ListInteractionsRequest request)

Lists the MoreInformation interaction between customer and operators.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListInteractions API.

rejectAccessRequest

RejectAccessRequestResponse rejectAccessRequest(RejectAccessRequestRequest request)

Rejects an access request.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use RejectAccessRequest API.

reviewAccessRequest

ReviewAccessRequestResponse reviewAccessRequest(ReviewAccessRequestRequest request)

Reviews the access request.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ReviewAccessRequest API.

revokeAccessRequest

RevokeAccessRequestResponse revokeAccessRequest(RevokeAccessRequestRequest request)

Revokes an already approved access request.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use RevokeAccessRequest API.

getWaiters

AccessRequestsWaiters getWaiters()

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

Returns:

The service waiters.

getPaginators

AccessRequestsPaginators getPaginators()

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.

Returns:

The service paginators.