Package com.oracle.bmc.announcementsservice.model

Class BaseAnnouncementsPreferences

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.announcementsservice.model.BaseAnnouncementsPreferences

Direct Known Subclasses:

AnnouncementsPreferences, AnnouncementsPreferencesSummary

@Generated(value="OracleSDKGenerator",
           comments="API Version: 0.0.1")
public class BaseAnnouncementsPreferences
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

The object that contains the announcement email preferences configured for the tenancy (root compartment).
Note: Objects should always be created or deserialized using the 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 Builder, which maintain a set of all explicitly set fields called 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).

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseAnnouncementsPreferences(String compartmentId, String id, Boolean isUnsubscribed, Date timeCreated, Date timeUpdated, BaseCreateAnnouncementsPreferencesDetails.PreferenceType preferenceType, String preferredTimeZone)	Deprecated.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getCompartmentId()	The OCID of the compartment for which the email preferences apply.
String	getId()	The ID of the preferences.
Boolean	getIsUnsubscribed()	A Boolean value to indicate whether the specified compartment chooses to not to receive informational announcements by email.
BaseCreateAnnouncementsPreferencesDetails.PreferenceType	getPreferenceType()	The string representing the user’s preference regarding receiving announcements by email.
String	getPreferredTimeZone()	The time zone in which the user prefers to receive announcements.
Date	getTimeCreated()	When the preferences were set initially.
Date	getTimeUpdated()	When the preferences were last updated.
int	hashCode()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BaseAnnouncementsPreferences

@Deprecated
@ConstructorProperties({"compartmentId","id","isUnsubscribed","timeCreated","timeUpdated","preferenceType","preferredTimeZone"})
protected BaseAnnouncementsPreferences(String compartmentId,
                                       String id,
                                       Boolean isUnsubscribed,
                                       Date timeCreated,
                                       Date timeUpdated,
                                       BaseCreateAnnouncementsPreferencesDetails.PreferenceType preferenceType,
                                       String preferredTimeZone)

Deprecated.

Method Detail

getCompartmentId

public String getCompartmentId()

The OCID of the compartment for which the email preferences apply.

Because announcements are specific to a tenancy, specify the tenancy by providing the root compartment OCID.

Returns:

the value

getId

public String getId()

The ID of the preferences.

Returns:

the value

getIsUnsubscribed

public Boolean getIsUnsubscribed()

A Boolean value to indicate whether the specified compartment chooses to not to receive informational announcements by email.

(Manage preferences for receiving announcements by email by specifying the preferenceType attribute instead.)

Returns:

the value

getTimeCreated

public Date getTimeCreated()

When the preferences were set initially.

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

When the preferences were last updated.

Returns:

the value

getPreferenceType

public BaseCreateAnnouncementsPreferencesDetails.PreferenceType getPreferenceType()

The string representing the user’s preference regarding receiving announcements by email.

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

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