Package com.oracle.bmc.demandsignal.model

Class OccMetricAlarm

java.lang.Object

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

com.oracle.bmc.demandsignal.model.OccMetricAlarm

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

OccMetricAlarm represents an alarm configuration for OCI Control Center metric.
Note: Objects should always be created or deserialized using the OccMetricAlarm.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 OccMetricAlarm.Builder, which maintain a set of all explicitly set fields called OccMetricAlarm.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	OccMetricAlarm.Builder
static class	OccMetricAlarm.Frequency	Frequency at which notifications should be sent.
static class	OccMetricAlarm.LifecycleState	The current lifecycle state of the resource.
static class	OccMetricAlarm.ThresholdType	Units in which threshold is being stored.

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

OccMetricAlarm(String id, String displayName, String description, Date timeCreated, Date timeUpdated, OccMetricAlarm.LifecycleState lifecycleState, String compartmentId, Boolean isActive, List<String> subscribers, OccMetricAlarm.Frequency frequency, Integer threshold, OccMetricAlarm.ThresholdType thresholdType, BaseResourceConfiguration resourceConfiguration, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static OccMetricAlarm.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getCompartmentId()	Compartment OCID in which the alarm is created.
Map<String,Map<String,Object>>	getDefinedTags()	Defined tags for this resource.
String	getDescription()	Optional description for the alarm.
String	getDisplayName()	Human-readable name for the alarm.
Map<String,String>	getFreeformTags()	Free-form tags for this resource.
OccMetricAlarm.Frequency	getFrequency()	Frequency at which notifications should be sent.
String	getId()	Unique OCID for this alarm configuration.
Boolean	getIsActive()	Alarm active status.
OccMetricAlarm.LifecycleState	getLifecycleState()	The current lifecycle state of the resource.
BaseResourceConfiguration	getResourceConfiguration()
List<String>	getSubscribers()	List of topic OCIDs for notifications.
Map<String,Map<String,Object>>	getSystemTags()	System tags for this resource.
Integer	getThreshold()	Threshold at which alarm must be triggered.
OccMetricAlarm.ThresholdType	getThresholdType()	Units in which threshold is being stored.
Date	getTimeCreated()	Creation timestamp (RFC 3339).
Date	getTimeUpdated()	Last update timestamp (RFC 3339).
int	hashCode()
OccMetricAlarm.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

OccMetricAlarm

@Deprecated
@ConstructorProperties({"id","displayName","description","timeCreated","timeUpdated","lifecycleState","compartmentId","isActive","subscribers","frequency","threshold","thresholdType","resourceConfiguration","freeformTags","definedTags","systemTags"})
public OccMetricAlarm(String id,
                      String displayName,
                      String description,
                      Date timeCreated,
                      Date timeUpdated,
                      OccMetricAlarm.LifecycleState lifecycleState,
                      String compartmentId,
                      Boolean isActive,
                      List<String> subscribers,
                      OccMetricAlarm.Frequency frequency,
                      Integer threshold,
                      OccMetricAlarm.ThresholdType thresholdType,
                      BaseResourceConfiguration resourceConfiguration,
                      Map<String,String> freeformTags,
                      Map<String,Map<String,Object>> definedTags,
                      Map<String,Map<String,Object>> systemTags)

Deprecated.

Method Detail

builder

public static OccMetricAlarm.Builder builder()

Create a new builder.

toBuilder

public OccMetricAlarm.Builder toBuilder()

getId

public String getId()

Unique OCID for this alarm configuration.

Returns:

the value

getDisplayName

public String getDisplayName()

Human-readable name for the alarm.

Returns:

the value

getDescription

public String getDescription()

Optional description for the alarm.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

Creation timestamp (RFC 3339).

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

Last update timestamp (RFC 3339).

Returns:

the value

getLifecycleState

public OccMetricAlarm.LifecycleState getLifecycleState()

The current lifecycle state of the resource.

Returns:

the value

getCompartmentId

public String getCompartmentId()

Compartment OCID in which the alarm is created.

Returns:

the value

getIsActive

public Boolean getIsActive()

Alarm active status.

Returns:

the value

getSubscribers

public List<String> getSubscribers()

List of topic OCIDs for notifications.

Returns:

the value

getFrequency

public OccMetricAlarm.Frequency getFrequency()

Frequency at which notifications should be sent.

Returns:

the value

getThreshold

public Integer getThreshold()

Threshold at which alarm must be triggered.

Returns:

the value

getThresholdType

public OccMetricAlarm.ThresholdType getThresholdType()

Units in which threshold is being stored.

Returns:

the value

getResourceConfiguration

public BaseResourceConfiguration getResourceConfiguration()

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

getSystemTags

public Map<String,Map<String,Object>> getSystemTags()

System tags for this resource.

Each key is predefined and scoped to a namespace.

Example: {"orcl-cloud": {"free-tier-retained": "true"}}

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