Class NotificationControlPlaneClient
Service client instance for NotificationControlPlane.
Implements
Inherited Members
Namespace: Oci.OnsService
Assembly: OCI.DotNetSDK.Ons.dll
Syntax
public class NotificationControlPlaneClient : RegionalClientBase, IDisposable
Constructors
NotificationControlPlaneClient(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 NotificationControlPlaneClient(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 NotificationControlPlanePaginators Paginators { get; }
Property Value
Type | Description |
---|---|
NotificationControlPlanePaginators |
Methods
ChangeTopicCompartment(ChangeTopicCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a topic into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment. <br/> Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
Declaration
public Task<ChangeTopicCompartmentResponse> ChangeTopicCompartment(ChangeTopicCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeTopicCompartmentRequest | 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<ChangeTopicCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeTopicCompartment API.
CreateTopic(CreateTopicRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a topic in the specified compartment. For general information about topics, see Managing Topics and Subscriptions. <br/> For the purposes of access control, you must provide the OCID of the compartment where you want the topic to reside. For information about access control and compartments, see Overview of the IAM Service. <br/> You must specify a display name for the topic. <br/> All Oracle Cloud Infrastructure resources, including topics, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console. For more information, see Resource Identifiers. <br/> Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
Declaration
public Task<CreateTopicResponse> CreateTopic(CreateTopicRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateTopicRequest | 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<CreateTopicResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateTopic API.
DeleteTopic(DeleteTopicRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified topic. <br/> Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
Declaration
public Task<DeleteTopicResponse> DeleteTopic(DeleteTopicRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteTopicRequest | 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<DeleteTopicResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteTopic API.
GetTopic(GetTopicRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified topic's configuration information.
Declaration
public Task<GetTopicResponse> GetTopic(GetTopicRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetTopicRequest | 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<GetTopicResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetTopic API.
ListTopics(ListTopicsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists topics in the specified compartment. <br/> Transactions Per Minute (TPM) per-tenancy limit for this operation: 120.
Declaration
public Task<ListTopicsResponse> ListTopics(ListTopicsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListTopicsRequest | 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<ListTopicsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListTopics API.
UpdateTopic(UpdateTopicRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified topic's configuration. <br/> Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
Declaration
public Task<UpdateTopicResponse> UpdateTopic(UpdateTopicRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateTopicRequest | 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<UpdateTopicResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateTopic API.