com.oracle.bmc.operatoraccesscontrol

Interface OperatorControlAssignment

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

OperatorControlAssignmentClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200630")
public interface OperatorControlAssignment
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
ChangeOperatorControlAssignmentCompartmentResponse	changeOperatorControlAssignmentCompartment(ChangeOperatorControlAssignmentCompartmentRequest request) Changes the compartment of the specified Operator Control assignment ID.
CreateOperatorControlAssignmentResponse	createOperatorControlAssignment(CreateOperatorControlAssignmentRequest request) Creates an Operator Control Assignment resource.
DeleteOperatorControlAssignmentResponse	deleteOperatorControlAssignment(DeleteOperatorControlAssignmentRequest request) Deletes the specified Operator Control Assignment.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
GetOperatorControlAssignmentResponse	getOperatorControlAssignment(GetOperatorControlAssignmentRequest request) Gets the details of an Operator Control Assignment of the specified ID.
OperatorControlAssignmentPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
OperatorControlAssignmentWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListOperatorControlAssignmentsResponse	listOperatorControlAssignments(ListOperatorControlAssignmentsRequest request) Lists all Operator Control Assignments.
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’).
UpdateOperatorControlAssignmentResponse	updateOperatorControlAssignment(UpdateOperatorControlAssignmentRequest request) Modifies the existing Operator Control assignment of the specified Operator Control assignment ID.

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.

changeOperatorControlAssignmentCompartment

ChangeOperatorControlAssignmentCompartmentResponse changeOperatorControlAssignmentCompartment(ChangeOperatorControlAssignmentCompartmentRequest request)

Changes the compartment of the specified Operator Control assignment ID.

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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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 ChangeOperatorControlAssignmentCompartment API.

createOperatorControlAssignment

CreateOperatorControlAssignmentResponse createOperatorControlAssignment(CreateOperatorControlAssignmentRequest request)

Creates an Operator Control Assignment resource. In effect, this brings the target resource under the governance of the Operator Control for specified time duration.

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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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 CreateOperatorControlAssignment API.

deleteOperatorControlAssignment

DeleteOperatorControlAssignmentResponse deleteOperatorControlAssignment(DeleteOperatorControlAssignmentRequest request)

Deletes the specified Operator Control Assignment. This has the effect of unassigning the specific Operator Control from the target resource.

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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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 DeleteOperatorControlAssignment API.

getOperatorControlAssignment

GetOperatorControlAssignmentResponse getOperatorControlAssignment(GetOperatorControlAssignmentRequest request)

Gets the details of an Operator Control Assignment of the specified ID.

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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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 GetOperatorControlAssignment API.

listOperatorControlAssignments

ListOperatorControlAssignmentsResponse listOperatorControlAssignments(ListOperatorControlAssignmentsRequest request)

Lists all Operator Control Assignments.

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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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 ListOperatorControlAssignments API.

updateOperatorControlAssignment

UpdateOperatorControlAssignmentResponse updateOperatorControlAssignment(UpdateOperatorControlAssignmentRequest request)

Modifies the existing Operator Control assignment of the specified Operator Control assignment ID. Modifying the assignment does not change the Operator Control assignment ID.

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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. 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 UpdateOperatorControlAssignment API.

getWaiters

OperatorControlAssignmentWaiters getWaiters()

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

Returns:

The service waiters.

getPaginators

OperatorControlAssignmentPaginators 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.