Class CreateSubscriptionDetails

The configuration details for creating the subscription.

Inheritance

object

CreateSubscriptionDetails

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 CreateSubscriptionDetails

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

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"}}

Endpoint

Declaration

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

Property Value

Type Description

Type	Description
string	A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the `EMAIL` protocol, or a URL for a subscription that uses an HTTP-based protocol. HTTP-based protocols use URL endpoints that begin with "http:" or "https:". A URL cannot exceed 512 characters. Avoid entering confidential information. For protocol-specific endpoint formats and steps to get or create endpoints, see To create a subscription.

string

A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the EMAIL protocol, or a URL for a subscription that uses an HTTP-based protocol. HTTP-based protocols use URL endpoints that begin with "http:" or "https:". A URL cannot exceed 512 characters. Avoid entering confidential information.
For protocol-specific endpoint formats and steps to get or create endpoints, see To create a subscription.

Remarks

Required

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"}

Metadata

Declaration

[JsonProperty(PropertyName = "metadata")]
public string Metadata { get; set; }

Property Value

Type	Description
string	Metadata for the subscription.

Protocol

Declaration

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

Property Value

Type Description

Type	Description
string	The protocol used for the subscription. Allowed values: `CUSTOM_HTTPS` `EMAIL` `HTTPS` (deprecated; for PagerDuty endpoints, use `PAGERDUTY`) `ORACLE_FUNCTIONS` `PAGERDUTY` `SLACK` `SMS` For information about subscription protocols, see To create a subscription.

string

The protocol used for the subscription.
Allowed values:

CUSTOM_HTTPS
EMAIL
HTTPS (deprecated; for PagerDuty endpoints, use PAGERDUTY)
ORACLE_FUNCTIONS
PAGERDUTY
SLACK
SMS
For information about subscription protocols, see To create a subscription.

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

Remarks

Required