@Generated(value="OracleSDKGenerator", comments="API Version: 20181201") public final class SubscriptionSummary extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
The subscription’s configuration summary.
Note: Objects should always be created or deserialized using the SubscriptionSummary.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 SubscriptionSummary.Builder
, which maintain a
set of all explicitly set fields called SubscriptionSummary.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
).
Modifier and Type | Class and Description |
---|---|
static class |
SubscriptionSummary.Builder |
static class |
SubscriptionSummary.LifecycleState
The lifecycle state of the subscription.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME
Constructor and Description |
---|
SubscriptionSummary(String id,
String topicId,
String protocol,
String endpoint,
SubscriptionSummary.LifecycleState lifecycleState,
String compartmentId,
Long createdTime,
DeliveryPolicy deliveryPolicy,
String etag,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static SubscriptionSummary.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getCompartmentId()
The OCID of
the compartment for the subscription.
|
Long |
getCreatedTime()
The time when this suscription was created.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
DeliveryPolicy |
getDeliveryPolicy() |
String |
getEndpoint()
A locator that corresponds to the subscription protocol.
|
String |
getEtag()
For optimistic concurrency control.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
The OCID of
the subscription.
|
SubscriptionSummary.LifecycleState |
getLifecycleState()
The lifecycle state of the subscription.
|
String |
getProtocol()
The protocol used for the subscription.
|
String |
getTopicId()
The OCID of
the associated topic.
|
int |
hashCode() |
SubscriptionSummary.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet
@Deprecated @ConstructorProperties(value={"id","topicId","protocol","endpoint","lifecycleState","compartmentId","createdTime","deliveryPolicy","etag","freeformTags","definedTags"}) public SubscriptionSummary(String id, String topicId, String protocol, String endpoint, SubscriptionSummary.LifecycleState lifecycleState, String compartmentId, Long createdTime, DeliveryPolicy deliveryPolicy, String etag, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)
public static SubscriptionSummary.Builder builder()
Create a new builder.
public SubscriptionSummary.Builder toBuilder()
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.cloud.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#createSub).
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.
public SubscriptionSummary.LifecycleState getLifecycleState()
The lifecycle state of the subscription. The status of a new subscription is PENDING; when confirmed, the subscription status changes to ACTIVE.
public String getCompartmentId()
The OCID of the compartment for the subscription.
public Long getCreatedTime()
The time when this suscription was created.
public DeliveryPolicy getDeliveryPolicy()
public String getEtag()
For optimistic concurrency control. See if-match
.
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"}
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"}}
public String toString()
toString
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents
- true to include the full contents of byte arrayspublic boolean equals(Object o)
equals
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public int hashCode()
hashCode
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Copyright © 2016–2024. All rights reserved.