Class AnnouncementSubscriptionClient
Service client instance for AnnouncementSubscription.
Implements
Inherited Members
Namespace: Oci.AnnouncementsService
Assembly: OCI.DotNetSDK.Announcementsservice.dll
Syntax
public class AnnouncementSubscriptionClient : RegionalClientBase, IDisposable
Constructors
AnnouncementSubscriptionClient(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 AnnouncementSubscriptionClient(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 AnnouncementSubscriptionPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
AnnouncementSubscriptionPaginators |
Waiters
Declaration
public AnnouncementSubscriptionWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
AnnouncementSubscriptionWaiters |
Methods
ChangeAnnouncementSubscriptionCompartment(ChangeAnnouncementSubscriptionCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves the specified announcement subscription from one compartment to another compartment. When provided, If-Match is checked against ETag values of the resource. <br/> This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
Declaration
public Task<ChangeAnnouncementSubscriptionCompartmentResponse> ChangeAnnouncementSubscriptionCompartment(ChangeAnnouncementSubscriptionCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeAnnouncementSubscriptionCompartmentRequest | 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<ChangeAnnouncementSubscriptionCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeAnnouncementSubscriptionCompartment API.
CreateAnnouncementSubscription(CreateAnnouncementSubscriptionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new announcement subscription. <br/> This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
Declaration
public Task<CreateAnnouncementSubscriptionResponse> CreateAnnouncementSubscription(CreateAnnouncementSubscriptionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateAnnouncementSubscriptionRequest | 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<CreateAnnouncementSubscriptionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateAnnouncementSubscription API.
CreateFilterGroup(CreateFilterGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new filter group in the specified announcement subscription. <br/> This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
Declaration
public Task<CreateFilterGroupResponse> CreateFilterGroup(CreateFilterGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateFilterGroupRequest | 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<CreateFilterGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateFilterGroup API.
DeleteAnnouncementSubscription(DeleteAnnouncementSubscriptionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified announcement subscription. <br/> This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
Declaration
public Task<DeleteAnnouncementSubscriptionResponse> DeleteAnnouncementSubscription(DeleteAnnouncementSubscriptionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteAnnouncementSubscriptionRequest | 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<DeleteAnnouncementSubscriptionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteAnnouncementSubscription API.
DeleteFilterGroup(DeleteFilterGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a filter group in the specified announcement subscription. <br/> This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
Declaration
public Task<DeleteFilterGroupResponse> DeleteFilterGroup(DeleteFilterGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteFilterGroupRequest | 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<DeleteFilterGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteFilterGroup API.
GetAnnouncementSubscription(GetAnnouncementSubscriptionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified announcement subscription. <br/> This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
Declaration
public Task<GetAnnouncementSubscriptionResponse> GetAnnouncementSubscription(GetAnnouncementSubscriptionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetAnnouncementSubscriptionRequest | 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<GetAnnouncementSubscriptionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetAnnouncementSubscription API.
ListAnnouncementSubscriptions(ListAnnouncementSubscriptionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a list of all announcement subscriptions in the specified compartment. <br/> This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
Declaration
public Task<ListAnnouncementSubscriptionsResponse> ListAnnouncementSubscriptions(ListAnnouncementSubscriptionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListAnnouncementSubscriptionsRequest | 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<ListAnnouncementSubscriptionsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListAnnouncementSubscriptions API.
UpdateAnnouncementSubscription(UpdateAnnouncementSubscriptionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified announcement subscription. <br/> This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
Declaration
public Task<UpdateAnnouncementSubscriptionResponse> UpdateAnnouncementSubscription(UpdateAnnouncementSubscriptionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateAnnouncementSubscriptionRequest | 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<UpdateAnnouncementSubscriptionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateAnnouncementSubscription API.
UpdateFilterGroup(UpdateFilterGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a filter group in the specified announcement subscription. <br/> This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.
Declaration
public Task<UpdateFilterGroupResponse> UpdateFilterGroup(UpdateFilterGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateFilterGroupRequest | 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<UpdateFilterGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateFilterGroup API.