Class OperatorControlClient

Service client instance for OperatorControl.

Inheritance

object

ClientBase

RegionalClientBase

OperatorControlClient

Implements

IDisposable

Inherited Members

RegionalClientBase.logger

RegionalClientBase.SetRegion(Region)

RegionalClientBase.SetRegion(string)

RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)

RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)

RegionalClientBase.parseEndpointForParameters(string)

ClientBase.restClient

ClientBase.service

ClientBase.userAgent

ClientBase.Dispose()

ClientBase.Dispose(bool)

ClientBase.SetEndpoint(string)

ClientBase.GetEndpoint()

ClientBase.GetUserAgent()

ClientBase.SetRealmSpecificEndpointTemplate(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.OperatoraccesscontrolService

Assembly: OCI.DotNetSDK.Operatoraccesscontrol.dll

Syntax

public class OperatorControlClient : RegionalClientBase, IDisposable

Constructors

OperatorControlClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)

Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.

Declaration

public OperatorControlClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)

Parameters

Type	Name	Description
IBasicAuthenticationDetailsProvider	authenticationDetailsProvider	The authentication details provider. Required.
ClientConfiguration	clientConfiguration	The client configuration that contains settings to adjust REST client behaviors. Optional.
string	endpoint	The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional.

Properties

Paginators

Declaration

public OperatorControlPaginators Paginators { get; }

Property Value

Type	Description
OperatorControlPaginators

Waiters

Declaration

public OperatorControlWaiters Waiters { get; }

Property Value

Type	Description
OperatorControlWaiters

Methods

ChangeOperatorControlCompartment(ChangeOperatorControlCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves the Operator Control resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.

Declaration

public Task<ChangeOperatorControlCompartmentResponse> ChangeOperatorControlCompartment(ChangeOperatorControlCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeOperatorControlCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeOperatorControlCompartmentResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ChangeOperatorControlCompartment API.

CreateOperatorControl(CreateOperatorControlRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates an Operator Control.

Declaration

public Task<CreateOperatorControlResponse> CreateOperatorControl(CreateOperatorControlRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateOperatorControlRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateOperatorControlResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use CreateOperatorControl API.

DeleteOperatorControl(DeleteOperatorControlRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes an Operator Control. You cannot delete an Operator Control if it is assigned to govern any target resource currently or in the future. In that case, first, delete all of the current and future assignments before deleting the Operator Control. An Operator Control that was previously assigned to a target resource is marked as DELETED following a successful deletion. However, it is not completely deleted from the system. This is to ensure auditing information for the accesses done under the Operator Control is preserved for future needs. The system purges the deleted Operator Control only when all of the audit data associated with the Operator Control are also deleted. Therefore, you cannot reuse the name of the deleted Operator Control until the system purges the Operator Control.

Declaration

public Task<DeleteOperatorControlResponse> DeleteOperatorControl(DeleteOperatorControlRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteOperatorControlRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteOperatorControlResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use DeleteOperatorControl API.

GetOperatorControl(GetOperatorControlRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the Operator Control associated with the specified Operator Control ID.

Declaration

public Task<GetOperatorControlResponse> GetOperatorControl(GetOperatorControlRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetOperatorControlRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetOperatorControlResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use GetOperatorControl API.

ListOperatorControls(ListOperatorControlsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the operator controls in the compartment.

Declaration

public Task<ListOperatorControlsResponse> ListOperatorControls(ListOperatorControlsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListOperatorControlsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListOperatorControlsResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use ListOperatorControls API.

UpdateOperatorControl(UpdateOperatorControlRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Modifies the existing OperatorControl for a given operator control id except the operator control id.

Declaration

public Task<UpdateOperatorControlResponse> UpdateOperatorControl(UpdateOperatorControlRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateOperatorControlRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateOperatorControlResponse>	A response object containing details about the completed operation

Examples

Click here to see an example of how to use UpdateOperatorControl API.

Implements

IDisposable