Class NotificationDataPlaneClient

Service client instance for NotificationDataPlane.

Inheritance

object

ClientBase

RegionalClientBase

NotificationDataPlaneClient

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

Assembly: OCI.DotNetSDK.Ons.dll

Syntax

public class NotificationDataPlaneClient : RegionalClientBase, IDisposable

Constructors

NotificationDataPlaneClient(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 NotificationDataPlaneClient(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 NotificationDataPlanePaginators Paginators { get; }

Property Value

Type	Description
NotificationDataPlanePaginators

Waiters

Declaration

public NotificationDataPlaneWaiters Waiters { get; }

Property Value

Type	Description
NotificationDataPlaneWaiters

Methods

ChangeSubscriptionCompartment(ChangeSubscriptionCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a subscription into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment. Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.

Declaration

public Task<ChangeSubscriptionCompartmentResponse> ChangeSubscriptionCompartment(ChangeSubscriptionCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CreateSubscription(CreateSubscriptionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a subscription for the specified topic and sends a subscription confirmation URL to the endpoint. The subscription remains in "Pending" status until it has been confirmed. For information about confirming subscriptions, see To confirm a subscription. Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.

Declaration

public Task<CreateSubscriptionResponse> CreateSubscription(CreateSubscriptionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteSubscription(DeleteSubscriptionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified subscription. Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.

Declaration

public Task<DeleteSubscriptionResponse> DeleteSubscription(DeleteSubscriptionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetConfirmSubscription(GetConfirmSubscriptionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the confirmation details for the specified subscription. Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.

Declaration

public Task<GetConfirmSubscriptionResponse> GetConfirmSubscription(GetConfirmSubscriptionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetSubscription(GetSubscriptionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified subscription's configuration information. Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.

Declaration

public Task<GetSubscriptionResponse> GetSubscription(GetSubscriptionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetUnsubscription(GetUnsubscriptionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Unsubscribes the subscription from the topic. Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.

Declaration

public Task<GetUnsubscriptionResponse> GetUnsubscription(GetUnsubscriptionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListSubscriptions(ListSubscriptionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the subscriptions in the specified compartment or topic. Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.

Declaration

public Task<ListSubscriptionsResponse> ListSubscriptions(ListSubscriptionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

PublishMessage(PublishMessageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Publishes a message to the specified topic. The topic endpoint is required for this operation. To get the topic endpoint, use {@link #getTopic(GetTopicRequest) getTopic} and review the apiEndpoint value in the response ({@link NotificationTopic}). Limits information follows. Message size limit per request: 64KB. Message delivery rate limit per endpoint: 60 messages per minute for HTTP-based protocols, 10 messages per minute for the EMAIL protocol. HTTP-based protocols use URL endpoints that begin with "http:" or "https:". Transactions Per Minute (TPM) per-tenancy limit for this operation: 60 per topic. (This TPM limit represents messages per minute.) For more information about publishing messages, see Publishing Messages. For steps to request a limit increase, see Requesting a Service Limit Increase.

Declaration

public Task<PublishMessageResponse> PublishMessage(PublishMessageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ResendSubscriptionConfirmation(ResendSubscriptionConfirmationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Resends the confirmation details for the specified subscription. Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.

Declaration

public Task<ResendSubscriptionConfirmationResponse> ResendSubscriptionConfirmation(ResendSubscriptionConfirmationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateSubscription(UpdateSubscriptionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the specified subscription's configuration. Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.

Declaration

public Task<UpdateSubscriptionResponse> UpdateSubscription(UpdateSubscriptionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

Implements

IDisposable