Class AnnouncementsPreferencesClient

Service client instance for AnnouncementsPreferences.

Inheritance

object

ClientBase

RegionalClientBase

AnnouncementsPreferencesClient

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

Assembly: OCI.DotNetSDK.Announcementsservice.dll

Syntax

public class AnnouncementsPreferencesClient : RegionalClientBase, IDisposable

Constructors

AnnouncementsPreferencesClient(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 AnnouncementsPreferencesClient(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 AnnouncementsPreferencesPaginators Paginators { get; }

Property Value

Type	Description
AnnouncementsPreferencesPaginators

Methods

CreateAnnouncementsPreference(CreateAnnouncementsPreferenceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a request that specifies preferences for the tenancy regarding receiving announcements by email. <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<CreateAnnouncementsPreferenceResponse> CreateAnnouncementsPreference(CreateAnnouncementsPreferenceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetAnnouncementsPreference(GetAnnouncementsPreferenceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the current preferences of the tenancy regarding receiving announcements by email. <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<GetAnnouncementsPreferenceResponse> GetAnnouncementsPreference(GetAnnouncementsPreferenceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListAnnouncementsPreferences(ListAnnouncementsPreferencesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the current preferences of the tenancy regarding receiving announcements by email. <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<ListAnnouncementsPreferencesResponse> ListAnnouncementsPreferences(ListAnnouncementsPreferencesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateAnnouncementsPreference(UpdateAnnouncementsPreferenceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the preferences of the tenancy regarding receiving announcements by email. <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<UpdateAnnouncementsPreferenceResponse> UpdateAnnouncementsPreference(UpdateAnnouncementsPreferenceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

Implements

IDisposable