Package com.oracle.bmc.ons.model

Class NotificationTopic

java.lang.Object

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

com.oracle.bmc.ons.model.NotificationTopic

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

The properties that define a topic.

For general information about topics, see Notifications Overview.
Note: Objects should always be created or deserialized using the NotificationTopic.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 NotificationTopic.Builder, which maintain a set of all explicitly set fields called NotificationTopic.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).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NotificationTopic.Builder
static class	NotificationTopic.LifecycleState	The lifecycle state of the topic.

Field Summary

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

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
NotificationTopic(String name, String topicId, String shortTopicId, String compartmentId, NotificationTopic.LifecycleState lifecycleState, String description, Date timeCreated, String etag, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, String apiEndpoint)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static NotificationTopic.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getApiEndpoint()	The endpoint for managing subscriptions or publishing messages to the topic.
String	getCompartmentId()	The OCID of the compartment for the topic.
Map<String,Map<String,Object>>	getDefinedTags()	Defined tags for this resource.
String	getDescription()	The description of the topic.
String	getEtag()	For optimistic concurrency control.
Map<String,String>	getFreeformTags()	Free-form tags for this resource.
NotificationTopic.LifecycleState	getLifecycleState()	The lifecycle state of the topic.
String	getName()	The name of the topic.
String	getShortTopicId()	A unique short topic Id.
Date	getTimeCreated()	The time the topic was created.
String	getTopicId()	The OCID of the topic.
int	hashCode()
NotificationTopic.Builder	toBuilder()
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

NotificationTopic

@Deprecated
@ConstructorProperties({"name","topicId","shortTopicId","compartmentId","lifecycleState","description","timeCreated","etag","freeformTags","definedTags","apiEndpoint"})
public NotificationTopic(String name,
                         String topicId,
                         String shortTopicId,
                         String compartmentId,
                         NotificationTopic.LifecycleState lifecycleState,
                         String description,
                         Date timeCreated,
                         String etag,
                         Map<String,String> freeformTags,
                         Map<String,Map<String,Object>> definedTags,
                         String apiEndpoint)

Deprecated.

Method Detail

builder

public static NotificationTopic.Builder builder()

Create a new builder.

toBuilder

public NotificationTopic.Builder toBuilder()

getName

public String getName()

The name of the topic.

Returns:

the value

getTopicId

public String getTopicId()

The OCID of the topic.

Returns:

the value

getShortTopicId

public String getShortTopicId()

A unique short topic Id.

This is used only for SMS subscriptions.

Returns:

the value

getCompartmentId

public String getCompartmentId()

The OCID of the compartment for the topic.

Returns:

the value

getLifecycleState

public NotificationTopic.LifecycleState getLifecycleState()

The lifecycle state of the topic.

Returns:

the value

getDescription

public String getDescription()

The description of the topic.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The time the topic was created.

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

getApiEndpoint

public String getApiEndpoint()

The endpoint for managing subscriptions or publishing messages to the topic.

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