Class OpaInstanceClient

Service client instance for OpaInstance.

Inheritance

object

ClientBase

RegionalClientBase

OpaInstanceClient

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

Assembly: OCI.DotNetSDK.Opa.dll

Syntax

public class OpaInstanceClient : RegionalClientBase, IDisposable

Constructors

OpaInstanceClient(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 OpaInstanceClient(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 OpaInstancePaginators Paginators { get; }

Property Value

Type	Description
OpaInstancePaginators

Waiters

Declaration

public OpaInstanceWaiters Waiters { get; }

Property Value

Type	Description
OpaInstanceWaiters

Methods

CancelWorkRequest(CancelWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancel work request with the given ID.

Declaration

public Task<CancelWorkRequestResponse> CancelWorkRequest(CancelWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CancelWorkRequestRequest	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<CancelWorkRequestResponse>	A response object containing details about the completed operation

Examples

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

ChangeOpaInstanceCompartment(ChangeOpaInstanceCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a OpaInstance resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Declaration

public Task<ChangeOpaInstanceCompartmentResponse> ChangeOpaInstanceCompartment(ChangeOpaInstanceCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeOpaInstanceCompartmentRequest	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<ChangeOpaInstanceCompartmentResponse>	A response object containing details about the completed operation

Examples

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

CreateOpaInstance(CreateOpaInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new OpaInstance.

Declaration

public Task<CreateOpaInstanceResponse> CreateOpaInstance(CreateOpaInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateOpaInstanceRequest	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<CreateOpaInstanceResponse>	A response object containing details about the completed operation

Examples

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

DeleteOpaInstance(DeleteOpaInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a OpaInstance resource by identifier

Declaration

public Task<DeleteOpaInstanceResponse> DeleteOpaInstance(DeleteOpaInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteOpaInstanceRequest	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<DeleteOpaInstanceResponse>	A response object containing details about the completed operation

Examples

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

GetOpaInstance(GetOpaInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a OpaInstance by identifier

Declaration

public Task<GetOpaInstanceResponse> GetOpaInstance(GetOpaInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetOpaInstanceRequest	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<GetOpaInstanceResponse>	A response object containing details about the completed operation

Examples

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

GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the status of the work request with the given ID.

Declaration

public Task<GetWorkRequestResponse> GetWorkRequest(GetWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetWorkRequestRequest	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<GetWorkRequestResponse>	A response object containing details about the completed operation

Examples

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

ListOpaInstances(ListOpaInstancesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of OpaInstances.

Declaration

public Task<ListOpaInstancesResponse> ListOpaInstances(ListOpaInstancesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListOpaInstancesRequest	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<ListOpaInstancesResponse>	A response object containing details about the completed operation

Examples

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

ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Return a (paginated) list of errors for a given work request.

Declaration

public Task<ListWorkRequestErrorsResponse> ListWorkRequestErrors(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkRequestErrorsRequest	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<ListWorkRequestErrorsResponse>	A response object containing details about the completed operation

Examples

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

ListWorkRequestLogs(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Return a (paginated) list of logs for a given work request.

Declaration

public Task<ListWorkRequestLogsResponse> ListWorkRequestLogs(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkRequestLogsRequest	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<ListWorkRequestLogsResponse>	A response object containing details about the completed operation

Examples

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

ListWorkRequests(ListWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the work requests in a compartment.

Declaration

public Task<ListWorkRequestsResponse> ListWorkRequests(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkRequestsRequest	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<ListWorkRequestsResponse>	A response object containing details about the completed operation

Examples

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

StartOpaInstance(StartOpaInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Start an OPA instance that was previously in an INACTIVE state

Declaration

public Task<StartOpaInstanceResponse> StartOpaInstance(StartOpaInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
StartOpaInstanceRequest	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<StartOpaInstanceResponse>	A response object containing details about the completed operation

Examples

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

StopOpaInstance(StopOpaInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Stop an OPA instance that was previously in an ACTIVE state

Declaration

public Task<StopOpaInstanceResponse> StopOpaInstance(StopOpaInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
StopOpaInstanceRequest	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<StopOpaInstanceResponse>	A response object containing details about the completed operation

Examples

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

UpdateOpaInstance(UpdateOpaInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the OpaInstance

Declaration

public Task<UpdateOpaInstanceResponse> UpdateOpaInstance(UpdateOpaInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateOpaInstanceRequest	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<UpdateOpaInstanceResponse>	A response object containing details about the completed operation

Examples

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

Implements

IDisposable