@Generated(value="OracleSDKGenerator", comments="API Version: 20220126") public interface LockboxAsync extends AutoCloseable
Use the Managed Access API to approve access requests, create and manage templates, and manage resource approval settings. For more information, see Managed Access Overview.
Use the table of contents and search tool to explore the Managed Access API.
close
void refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the serice.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
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.
region
- The region of the service.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
.
regionId
- The public region ID.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”
realmSpecificEndpointTemplateEnabled
- flag to enable the use of realm specific endpoint
templateFuture<CancelWorkRequestResponse> cancelWorkRequest(CancelWorkRequestRequest request, AsyncHandler<CancelWorkRequestRequest,CancelWorkRequestResponse> handler)
Cancels the work request with the given ID.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ChangeApprovalTemplateCompartmentResponse> changeApprovalTemplateCompartment(ChangeApprovalTemplateCompartmentRequest request, AsyncHandler<ChangeApprovalTemplateCompartmentRequest,ChangeApprovalTemplateCompartmentResponse> handler)
Moves an ApprovalTemplate resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ChangeLockboxCompartmentResponse> changeLockboxCompartment(ChangeLockboxCompartmentRequest request, AsyncHandler<ChangeLockboxCompartmentRequest,ChangeLockboxCompartmentResponse> handler)
Moves a Lockbox resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateAccessRequestResponse> createAccessRequest(CreateAccessRequestRequest request, AsyncHandler<CreateAccessRequestRequest,CreateAccessRequestResponse> handler)
Creates a new access request.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateApprovalTemplateResponse> createApprovalTemplate(CreateApprovalTemplateRequest request, AsyncHandler<CreateApprovalTemplateRequest,CreateApprovalTemplateResponse> handler)
Creates a new approval template.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateLockboxResponse> createLockbox(CreateLockboxRequest request, AsyncHandler<CreateLockboxRequest,CreateLockboxResponse> handler)
Creates a new Lockbox.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteApprovalTemplateResponse> deleteApprovalTemplate(DeleteApprovalTemplateRequest request, AsyncHandler<DeleteApprovalTemplateRequest,DeleteApprovalTemplateResponse> handler)
Deletes an ApprovalTemplate resource by identifier
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteLockboxResponse> deleteLockbox(DeleteLockboxRequest request, AsyncHandler<DeleteLockboxRequest,DeleteLockboxResponse> handler)
Deletes a Lockbox resource by identifier
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ExportAccessRequestsResponse> exportAccessRequests(ExportAccessRequestsRequest request, AsyncHandler<ExportAccessRequestsRequest,ExportAccessRequestsResponse> handler)
Exports a list of AccessRequestSummary objects within a compartment and during a specified time range in text format. You can filter the results by problem severity.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetAccessMaterialsResponse> getAccessMaterials(GetAccessMaterialsRequest request, AsyncHandler<GetAccessMaterialsRequest,GetAccessMaterialsResponse> handler)
Retrieves the access credential/material associated with the access request.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetAccessRequestResponse> getAccessRequest(GetAccessRequestRequest request, AsyncHandler<GetAccessRequestRequest,GetAccessRequestResponse> handler)
Retrieves an access request identified by the access request ID.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetAccessRequestInternalResponse> getAccessRequestInternal(GetAccessRequestInternalRequest request, AsyncHandler<GetAccessRequestInternalRequest,GetAccessRequestInternalResponse> handler)
Retrieves an access request identified by the access request ID for internal use.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetApprovalTemplateResponse> getApprovalTemplate(GetApprovalTemplateRequest request, AsyncHandler<GetApprovalTemplateRequest,GetApprovalTemplateResponse> handler)
Retrieves an approval template identified by the approval template ID.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetLockboxResponse> getLockbox(GetLockboxRequest request, AsyncHandler<GetLockboxRequest,GetLockboxResponse> handler)
Gets a Lockbox by identifier
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
Gets details of the work request with the given ID.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<HandleAccessRequestResponse> handleAccessRequest(HandleAccessRequestRequest request, AsyncHandler<HandleAccessRequestRequest,HandleAccessRequestResponse> handler)
Handle the AccessRequest
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListAccessRequestsResponse> listAccessRequests(ListAccessRequestsRequest request, AsyncHandler<ListAccessRequestsRequest,ListAccessRequestsResponse> handler)
Retrieves a list of AccessRequestSummary objects in a compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListApprovalTemplatesResponse> listApprovalTemplates(ListApprovalTemplatesRequest request, AsyncHandler<ListApprovalTemplatesRequest,ListApprovalTemplatesResponse> handler)
Retrieves a list of ApprovalTemplateSummary objects in a compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListLockboxesResponse> listLockboxes(ListLockboxesRequest request, AsyncHandler<ListLockboxesRequest,ListLockboxesResponse> handler)
Returns a list of Lockboxes.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
Returns a (paginated) list of errors for the work request with the given ID.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
Returns a (paginated) list of logs for the work request with the given ID.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
Lists the work requests in a compartment.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateApprovalTemplateResponse> updateApprovalTemplate(UpdateApprovalTemplateRequest request, AsyncHandler<UpdateApprovalTemplateRequest,UpdateApprovalTemplateResponse> handler)
Updates the ApprovalTemplate
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateLockboxResponse> updateLockbox(UpdateLockboxRequest request, AsyncHandler<UpdateLockboxRequest,UpdateLockboxResponse> handler)
Updates the Lockbox
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Copyright © 2016–2024. All rights reserved.