Interface AccessRequests
- 
- All Superinterfaces:
- AutoCloseable
 - All Known Implementing Classes:
- AccessRequestsClient
 
 @Generated(value="OracleSDKGenerator", comments="API Version: 20200630") public interface AccessRequests extends AutoCloseableOperator 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 SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description ApproveAccessRequestResponseapproveAccessRequest(ApproveAccessRequestRequest request)Approves an access request.GetAccessRequestResponsegetAccessRequest(GetAccessRequestRequest request)Gets details of an access request.GetAuditLogReportResponsegetAuditLogReport(GetAuditLogReportRequest request)Gets the Audit Log Report for the given access requestId.StringgetEndpoint()Gets the set endpoint for REST call (ex, https://www.example.com)AccessRequestsPaginatorsgetPaginators()Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.AccessRequestsWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.InteractionRequestResponseinteractionRequest(InteractionRequestRequest request)Posts query for additional information for the given access request.ListAccessRequestHistoriesResponselistAccessRequestHistories(ListAccessRequestHistoriesRequest request)Returns a history of all status associated with the accessRequestId.ListAccessRequestsResponselistAccessRequests(ListAccessRequestsRequest request)Lists all access requests in the compartment.ListInteractionsResponselistInteractions(ListInteractionsRequest request)Lists the MoreInformation interaction between customer and operators.voidrefreshClient()Rebuilds the client from scratch.RejectAccessRequestResponserejectAccessRequest(RejectAccessRequestRequest request)Rejects an access request.ReviewAccessRequestResponsereviewAccessRequest(ReviewAccessRequestRequest request)Reviews the access request.RevokeAccessRequestResponserevokeAccessRequest(RevokeAccessRequestRequest request)Revokes an already approved access request.voidsetEndpoint(String endpoint)Sets the endpoint to call (ex, https://www.example.com).voidsetRegion(Region region)Sets the region to call (ex, Region.US_PHOENIX_1).voidsetRegion(String regionId)Sets the region to call (ex, ‘us-phoenix-1’).voiduseRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)Determines whether realm specific endpoint should be used or not.- 
Methods inherited from interface java.lang.AutoCloseableclose
 
- 
 
- 
- 
- 
Method Detail- 
refreshClientvoid refreshClient() Rebuilds the client from scratch.Useful to refresh certificates. 
 - 
setEndpointvoid setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).- Parameters:
- endpoint- The endpoint of the service.
 
 - 
getEndpointString getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
 - 
setRegionvoid setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).Note, this will call setEndpointafter 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.
 
 - 
setRegionvoid 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 callsetEndpoint.- Parameters:
- regionId- The public region ID.
 
 - 
useRealmSpecificEndpointTemplatevoid 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
 
 - 
approveAccessRequestApproveAccessRequestResponse 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/operatoraccesscontrol/ApproveAccessRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ApproveAccessRequest API. 
 
 - 
getAccessRequestGetAccessRequestResponse 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/operatoraccesscontrol/GetAccessRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetAccessRequest API. 
 
 - 
getAuditLogReportGetAuditLogReportResponse 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/operatoraccesscontrol/GetAuditLogReportExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetAuditLogReport API. 
 
 - 
interactionRequestInteractionRequestResponse 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/operatoraccesscontrol/InteractionRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use InteractionRequest API. 
 
 - 
listAccessRequestHistoriesListAccessRequestHistoriesResponse 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/operatoraccesscontrol/ListAccessRequestHistoriesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAccessRequestHistories API. 
 
 - 
listAccessRequestsListAccessRequestsResponse 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/operatoraccesscontrol/ListAccessRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListAccessRequests API. 
 
 - 
listInteractionsListInteractionsResponse 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/operatoraccesscontrol/ListInteractionsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListInteractions API. 
 
 - 
rejectAccessRequestRejectAccessRequestResponse 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/operatoraccesscontrol/RejectAccessRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RejectAccessRequest API. 
 
 - 
reviewAccessRequestReviewAccessRequestResponse 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/operatoraccesscontrol/ReviewAccessRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ReviewAccessRequest API. 
 
 - 
revokeAccessRequestRevokeAccessRequestResponse 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 <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/operatoraccesscontrol/RevokeAccessRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RevokeAccessRequest API. 
 
 - 
getWaitersAccessRequestsWaiters getWaiters() Gets the pre-configured waiters available for resources for this service.- Returns:
- The service waiters.
 
 - 
getPaginatorsAccessRequestsPaginators getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an Iterableinterface 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.
 
 
- 
 
-