Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace SubscriptionSummary

The subscription's configuration summary.

Enumerations

Properties

Functions

Properties

compartmentId

compartmentId: string

The OCID of the compartment for the subscription.

Optional createdTime

createdTime: undefined | number

The time when this suscription was created. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}

Optional deliveryPolicy

deliveryPolicy: model.DeliveryPolicy

endpoint

endpoint: string

A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the {@code EMAIL} protocol, or a URL for a subscription that uses an HTTP-based protocol.

Optional etag

etag: undefined | string

For optimistic concurrency control. See {@code if-match}.

Optional freeformTags

freeformTags: undefined | object

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: {@code {\"Department\": \"Finance\"}}

id

id: string

The OCID of the subscription.

lifecycleState

lifecycleState: LifecycleState

The lifecycle state of the subscription. The status of a new subscription is PENDING; when confirmed, the subscription status changes to ACTIVE.

protocol

protocol: string

The protocol used for the subscription.

Allowed values: * {@code CUSTOM_HTTPS} * {@code EMAIL} * {@code HTTPS} (deprecated; for PagerDuty endpoints, use {@code PAGERDUTY}) * {@code ORACLE_FUNCTIONS} * {@code PAGERDUTY} * {@code SLACK} * {@code SMS}

For information about subscription protocols, see [To create a subscription](https://docs.cloud.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#createSub).

topicId

topicId: string

The OCID of the associated topic.

Functions

getDeserializedJsonObj

getJsonObj