Package com.oracle.bmc.ons.model

Class Subscription

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20181201")
public final class Subscription
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    The subscription’s configuration.

    For general information about subscriptions, see Notifications Overview.
    Note: Objects should always be created or deserialized using the Subscription.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the Subscription.Builder, which maintain a set of all explicitly set fields called Subscription.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getId

        public String getId()
        The OCID of the subscription.
        Returns:
        the value

      • getTopicId

        public String getTopicId()
        The OCID of the associated topic.
        Returns:
        the value

      • getProtocol

        public String getProtocol()
        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](https://docs.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#createSub).

        Returns:
        the value

      • getEndpoint

        public String getEndpoint()
        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.

        Returns:
        the value

      • getLifecycleState

        public Subscription.LifecycleState getLifecycleState()
        The lifecycle state of the subscription.

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

        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment for the subscription.
        Returns:
        the value

      • getCreatedTime

        public Long getCreatedTime()
        The time when this suscription was created.
        Returns:
        the value

      • getDeliverPolicy

        public String getDeliverPolicy()
        The delivery policy of the subscription.

        Stored as a JSON string.

        Returns:
        the value

      • getEtag

        public String getEtag()
        For optimistic concurrency control.

        See if-match.

        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        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"}

        Returns:
        the value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

        Example: {"Operations": {"CostCenter": "42"}}

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel