@Generated(value="OracleSDKGenerator", comments="API Version: 20220126") public interface Lockbox 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.
This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.
Modifier and Type | Method and Description |
---|---|
CancelWorkRequestResponse |
cancelWorkRequest(CancelWorkRequestRequest request)
Cancels the work request with the given ID.
|
ChangeApprovalTemplateCompartmentResponse |
changeApprovalTemplateCompartment(ChangeApprovalTemplateCompartmentRequest request)
Moves an ApprovalTemplate resource from one compartment identifier to another.
|
ChangeLockboxCompartmentResponse |
changeLockboxCompartment(ChangeLockboxCompartmentRequest request)
Moves a Lockbox resource from one compartment identifier to another.
|
CreateAccessRequestResponse |
createAccessRequest(CreateAccessRequestRequest request)
Creates a new access request.
|
CreateApprovalTemplateResponse |
createApprovalTemplate(CreateApprovalTemplateRequest request)
Creates a new approval template.
|
CreateLockboxResponse |
createLockbox(CreateLockboxRequest request)
Creates a new Lockbox.
|
DeleteApprovalTemplateResponse |
deleteApprovalTemplate(DeleteApprovalTemplateRequest request)
Deletes an ApprovalTemplate resource by identifier
|
DeleteLockboxResponse |
deleteLockbox(DeleteLockboxRequest request)
Deletes a Lockbox resource by identifier
|
ExportAccessRequestsResponse |
exportAccessRequests(ExportAccessRequestsRequest request)
Exports a list of AccessRequestSummary objects within a compartment and during a specified
time range in text format.
|
GetAccessMaterialsResponse |
getAccessMaterials(GetAccessMaterialsRequest request)
Retrieves the access credential/material associated with the access request.
|
GetAccessRequestResponse |
getAccessRequest(GetAccessRequestRequest request)
Retrieves an access request identified by the access request ID.
|
GetAccessRequestInternalResponse |
getAccessRequestInternal(GetAccessRequestInternalRequest request)
Retrieves an access request identified by the access request ID for internal use.
|
GetApprovalTemplateResponse |
getApprovalTemplate(GetApprovalTemplateRequest request)
Retrieves an approval template identified by the approval template ID.
|
String |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
GetLockboxResponse |
getLockbox(GetLockboxRequest request)
Gets a Lockbox by identifier
|
LockboxPaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may
return multiple pages of data.
|
LockboxWaiters |
getWaiters()
Gets the pre-configured waiters available for resources for this service.
|
GetWorkRequestResponse |
getWorkRequest(GetWorkRequestRequest request)
Gets details of the work request with the given ID.
|
HandleAccessRequestResponse |
handleAccessRequest(HandleAccessRequestRequest request)
Handle the AccessRequest
|
ListAccessRequestsResponse |
listAccessRequests(ListAccessRequestsRequest request)
Retrieves a list of AccessRequestSummary objects in a compartment.
|
ListApprovalTemplatesResponse |
listApprovalTemplates(ListApprovalTemplatesRequest request)
Retrieves a list of ApprovalTemplateSummary objects in a compartment.
|
ListLockboxesResponse |
listLockboxes(ListLockboxesRequest request)
Returns a list of Lockboxes.
|
ListWorkRequestErrorsResponse |
listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Returns a (paginated) list of errors for the work request with the given ID.
|
ListWorkRequestLogsResponse |
listWorkRequestLogs(ListWorkRequestLogsRequest request)
Returns a (paginated) list of logs for the work request with the given ID.
|
ListWorkRequestsResponse |
listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests in a compartment.
|
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’).
|
UpdateApprovalTemplateResponse |
updateApprovalTemplate(UpdateApprovalTemplateRequest request)
Updates the ApprovalTemplate
|
UpdateLockboxResponse |
updateLockbox(UpdateLockboxRequest request)
Updates the Lockbox
|
void |
useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not.
|
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 service.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
templateCancelWorkRequestResponse cancelWorkRequest(CancelWorkRequestRequest request)
Cancels the work request with the given ID.
request
- The request object containing the details to sendBmcException
- 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 CancelWorkRequest API.
ChangeApprovalTemplateCompartmentResponse changeApprovalTemplateCompartment(ChangeApprovalTemplateCompartmentRequest request)
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 sendBmcException
- 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 ChangeApprovalTemplateCompartment API.
ChangeLockboxCompartmentResponse changeLockboxCompartment(ChangeLockboxCompartmentRequest request)
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 sendBmcException
- 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 ChangeLockboxCompartment API.
CreateAccessRequestResponse createAccessRequest(CreateAccessRequestRequest request)
Creates a new access request.
request
- The request object containing the details to sendBmcException
- 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 CreateAccessRequest API.
CreateApprovalTemplateResponse createApprovalTemplate(CreateApprovalTemplateRequest request)
Creates a new approval template.
request
- The request object containing the details to sendBmcException
- 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 CreateApprovalTemplate API.
CreateLockboxResponse createLockbox(CreateLockboxRequest request)
Creates a new Lockbox.
request
- The request object containing the details to sendBmcException
- 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 CreateLockbox API.
DeleteApprovalTemplateResponse deleteApprovalTemplate(DeleteApprovalTemplateRequest request)
Deletes an ApprovalTemplate resource by identifier
request
- The request object containing the details to sendBmcException
- 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 DeleteApprovalTemplate API.
DeleteLockboxResponse deleteLockbox(DeleteLockboxRequest request)
Deletes a Lockbox resource by identifier
request
- The request object containing the details to sendBmcException
- 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 DeleteLockbox API.
ExportAccessRequestsResponse exportAccessRequests(ExportAccessRequestsRequest request)
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 sendBmcException
- 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 ExportAccessRequests API.
GetAccessMaterialsResponse getAccessMaterials(GetAccessMaterialsRequest request)
Retrieves the access credential/material associated with the access request.
request
- The request object containing the details to sendBmcException
- 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 GetAccessMaterials API.
GetAccessRequestResponse getAccessRequest(GetAccessRequestRequest request)
Retrieves an access request identified by the access request ID.
request
- The request object containing the details to sendBmcException
- 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.
GetAccessRequestInternalResponse getAccessRequestInternal(GetAccessRequestInternalRequest request)
Retrieves an access request identified by the access request ID for internal use.
request
- The request object containing the details to sendBmcException
- 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 GetAccessRequestInternal API.
GetApprovalTemplateResponse getApprovalTemplate(GetApprovalTemplateRequest request)
Retrieves an approval template identified by the approval template ID.
request
- The request object containing the details to sendBmcException
- 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 GetApprovalTemplate API.
GetLockboxResponse getLockbox(GetLockboxRequest request)
Gets a Lockbox by identifier
request
- The request object containing the details to sendBmcException
- 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 GetLockbox API.
GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Gets details of the work request with the given ID.
request
- The request object containing the details to sendBmcException
- 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 GetWorkRequest API.
HandleAccessRequestResponse handleAccessRequest(HandleAccessRequestRequest request)
Handle the AccessRequest
request
- The request object containing the details to sendBmcException
- 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 HandleAccessRequest API.
ListAccessRequestsResponse listAccessRequests(ListAccessRequestsRequest request)
Retrieves a list of AccessRequestSummary objects in a compartment.
request
- The request object containing the details to sendBmcException
- 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.
ListApprovalTemplatesResponse listApprovalTemplates(ListApprovalTemplatesRequest request)
Retrieves a list of ApprovalTemplateSummary objects in a compartment.
request
- The request object containing the details to sendBmcException
- 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 ListApprovalTemplates API.
ListLockboxesResponse listLockboxes(ListLockboxesRequest request)
Returns a list of Lockboxes.
request
- The request object containing the details to sendBmcException
- 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 ListLockboxes API.
ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Returns a (paginated) list of errors for the work request with the given ID.
request
- The request object containing the details to sendBmcException
- 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 ListWorkRequestErrors API.
ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Returns a (paginated) list of logs for the work request with the given ID.
request
- The request object containing the details to sendBmcException
- 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 ListWorkRequestLogs API.
ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests in a compartment.
request
- The request object containing the details to sendBmcException
- 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 ListWorkRequests API.
UpdateApprovalTemplateResponse updateApprovalTemplate(UpdateApprovalTemplateRequest request)
Updates the ApprovalTemplate
request
- The request object containing the details to sendBmcException
- 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 UpdateApprovalTemplate API.
UpdateLockboxResponse updateLockbox(UpdateLockboxRequest request)
Updates the Lockbox
request
- The request object containing the details to sendBmcException
- 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 UpdateLockbox API.
LockboxWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
LockboxPaginators 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.
Copyright © 2016–2024. All rights reserved.