Class AnnouncementSubscription
- java.lang.Object
-
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
- com.oracle.bmc.announcementsservice.model.AnnouncementSubscription
-
@Generated(value="OracleSDKGenerator", comments="API Version: 0.0.1") public final class AnnouncementSubscription extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelA subscription with the Announcements service to receive selected announcements in the format and delivery mechanisms supported by a corresponding topic endpoint configured in the Oracle Cloud Infrastructure Notifications service.
Note: Objects should always be created or deserialized using theAnnouncementSubscription.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 theAnnouncementSubscription.Builder, which maintain a set of all explicitly set fields calledAnnouncementSubscription.Builder.__explicitlySet__. ThehashCode()andequals(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).
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classAnnouncementSubscription.Builderstatic classAnnouncementSubscription.LifecycleStateThe current lifecycle state of the announcement subscription.
-
Constructor Summary
Constructors Constructor Description AnnouncementSubscription(String id, String displayName, String description, String compartmentId, Date timeCreated, Date timeUpdated, AnnouncementSubscription.LifecycleState lifecycleState, String lifecycleDetails, String onsTopicId, Map<String,FilterGroup> filterGroups, String preferredLanguage, String preferredTimeZone, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static AnnouncementSubscription.Builderbuilder()Create a new builder.booleanequals(Object o)StringgetCompartmentId()The OCID of the compartment that contains the announcement subscription.Map<String,Map<String,Object>>getDefinedTags()Defined tags for this resource.StringgetDescription()A description of the announcement subscription.StringgetDisplayName()A user-friendly name for the announcement subscription.Map<String,FilterGroup>getFilterGroups()A list of filter groups for the announcement subscription.Map<String,String>getFreeformTags()Simple key-value pair that is applied without any predefined name, type or scope.StringgetId()The OCID of the announcement subscription.StringgetLifecycleDetails()A message describing the current lifecycle state in more detail.AnnouncementSubscription.LifecycleStategetLifecycleState()The current lifecycle state of the announcement subscription.StringgetOnsTopicId()The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription.StringgetPreferredLanguage()(For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements.StringgetPreferredTimeZone()The time zone in which the user prefers to receive announcements.Map<String,Map<String,Object>>getSystemTags()Usage of system tag keys.DategetTimeCreated()The date and time that the announcement subscription was created, expressed in RFC 3339 timestamp format.DategetTimeUpdated()The date and time that the announcement subscription was updated, expressed in RFC 3339 timestamp format.inthashCode()AnnouncementSubscription.BuildertoBuilder()StringtoString()StringtoString(boolean includeByteArrayContents)Return a string representation of the object.
-
-
-
Constructor Detail
-
AnnouncementSubscription
@Deprecated @ConstructorProperties({"id","displayName","description","compartmentId","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","onsTopicId","filterGroups","preferredLanguage","preferredTimeZone","freeformTags","definedTags","systemTags"}) public AnnouncementSubscription(String id, String displayName, String description, String compartmentId, Date timeCreated, Date timeUpdated, AnnouncementSubscription.LifecycleState lifecycleState, String lifecycleDetails, String onsTopicId, Map<String,FilterGroup> filterGroups, String preferredLanguage, String preferredTimeZone, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)
Deprecated.
-
-
Method Detail
-
builder
public static AnnouncementSubscription.Builder builder()
Create a new builder.
-
toBuilder
public AnnouncementSubscription.Builder toBuilder()
-
getDisplayName
public String getDisplayName()
A user-friendly name for the announcement subscription.Does not have to be unique, and it’s changeable. Avoid entering confidential information.
- Returns:
- the value
-
getDescription
public String getDescription()
A description of the announcement subscription.Avoid entering confidential information.
- Returns:
- the value
-
getCompartmentId
public String getCompartmentId()
The OCID of the compartment that contains the announcement subscription.- Returns:
- the value
-
getTimeCreated
public Date getTimeCreated()
The date and time that the announcement subscription was created, expressed in RFC 3339 timestamp format.- Returns:
- the value
-
getTimeUpdated
public Date getTimeUpdated()
The date and time that the announcement subscription was updated, expressed in RFC 3339 timestamp format.- Returns:
- the value
-
getLifecycleState
public AnnouncementSubscription.LifecycleState getLifecycleState()
The current lifecycle state of the announcement subscription.- Returns:
- the value
-
getLifecycleDetails
public String getLifecycleDetails()
A message describing the current lifecycle state in more detail.For example, details might provide required or recommended actions for a resource in a Failed state.
- Returns:
- the value
-
getOnsTopicId
public String getOnsTopicId()
The OCID of the Notifications service topic that is the target for publishing announcements that match the configured announcement subscription.- Returns:
- the value
-
getFilterGroups
public Map<String,FilterGroup> getFilterGroups()
A list of filter groups for the announcement subscription.A filter group is a combination of multiple filters applied to announcements for matching purposes.
- Returns:
- the value
-
getPreferredLanguage
public String getPreferredLanguage()
(For announcement subscriptions with SaaS configured as the platform type or Oracle Fusion Applications as the service, or both, only) The language in which the user prefers to receive emailed announcements.Specify the preference with a value that uses the x-obmcs-human-language format. For example fr-FR.
- Returns:
- the value
-
getPreferredTimeZone
public String getPreferredTimeZone()
The time zone in which the user prefers to receive announcements.Specify the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles
- Returns:
- the value
-
getFreeformTags
public Map<String,String> getFreeformTags()
Simple key-value pair that is applied without any predefined name, type or scope.Exists for cross-compatibility only. Example: {“bar-key”: “value”}
- 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. Example: {“foo-namespace”: {“bar-key”: “value”}}
- Returns:
- the value
-
getSystemTags
public Map<String,Map<String,Object>> getSystemTags()
Usage of system tag keys.These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
- Returns:
- the value
-
toString
public String toString()
- Overrides:
toStringin classcom.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:
equalsin classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
hashCode
public int hashCode()
- Overrides:
hashCodein classcom.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
-
-