Class AnnouncementSubscription

A subscription with the Announcements service to receive selected announcements in the format and delivery mechanisms supported by a corresponding topic endpoint configured in the Oracle Cloud Infrastructure Notifications service.

Inheritance

object

AnnouncementSubscription

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.AnnouncementsService.Models

Assembly: OCI.DotNetSDK.Announcementsservice.dll

Syntax

public class AnnouncementSubscription

Properties

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment that contains the announcement subscription.

Remarks

Required

DefinedTags

Declaration

[Required(ErrorMessage = "DefinedTags is required.")]
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}

Remarks

Required

Description

Declaration

[JsonProperty(PropertyName = "description")]
public string Description { get; set; }

Property Value

Type	Description
string	A description of the announcement subscription. Avoid entering confidential information.

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A user-friendly name for the announcement subscription. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Remarks

Required

FilterGroups

Declaration

[JsonProperty(PropertyName = "filterGroups")]
public Dictionary<string, FilterGroup> FilterGroups { get; set; }

Property Value

Type	Description
Dictionary<string, FilterGroup>	A list of filter groups for the announcement subscription. A filter group is a combination of multiple filters applied to announcements for matching purposes.

FreeformTags

Declaration

[Required(ErrorMessage = "FreeformTags is required.")]
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Remarks

Required

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the announcement subscription.

Remarks

Required

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

Type	Description
string	A message describing the current lifecycle state in more detail. For example, details might provide required or recommended actions for a resource in a Failed state.

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public AnnouncementSubscription.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
AnnouncementSubscription.LifecycleStateEnum?	The current lifecycle state of the announcement subscription.

Remarks

Required

OnsTopicId

Declaration

[Required(ErrorMessage = "OnsTopicId is required.")]
[JsonProperty(PropertyName = "onsTopicId")]
public string OnsTopicId { get; set; }

Property Value

Type	Description
string	The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription.

Remarks

Required

PreferredLanguage

Declaration

[JsonProperty(PropertyName = "preferredLanguage")]
public string PreferredLanguage { get; set; }

Property Value

Type	Description
string	(For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements. Specify the preference with a value that uses the x-obmcs-human-language format. For example fr-FR.

PreferredTimeZone

Declaration

[JsonProperty(PropertyName = "preferredTimeZone")]
public string PreferredTimeZone { get; set; }

Property Value

Type	Description
string	The time zone in which the user prefers to receive announcements. Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles

SystemTags

Declaration

[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time that the announcement subscription was created, expressed in RFC 3339 timestamp format.

Remarks

Required

TimeUpdated

Declaration

[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The date and time that the announcement subscription was updated, expressed in RFC 3339 timestamp format.