Class ZprClient

Service client instance for Zpr.

Inheritance

object

ClientBase

RegionalClientBase

ZprClient

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

Assembly: OCI.DotNetSDK.Zpr.dll

Syntax

public class ZprClient : RegionalClientBase, IDisposable

Constructors

ZprClient(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 ZprClient(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 ZprPaginators Paginators { get; }

Property Value

Type	Description
ZprPaginators

Waiters

Declaration

public ZprWaiters Waiters { get; }

Property Value

Type	Description
ZprWaiters

Methods

CreateConfiguration(CreateConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Initiates the process to onboard ZPR in a root compartment (the root compartment is the tenancy). It creates an object of ZPR configuration as part of onboarding.

Declaration

public Task<CreateConfigurationResponse> CreateConfiguration(CreateConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CreateZprPolicy(CreateZprPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a ZprPolicy.

Declaration

public Task<CreateZprPolicyResponse> CreateZprPolicy(CreateZprPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteZprPolicy(DeleteZprPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a ZprPolicy.

Declaration

public Task<DeleteZprPolicyResponse> DeleteZprPolicy(DeleteZprPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetConfiguration(GetConfigurationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves the ZPR configuration details for the root compartment (the root compartment is the tenancy). Returns ZPR configuration for root compartment (the root compartment is the tenancy).

Declaration

public Task<GetConfigurationResponse> GetConfiguration(GetConfigurationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetZprConfigurationWorkRequest(GetZprConfigurationWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of a work request.

Declaration

public Task<GetZprConfigurationWorkRequestResponse> GetZprConfigurationWorkRequest(GetZprConfigurationWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetZprPolicy(GetZprPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about a ZprPolicy.

Declaration

public Task<GetZprPolicyResponse> GetZprPolicy(GetZprPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetZprPolicyWorkRequest(GetZprPolicyWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of a work request.

Declaration

public Task<GetZprPolicyWorkRequestResponse> GetZprPolicyWorkRequest(GetZprPolicyWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListZprConfigurationWorkRequestErrors(ListZprConfigurationWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the errors for a work request.

Declaration

public Task<ListZprConfigurationWorkRequestErrorsResponse> ListZprConfigurationWorkRequestErrors(ListZprConfigurationWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListZprConfigurationWorkRequestLogs(ListZprConfigurationWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the logs for a work request.

Declaration

public Task<ListZprConfigurationWorkRequestLogsResponse> ListZprConfigurationWorkRequestLogs(ListZprConfigurationWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListZprConfigurationWorkRequests(ListZprConfigurationWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the work requests in a compartment.

Declaration

public Task<ListZprConfigurationWorkRequestsResponse> ListZprConfigurationWorkRequests(ListZprConfigurationWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListZprPolicies(ListZprPoliciesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of ZprPolicies.

Declaration

public Task<ListZprPoliciesResponse> ListZprPolicies(ListZprPoliciesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListZprPolicyWorkRequestErrors(ListZprPolicyWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the errors for a work request.

Declaration

public Task<ListZprPolicyWorkRequestErrorsResponse> ListZprPolicyWorkRequestErrors(ListZprPolicyWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListZprPolicyWorkRequestLogs(ListZprPolicyWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the logs for a work request.

Declaration

public Task<ListZprPolicyWorkRequestLogsResponse> ListZprPolicyWorkRequestLogs(ListZprPolicyWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListZprPolicyWorkRequests(ListZprPolicyWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the work requests in a compartment.

Declaration

public Task<ListZprPolicyWorkRequestsResponse> ListZprPolicyWorkRequests(ListZprPolicyWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateZprPolicy(UpdateZprPolicyRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a specific ZprPolicy. If updating on statements, the entire list of policy statements is required, which will replace the existing policy statements associated with the policy ID.

Declaration

public Task<UpdateZprPolicyResponse> UpdateZprPolicy(UpdateZprPolicyRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

Implements

IDisposable