@Generated(value="OracleSDKGenerator", comments="API Version: 0.0.1") public class BaseCreateAnnouncementsPreferencesDetails extends ExplicitlySetBmcModel
The model for the parameters of 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
ExplicitlySetBmcModel.__explicitlySet__
. The hashCode()
and equals(Object)
methods are implemented to take
ExplicitlySetBmcModel.__explicitlySet__
into account. The constructor, on the other hand, does not set ExplicitlySetBmcModel.__explicitlySet__
(since the constructor cannot distinguish explicit null
from unset null
).
Modifier and Type | Class and Description |
---|---|
static class |
BaseCreateAnnouncementsPreferencesDetails.PreferenceType
The string representing the user’s preference, whether to opt in to only required announcements, to opt in to all announcements, including informational announcements, or to opt out of all announcements.
|
Modifier | Constructor and Description |
---|---|
protected |
BaseCreateAnnouncementsPreferencesDetails(Boolean isUnsubscribed,
String compartmentId,
BaseCreateAnnouncementsPreferencesDetails.PreferenceType preferenceType,
String preferredTimeZone)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object o) |
String |
getCompartmentId()
The OCID of the compartment for which you want to manage announcement email 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, whether to opt in to only required announcements, to opt in to all announcements, including informational announcements, or to opt out of all announcements.
|
String |
getPreferredTimeZone()
The time zone in which the user prefers to receive announcements.
|
int |
hashCode() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet
@Deprecated @ConstructorProperties(value={"isUnsubscribed","compartmentId","preferenceType","preferredTimeZone"}) protected BaseCreateAnnouncementsPreferencesDetails(Boolean isUnsubscribed, String compartmentId, BaseCreateAnnouncementsPreferencesDetails.PreferenceType preferenceType, String preferredTimeZone)
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.)
public String getCompartmentId()
The OCID of the compartment for which you want to manage announcement email preferences. (Specify the tenancy by providing the root compartment OCID.)
public BaseCreateAnnouncementsPreferencesDetails.PreferenceType getPreferenceType()
The string representing the user’s preference, whether to opt in to only required announcements, to opt in to all announcements, including informational announcements, or to opt out of all announcements.
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
public String toString()
toString
in class 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 ExplicitlySetBmcModel
public int hashCode()
hashCode
in class ExplicitlySetBmcModel
Copyright © 2016–2024. All rights reserved.