Class NotificationTopicSummary

A summary of the properties that define a topic.

Inheritance

object

NotificationTopicSummary

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.OnsService.Models

Assembly: OCI.DotNetSDK.Ons.dll

Syntax

public class NotificationTopicSummary

Properties

ApiEndpoint

Declaration

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

Property Value

Type	Description
string	The endpoint for managing subscriptions or publishing messages to the topic.

Remarks

Required

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 for the topic.

Remarks

Required

DefinedTags

Declaration

[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. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}}

Description

Declaration

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

Property Value

Type	Description
string	The description of the topic.

Etag

Declaration

[JsonProperty(PropertyName = "etag")]
public string Etag { get; set; }

Property Value

Type	Description
string	For optimistic concurrency control. See `if-match`.

FreeformTags

Declaration

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

Property Value

Type	Description
Dictionary<string, string>	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

LifecycleState

Declaration

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

Property Value

Type	Description
NotificationTopicSummary.LifecycleStateEnum?	The lifecycle state of the topic.

Remarks

Required

Name

Declaration

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

Property Value

Type	Description
string	The name of the topic.

Remarks

Required

ShortTopicId

Declaration

[JsonProperty(PropertyName = "shortTopicId")]
public string ShortTopicId { get; set; }

Property Value

Type	Description
string	A unique short topic Id. This is used only for SMS subscriptions.

TimeCreated

Declaration

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

Property Value

Type	Description
DateTime?	The time the topic was created.

Remarks

Required

TopicId

Declaration

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

Property Value

Type	Description
string	The OCID of the topic.

Remarks

Required