Class PrivateServiceAccessClient

Service client instance for PrivateServiceAccess.

Inheritance

object

ClientBase

RegionalClientBase

PrivateServiceAccessClient

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

Assembly: OCI.DotNetSDK.Psa.dll

Syntax

public class PrivateServiceAccessClient : RegionalClientBase, IDisposable

Constructors

PrivateServiceAccessClient(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 PrivateServiceAccessClient(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 PrivateServiceAccessPaginators Paginators { get; }

Property Value

Type	Description
PrivateServiceAccessPaginators

Waiters

Declaration

public PrivateServiceAccessWaiters Waiters { get; }

Property Value

Type	Description
PrivateServiceAccessWaiters

Methods

CancelPsaWorkRequest(CancelPsaWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Cancels a PrivateServiceAccess work request.

Declaration

public Task<CancelPsaWorkRequestResponse> CancelPsaWorkRequest(CancelPsaWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ChangePrivateServiceAccessCompartment(ChangePrivateServiceAccessCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a PrivateServiceAccess into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration

public Task<ChangePrivateServiceAccessCompartmentResponse> ChangePrivateServiceAccessCompartment(ChangePrivateServiceAccessCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CreatePrivateServiceAccess(CreatePrivateServiceAccessRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a private service access in the specified subnet (in the consumer's VCN) and the specified compartment for a particular service.

Declaration

public Task<CreatePrivateServiceAccessResponse> CreatePrivateServiceAccess(CreatePrivateServiceAccessRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeletePrivateServiceAccess(DeletePrivateServiceAccessRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a PrivateServiceAccess.

Declaration

public Task<DeletePrivateServiceAccessResponse> DeletePrivateServiceAccess(DeletePrivateServiceAccessRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetPrivateServiceAccess(GetPrivateServiceAccessRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets information about a PrivateServiceAccess.

Declaration

public Task<GetPrivateServiceAccessResponse> GetPrivateServiceAccess(GetPrivateServiceAccessRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetPsaWorkRequest(GetPsaWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the details of a PrivateServiceAccess work request.

Declaration

public Task<GetPsaWorkRequestResponse> GetPsaWorkRequest(GetPsaWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListPrivateServiceAccesses(ListPrivateServiceAccessesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List the private service accesses in the specified compartment. You can optionally filter the list by specifying the OCID of a subnet in the cunsumer's VCN.

Declaration

public Task<ListPrivateServiceAccessesResponse> ListPrivateServiceAccesses(ListPrivateServiceAccessesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListPsaServices(ListPsaServicesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

List the OCI services available for Private Service Access catalog in the region, sorted by service name.

Declaration

public Task<ListPsaServicesResponse> ListPsaServices(ListPsaServicesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListPsaWorkRequestErrors(ListPsaWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the errors for a PrivateServiceAccess work request.

Declaration

public Task<ListPsaWorkRequestErrorsResponse> ListPsaWorkRequestErrors(ListPsaWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListPsaWorkRequestLogs(ListPsaWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the logs for a PrivateServiceAccess work request.

Declaration

public Task<ListPsaWorkRequestLogsResponse> ListPsaWorkRequestLogs(ListPsaWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListPsaWorkRequests(ListPsaWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the PrivateServiceAccess work requests in a compartment.

Declaration

public Task<ListPsaWorkRequestsResponse> ListPsaWorkRequests(ListPsaWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdatePrivateServiceAccess(UpdatePrivateServiceAccessRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a PrivateServiceAccess.

Declaration

public Task<UpdatePrivateServiceAccessResponse> UpdatePrivateServiceAccess(UpdatePrivateServiceAccessRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

Implements

IDisposable