Alarm (Java SDK for NSX Manager API 4.1.2.0.0)

java.lang.Object
- com.vmware.nsx.model.Alarm

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class Alarm
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Alarm.Builder
Builder class for Alarm.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Alarm.Builder` Builder class for `Alarm`.

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`ALARM_SOURCE_TYPE_ENTITY_ID`
`static java.lang.String`	`ALARM_SOURCE_TYPE_INTENT_PATH`
`static java.lang.String`	`ALARM_SOURCE_TYPE_SYSTEM_ID`
`static java.lang.String`	`SEVERITY_CRITICAL`
`static java.lang.String`	`SEVERITY_HIGH`
`static java.lang.String`	`SEVERITY_LOW`
`static java.lang.String`	`SEVERITY_MEDIUM`
`static java.lang.String`	`STATUS_ACKNOWLEDGED`
`static java.lang.String`	`STATUS_OPEN`
`static java.lang.String`	`STATUS_RESOLVED`
`static java.lang.String`	`STATUS_SUPPRESSED`

Constructor Summary

Constructors
Modifier Constructor and Description

Alarm()
Default constructor.

protected Alarm(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`Alarm()` Default constructor.
`protected`	`Alarm(com.vmware.vapi.data.StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends com.vmware.vapi.bindings.Structure> T`	`_convertTo(java.lang.Class<T> clazz)`
`java.lang.String`	`_getCanonicalName()`
`static java.lang.String`	`_getCanonicalTypeName()` Returns the canonical type name.
`static com.vmware.vapi.bindings.type.StructType`	`_getClassType()` WARNING: Internal method, subject to change in future versions.
`com.vmware.vapi.data.StructValue`	`_getDataValue()`
`com.vmware.vapi.data.DataValue`	`_getDynamicField(java.lang.String fieldName)`
`java.util.Set<java.lang.String>`	`_getDynamicFieldNames()`
`com.vmware.vapi.bindings.type.StructType`	`_getType()`
`boolean`	`_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)`
`static Alarm`	`_newInstance(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized.
`static Alarm`	`_newInstance2(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
`void`	`_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)`
`protected void`	`_updateDataValue(com.vmware.vapi.data.StructValue structValue)`
`void`	`_validate()`
`boolean`	`equals(java.lang.Object obj)`
`java.util.List<java.lang.String>`	`getAlarmSource()` If alarm_source_type = INTENT_PATH, this field will contain a list of intent paths for the entity that the event instance applies to.
`java.lang.String`	`getAlarmSourceType()` Possible values are: `ALARM_SOURCE_TYPE_INTENT_PATH` `ALARM_SOURCE_TYPE_ENTITY_ID` `ALARM_SOURCE_TYPE_SYSTEM_ID` Type of alarm source of the Event instance.
`java.lang.Long`	`getCreateTime()` Timestamp of resource creation format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.String`	`getCreateUser()` ID of the user who created this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.String`	`getDescription()` Detailed description of Alarm.
`java.lang.String`	`getDisplayName()` Defaults to ID if not set
`java.lang.String`	`getEntityId()` The entity that the Event instance applies to.
`java.lang.String`	`getEntityResourceType()` The entity type that the Event instance applies to.
`java.util.List<java.lang.String>`	`getEventTags()` Tags applicable to event, for example, INFRASTRUCTURE or INTELLIGENCE.
`java.lang.String`	`getEventType()` Name of Event, e.g.
`java.lang.String`	`getEventTypeDisplayName()` Display name of Event type.
`java.lang.String`	`getFeatureDisplayName()` Display name of feature defining this Event.
`java.lang.String`	`getFeatureName()` Feature defining this Event, e.g.
`java.lang.String`	`getId()` ID that uniquely identifies an Alarm.
`java.lang.String`	`getKbArticle()` KB article link that contains more information on this alarm and recommended actions.
`java.lang.Long`	`getLastModifiedTime()` Timestamp of last modification format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.String`	`getLastModifiedUser()` ID of the user who last modified this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.Long`	`getLastReportedTime()` Indicates when the corresponding Event instance was last reported in milliseconds since epoch.
`java.util.List<ResourceLink>`	`getLinks()` The server will populate this field when returing the resource.
`java.lang.String`	`getNodeDisplayName()` Display name of node that the event instance applies to.
`java.lang.String`	`getNodeId()` The UUID of the node that the Event instance applies to.
`java.util.List<java.lang.String>`	`getNodeIpAddresses()` IP addresses of node that the event instance applies to.
`java.lang.String`	`getNodeResourceType()` The resource type of node that the Event instance applies to eg.
`java.lang.String`	`getProtection()` Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it.
`java.lang.String`	`getRecommendedAction()` Recommended action for Alarm.
`java.lang.Long`	`getReoccurrencesWhileSuppressed()` The number of reoccurrences since this alarm has been SUPPRESSED.
`java.lang.String`	`getResolvedBy()` User ID of the user that set the status value to RESOLVED.
`java.lang.Long`	`getResolvedTime()` Indicates when the Alarm was resolved in milliseconds since epoch.
`java.lang.String`	`getResourceType()` The type of this resource.
`java.lang.Long`	`getRevision()` The _revision property describes the current revision of the resource.
`java.lang.String`	`getRuntimeData()` Runtime data for Alarm.
`java.lang.String`	`getSchema()` Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`SelfResourceLink`	`getSelf()`
`java.lang.String`	`getSeverity()` Possible values are: `SEVERITY_CRITICAL` `SEVERITY_HIGH` `SEVERITY_MEDIUM` `SEVERITY_LOW` Severity of the Alarm.Can be one of - CRITICAL, HIGH, MEDIUM, LOW.
`java.lang.String`	`getStatus()` Possible values are: `STATUS_OPEN` `STATUS_ACKNOWLEDGED` `STATUS_SUPPRESSED` `STATUS_RESOLVED` Indicate the status which the Alarm is in.
`java.lang.String`	`getSummary()` Summary description of Alarm.
`java.lang.Long`	`getSuppressDuration()` The time period between suppress_start_time and suppress_start_time + suppress_duration (specified in hours) an Alarm is SUPPRESSED.
`java.lang.String`	`getSuppressedBy()` User ID of the user that set the status value to SUPPRESSED.
`java.lang.Long`	`getSuppressStartTime()` Indicates when the Alarm was suppressed in milliseconds since epoch.
`java.lang.Boolean`	`getSystemOwned()` Indicates system owned resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.util.List<Tag>`	`getTags()` Opaque identifiers meaningful to the API user
`int`	`hashCode()`
`void`	`setAlarmSource(java.util.List<java.lang.String> alarmSource)` If alarm_source_type = INTENT_PATH, this field will contain a list of intent paths for the entity that the event instance applies to.
`void`	`setAlarmSourceType(java.lang.String alarmSourceType)` Possible values are: `ALARM_SOURCE_TYPE_INTENT_PATH` `ALARM_SOURCE_TYPE_ENTITY_ID` `ALARM_SOURCE_TYPE_SYSTEM_ID` Type of alarm source of the Event instance.
`void`	`setCreateTime(java.lang.Long createTime)` Timestamp of resource creation format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setCreateUser(java.lang.String createUser)` ID of the user who created this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setDescription(java.lang.String description)` Detailed description of Alarm.
`void`	`setDisplayName(java.lang.String displayName)` Defaults to ID if not set
`void`	`setEntityId(java.lang.String entityId)` The entity that the Event instance applies to.
`void`	`setEntityResourceType(java.lang.String entityResourceType)` The entity type that the Event instance applies to.
`void`	`setEventTags(java.util.List<java.lang.String> eventTags)` Tags applicable to event, for example, INFRASTRUCTURE or INTELLIGENCE.
`void`	`setEventType(java.lang.String eventType)` Name of Event, e.g.
`void`	`setEventTypeDisplayName(java.lang.String eventTypeDisplayName)` Display name of Event type.
`void`	`setFeatureDisplayName(java.lang.String featureDisplayName)` Display name of feature defining this Event.
`void`	`setFeatureName(java.lang.String featureName)` Feature defining this Event, e.g.
`void`	`setId(java.lang.String id)` ID that uniquely identifies an Alarm.
`void`	`setKbArticle(java.lang.String kbArticle)` KB article link that contains more information on this alarm and recommended actions.
`void`	`setLastModifiedTime(java.lang.Long lastModifiedTime)` Timestamp of last modification format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setLastModifiedUser(java.lang.String lastModifiedUser)` ID of the user who last modified this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setLastReportedTime(java.lang.Long lastReportedTime)` Indicates when the corresponding Event instance was last reported in milliseconds since epoch.
`void`	`setLinks(java.util.List<ResourceLink> links)` The server will populate this field when returing the resource.
`void`	`setNodeDisplayName(java.lang.String nodeDisplayName)` Display name of node that the event instance applies to.
`void`	`setNodeId(java.lang.String nodeId)` The UUID of the node that the Event instance applies to.
`void`	`setNodeIpAddresses(java.util.List<java.lang.String> nodeIpAddresses)` IP addresses of node that the event instance applies to.
`void`	`setNodeResourceType(java.lang.String nodeResourceType)` The resource type of node that the Event instance applies to eg.
`void`	`setProtection(java.lang.String protection)` Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it.
`void`	`setRecommendedAction(java.lang.String recommendedAction)` Recommended action for Alarm.
`void`	`setReoccurrencesWhileSuppressed(java.lang.Long reoccurrencesWhileSuppressed)` The number of reoccurrences since this alarm has been SUPPRESSED.
`void`	`setResolvedBy(java.lang.String resolvedBy)` User ID of the user that set the status value to RESOLVED.
`void`	`setResolvedTime(java.lang.Long resolvedTime)` Indicates when the Alarm was resolved in milliseconds since epoch.
`void`	`setResourceType(java.lang.String resourceType)` The type of this resource.
`void`	`setRevision(java.lang.Long revision)` The _revision property describes the current revision of the resource.
`void`	`setRuntimeData(java.lang.String runtimeData)` Runtime data for Alarm.
`void`	`setSchema(java.lang.String schema)` Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setSelf(SelfResourceLink self)`
`void`	`setSeverity(java.lang.String severity)` Possible values are: `SEVERITY_CRITICAL` `SEVERITY_HIGH` `SEVERITY_MEDIUM` `SEVERITY_LOW` Severity of the Alarm.Can be one of - CRITICAL, HIGH, MEDIUM, LOW.
`void`	`setStatus(java.lang.String status)` Possible values are: `STATUS_OPEN` `STATUS_ACKNOWLEDGED` `STATUS_SUPPRESSED` `STATUS_RESOLVED` Indicate the status which the Alarm is in.
`void`	`setSummary(java.lang.String summary)` Summary description of Alarm.
`void`	`setSuppressDuration(java.lang.Long suppressDuration)` The time period between suppress_start_time and suppress_start_time + suppress_duration (specified in hours) an Alarm is SUPPRESSED.
`void`	`setSuppressedBy(java.lang.String suppressedBy)` User ID of the user that set the status value to SUPPRESSED.
`void`	`setSuppressStartTime(java.lang.Long suppressStartTime)` Indicates when the Alarm was suppressed in milliseconds since epoch.
`void`	`setSystemOwned(java.lang.Boolean systemOwned)` Indicates system owned resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setTags(java.util.List<Tag> tags)` Opaque identifiers meaningful to the API user
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ALARM_SOURCE_TYPE_INTENT_PATH
```
public static final java.lang.String ALARM_SOURCE_TYPE_INTENT_PATH
```
    See Also:
    
    Constant Field Values
  - ALARM_SOURCE_TYPE_ENTITY_ID
```
public static final java.lang.String ALARM_SOURCE_TYPE_ENTITY_ID
```
    See Also:
    
    Constant Field Values
  - ALARM_SOURCE_TYPE_SYSTEM_ID
```
public static final java.lang.String ALARM_SOURCE_TYPE_SYSTEM_ID
```
    See Also:
    
    Constant Field Values
  - SEVERITY_CRITICAL
```
public static final java.lang.String SEVERITY_CRITICAL
```
    See Also:
    
    Constant Field Values
  - SEVERITY_HIGH
```
public static final java.lang.String SEVERITY_HIGH
```
    See Also:
    
    Constant Field Values
  - SEVERITY_MEDIUM
```
public static final java.lang.String SEVERITY_MEDIUM
```
    See Also:
    
    Constant Field Values
  - SEVERITY_LOW
```
public static final java.lang.String SEVERITY_LOW
```
    See Also:
    
    Constant Field Values
  - STATUS_OPEN
```
public static final java.lang.String STATUS_OPEN
```
    See Also:
    
    Constant Field Values
  - STATUS_ACKNOWLEDGED
```
public static final java.lang.String STATUS_ACKNOWLEDGED
```
    See Also:
    
    Constant Field Values
  - STATUS_SUPPRESSED
```
public static final java.lang.String STATUS_SUPPRESSED
```
    See Also:
    
    Constant Field Values
  - STATUS_RESOLVED
```
public static final java.lang.String STATUS_RESOLVED
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - Alarm
```
public Alarm()
```
    Default constructor.
  - Alarm
```
protected Alarm(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getLinks
```
public java.util.List<ResourceLink> getLinks()
```
    The server will populate this field when returing the resource. Ignored on PUT and POST. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setLinks
```
public void setLinks(java.util.List<ResourceLink> links)
```
    The server will populate this field when returing the resource. Ignored on PUT and POST. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    links - New value for the property.
  - getSchema
```
public java.lang.String getSchema()
```
    Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setSchema
```
public void setSchema(java.lang.String schema)
```
    Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    schema - New value for the property.
  - getSelf
```
public SelfResourceLink getSelf()
```
    Returns:
    
    The current value of the property.
  - setSelf
```
public void setSelf(SelfResourceLink self)
```
    Parameters:
    
    self - New value for the property.
  - getRevision
```
public java.lang.Long getRevision()
```
    The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
    
    Returns:
    
    The current value of the property.
  - setRevision
```
public void setRevision(java.lang.Long revision)
```
    The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
    
    Parameters:
    
    revision - New value for the property.
  - getCreateTime
```
public java.lang.Long getCreateTime()
```
    Timestamp of resource creation format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setCreateTime
```
public void setCreateTime(java.lang.Long createTime)
```
    Timestamp of resource creation format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    createTime - New value for the property.
  - getCreateUser
```
public java.lang.String getCreateUser()
```
    ID of the user who created this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setCreateUser
```
public void setCreateUser(java.lang.String createUser)
```
    ID of the user who created this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    createUser - New value for the property.
  - getLastModifiedTime
```
public java.lang.Long getLastModifiedTime()
```
    Timestamp of last modification format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setLastModifiedTime
```
public void setLastModifiedTime(java.lang.Long lastModifiedTime)
```
    Timestamp of last modification format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    lastModifiedTime - New value for the property.
  - getLastModifiedUser
```
public java.lang.String getLastModifiedUser()
```
    ID of the user who last modified this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setLastModifiedUser
```
public void setLastModifiedUser(java.lang.String lastModifiedUser)
```
    ID of the user who last modified this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    lastModifiedUser - New value for the property.
  - getProtection
```
public java.lang.String getProtection()
```
    Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setProtection
```
public void setProtection(java.lang.String protection)
```
    Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    protection - New value for the property.
  - getSystemOwned
```
public java.lang.Boolean getSystemOwned()
```
    Indicates system owned resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setSystemOwned
```
public void setSystemOwned(java.lang.Boolean systemOwned)
```
    Indicates system owned resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    systemOwned - New value for the property.
  - getDescription
```
public java.lang.String getDescription()
```
    Detailed description of Alarm. This is the same detailed description as the corresponding Event identified by feature_name.event_type. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Detailed description of Alarm. This is the same detailed description as the corresponding Event identified by feature_name.event_type. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    description - New value for the property.
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    Defaults to ID if not set
    
    Returns:
    
    The current value of the property.
  - setDisplayName
```
public void setDisplayName(java.lang.String displayName)
```
    Defaults to ID if not set
    
    Parameters:
    
    displayName - New value for the property.
  - getId
```
public java.lang.String getId()
```
    ID that uniquely identifies an Alarm. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setId
```
public void setId(java.lang.String id)
```
    ID that uniquely identifies an Alarm. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    id - New value for the property.
  - getResourceType
```
public java.lang.String getResourceType()
```
    The type of this resource.
    
    Returns:
    
    The current value of the property.
  - setResourceType
```
public void setResourceType(java.lang.String resourceType)
```
    The type of this resource.
    
    Parameters:
    
    resourceType - New value for the property.
  - getTags
```
public java.util.List<Tag> getTags()
```
    Opaque identifiers meaningful to the API user
    
    Returns:
    
    The current value of the property.
  - setTags
```
public void setTags(java.util.List<Tag> tags)
```
    Opaque identifiers meaningful to the API user
    
    Parameters:
    
    tags - New value for the property.
  - getAlarmSource
```
public java.util.List<java.lang.String> getAlarmSource()
```
    If alarm_source_type = INTENT_PATH, this field will contain a list of intent paths for the entity that the event instance applies to. If alarm_source_type = ENTITY_ID, this field will contain a list with a single item identifying the entity id that the event instance applies to. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setAlarmSource
```
public void setAlarmSource(java.util.List<java.lang.String> alarmSource)
```
    If alarm_source_type = INTENT_PATH, this field will contain a list of intent paths for the entity that the event instance applies to. If alarm_source_type = ENTITY_ID, this field will contain a list with a single item identifying the entity id that the event instance applies to. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    alarmSource - New value for the property.
  - getAlarmSourceType
```
public java.lang.String getAlarmSourceType()
```
    Possible values are:
    Type of alarm source of the Event instance. Can be one of - INTENT_PATH, ENTITY_ID. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    Returns:
    
    The current value of the property.
  - setAlarmSourceType
```
public void setAlarmSourceType(java.lang.String alarmSourceType)
```
    Possible values are:
    Type of alarm source of the Event instance. Can be one of - INTENT_PATH, ENTITY_ID. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    Parameters:
    
    alarmSourceType - New value for the property.
  - getEntityId
```
public java.lang.String getEntityId()
```
    The entity that the Event instance applies to. Note entity_id may not be included in a response body. For example, the cpu_high Event may not return an entity_id. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setEntityId
```
public void setEntityId(java.lang.String entityId)
```
    The entity that the Event instance applies to. Note entity_id may not be included in a response body. For example, the cpu_high Event may not return an entity_id. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    entityId - New value for the property.
  - getEntityResourceType
```
public java.lang.String getEntityResourceType()
```
    The entity type that the Event instance applies to. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setEntityResourceType
```
public void setEntityResourceType(java.lang.String entityResourceType)
```
    The entity type that the Event instance applies to. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    entityResourceType - New value for the property.
  - getEventTags
```
public java.util.List<java.lang.String> getEventTags()
```
    Tags applicable to event, for example, INFRASTRUCTURE or INTELLIGENCE. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setEventTags
```
public void setEventTags(java.util.List<java.lang.String> eventTags)
```
    Tags applicable to event, for example, INFRASTRUCTURE or INTELLIGENCE. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    eventTags - New value for the property.
  - getEventType
```
public java.lang.String getEventType()
```
    Name of Event, e.g. manager_cpu_usage_high, certificate_expired. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setEventType
```
public void setEventType(java.lang.String eventType)
```
    Name of Event, e.g. manager_cpu_usage_high, certificate_expired. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    eventType - New value for the property.
  - getEventTypeDisplayName
```
public java.lang.String getEventTypeDisplayName()
```
    Display name of Event type. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setEventTypeDisplayName
```
public void setEventTypeDisplayName(java.lang.String eventTypeDisplayName)
```
    Display name of Event type. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    eventTypeDisplayName - New value for the property.
  - getFeatureDisplayName
```
public java.lang.String getFeatureDisplayName()
```
    Display name of feature defining this Event. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setFeatureDisplayName
```
public void setFeatureDisplayName(java.lang.String featureDisplayName)
```
    Display name of feature defining this Event. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    featureDisplayName - New value for the property.
  - getFeatureName
```
public java.lang.String getFeatureName()
```
    Feature defining this Event, e.g. manager_health, certificates. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setFeatureName
```
public void setFeatureName(java.lang.String featureName)
```
    Feature defining this Event, e.g. manager_health, certificates. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    featureName - New value for the property.
  - getKbArticle
```
public java.lang.String getKbArticle()
```
    KB article link that contains more information on this alarm and recommended actions. Users can refer to the specified link if needed. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setKbArticle
```
public void setKbArticle(java.lang.String kbArticle)
```
    KB article link that contains more information on this alarm and recommended actions. Users can refer to the specified link if needed. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    kbArticle - New value for the property.
  - getLastReportedTime
```
public java.lang.Long getLastReportedTime()
```
    Indicates when the corresponding Event instance was last reported in milliseconds since epoch. format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setLastReportedTime
```
public void setLastReportedTime(java.lang.Long lastReportedTime)
```
    Indicates when the corresponding Event instance was last reported in milliseconds since epoch. format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    lastReportedTime - New value for the property.
  - getNodeDisplayName
```
public java.lang.String getNodeDisplayName()
```
    Display name of node that the event instance applies to. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setNodeDisplayName
```
public void setNodeDisplayName(java.lang.String nodeDisplayName)
```
    Display name of node that the event instance applies to. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    nodeDisplayName - New value for the property.
  - getNodeId
```
public java.lang.String getNodeId()
```
    The UUID of the node that the Event instance applies to. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setNodeId
```
public void setNodeId(java.lang.String nodeId)
```
    The UUID of the node that the Event instance applies to. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    nodeId - New value for the property.
  - getNodeIpAddresses
```
public java.util.List<java.lang.String> getNodeIpAddresses()
```
    IP addresses of node that the event instance applies to. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setNodeIpAddresses
```
public void setNodeIpAddresses(java.util.List<java.lang.String> nodeIpAddresses)
```
    IP addresses of node that the event instance applies to. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    nodeIpAddresses - New value for the property.
  - getNodeResourceType
```
public java.lang.String getNodeResourceType()
```
    The resource type of node that the Event instance applies to eg. ClusterNodeConfig, TransportNode. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setNodeResourceType
```
public void setNodeResourceType(java.lang.String nodeResourceType)
```
    The resource type of node that the Event instance applies to eg. ClusterNodeConfig, TransportNode. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    nodeResourceType - New value for the property.
  - getRecommendedAction
```
public java.lang.String getRecommendedAction()
```
    Recommended action for Alarm. This is the same action as the corresponding Event identified by feature_name.event_type. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setRecommendedAction
```
public void setRecommendedAction(java.lang.String recommendedAction)
```
    Recommended action for Alarm. This is the same action as the corresponding Event identified by feature_name.event_type. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    recommendedAction - New value for the property.
  - getReoccurrencesWhileSuppressed
```
public java.lang.Long getReoccurrencesWhileSuppressed()
```
    The number of reoccurrences since this alarm has been SUPPRESSED. format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setReoccurrencesWhileSuppressed
```
public void setReoccurrencesWhileSuppressed(java.lang.Long reoccurrencesWhileSuppressed)
```
    The number of reoccurrences since this alarm has been SUPPRESSED. format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    reoccurrencesWhileSuppressed - New value for the property.
  - getResolvedBy
```
public java.lang.String getResolvedBy()
```
    User ID of the user that set the status value to RESOLVED. This value can be SYSTEM to indicate that the system resolved the Alarm, for example when the system determines CPU usage is no longer high and the cpu_high Alarm is no longer applicable. This property is only returned when the status value is RESOLVED. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setResolvedBy
```
public void setResolvedBy(java.lang.String resolvedBy)
```
    User ID of the user that set the status value to RESOLVED. This value can be SYSTEM to indicate that the system resolved the Alarm, for example when the system determines CPU usage is no longer high and the cpu_high Alarm is no longer applicable. This property is only returned when the status value is RESOLVED. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    resolvedBy - New value for the property.
  - getResolvedTime
```
public java.lang.Long getResolvedTime()
```
    Indicates when the Alarm was resolved in milliseconds since epoch. This property is only returned when the status value is RESOLVED. format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setResolvedTime
```
public void setResolvedTime(java.lang.Long resolvedTime)
```
    Indicates when the Alarm was resolved in milliseconds since epoch. This property is only returned when the status value is RESOLVED. format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    resolvedTime - New value for the property.
  - getRuntimeData
```
public java.lang.String getRuntimeData()
```
    Runtime data for Alarm. When an alarming condition occurs, there may be additional data of interest when triaging the underlying issue, for example, output from system commands captured at the time of the error. Note, the contents of this property are not localized. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setRuntimeData
```
public void setRuntimeData(java.lang.String runtimeData)
```
    Runtime data for Alarm. When an alarming condition occurs, there may be additional data of interest when triaging the underlying issue, for example, output from system commands captured at the time of the error. Note, the contents of this property are not localized. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    runtimeData - New value for the property.
  - getSeverity
```
public java.lang.String getSeverity()
```
    Possible values are:
    Severity of the Alarm.Can be one of - CRITICAL, HIGH, MEDIUM, LOW. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    Returns:
    
    The current value of the property.
  - setSeverity
```
public void setSeverity(java.lang.String severity)
```
    Possible values are:
    Severity of the Alarm.Can be one of - CRITICAL, HIGH, MEDIUM, LOW. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    Parameters:
    
    severity - New value for the property.
  - getStatus
```
public java.lang.String getStatus()
```
    Possible values are:
    Indicate the status which the Alarm is in.
    Returns:
    
    The current value of the property.
  - setStatus
```
public void setStatus(java.lang.String status)
```
    Possible values are:
    Indicate the status which the Alarm is in.
    Parameters:
    
    status - New value for the property.
  - getSummary
```
public java.lang.String getSummary()
```
    Summary description of Alarm. This is the same summary description as the corresponding Event identified by feature_name.event_type. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setSummary
```
public void setSummary(java.lang.String summary)
```
    Summary description of Alarm. This is the same summary description as the corresponding Event identified by feature_name.event_type. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    summary - New value for the property.
  - getSuppressDuration
```
public java.lang.Long getSuppressDuration()
```
    The time period between suppress_start_time and suppress_start_time + suppress_duration (specified in hours) an Alarm is SUPPRESSED. This property is only returned when the status value is SUPPRESSED. format: int64
    
    Returns:
    
    The current value of the property.
  - setSuppressDuration
```
public void setSuppressDuration(java.lang.Long suppressDuration)
```
    The time period between suppress_start_time and suppress_start_time + suppress_duration (specified in hours) an Alarm is SUPPRESSED. This property is only returned when the status value is SUPPRESSED. format: int64
    
    Parameters:
    
    suppressDuration - New value for the property.
  - getSuppressStartTime
```
public java.lang.Long getSuppressStartTime()
```
    Indicates when the Alarm was suppressed in milliseconds since epoch. This property is only returned when the status value is SUPPRESSED. format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setSuppressStartTime
```
public void setSuppressStartTime(java.lang.Long suppressStartTime)
```
    Indicates when the Alarm was suppressed in milliseconds since epoch. This property is only returned when the status value is SUPPRESSED. format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    suppressStartTime - New value for the property.
  - getSuppressedBy
```
public java.lang.String getSuppressedBy()
```
    User ID of the user that set the status value to SUPPRESSED. This property is only returned when the status value is SUPPRESSED. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setSuppressedBy
```
public void setSuppressedBy(java.lang.String suppressedBy)
```
    User ID of the user that set the status value to SUPPRESSED. This property is only returned when the status value is SUPPRESSED. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    suppressedBy - New value for the property.
  - _getType
```
public com.vmware.vapi.bindings.type.StructType _getType()
```
    Specified by:
    
    _getType in interface com.vmware.vapi.bindings.StaticStructure
  - _getDataValue
```
public com.vmware.vapi.data.StructValue _getDataValue()
```
    Specified by:
    
    _getDataValue in interface com.vmware.vapi.bindings.Structure
  - _updateDataValue
```
protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)
```
  - _validate
```
public void _validate()
```
    Specified by:
    
    _validate in interface com.vmware.vapi.bindings.StaticStructure
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in interface com.vmware.vapi.bindings.StaticStructure
    
    Overrides:
    
    toString in class java.lang.Object
  - _hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
```
    Specified by:
    
    _hasTypeNameOf in interface com.vmware.vapi.bindings.Structure
  - _convertTo
```
public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)
```
    Specified by:
    
    _convertTo in interface com.vmware.vapi.bindings.Structure
  - _setDynamicField
```
public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)
```
    Specified by:
    
    _setDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicField
```
public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)
```
    Specified by:
    
    _getDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicFieldNames
```
public java.util.Set<java.lang.String> _getDynamicFieldNames()
```
    Specified by:
    
    _getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure
  - _getClassType
```
public static com.vmware.vapi.bindings.type.StructType _getClassType()
```
    WARNING: Internal method, subject to change in future versions.
    
    Returns:
    
    StructType instance representing the static bindings type for this Structure.
  - _getCanonicalName
```
public java.lang.String _getCanonicalName()
```
    Specified by:
    
    _getCanonicalName in interface com.vmware.vapi.bindings.Structure
  - _getCanonicalTypeName
```
public static java.lang.String _getCanonicalTypeName()
```
    Returns the canonical type name. See _getCanonicalName().
    
    Returns:
    
    canonical type name
  - _newInstance
```
public static Alarm _newInstance(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Returns new instance of this binding class and injects the provided data value.
    WARNING: The returned object is not fully initialized.
    
    Parameters:
    
    structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.
    
    Returns:
    
    the static bindings StructType
  - _newInstance2
```
public static Alarm _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class Alarm

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ALARM_SOURCE_TYPE_INTENT_PATH

ALARM_SOURCE_TYPE_ENTITY_ID

ALARM_SOURCE_TYPE_SYSTEM_ID

SEVERITY_CRITICAL

SEVERITY_HIGH

SEVERITY_MEDIUM

SEVERITY_LOW

STATUS_OPEN

STATUS_ACKNOWLEDGED

STATUS_SUPPRESSED

STATUS_RESOLVED

__dynamicStructureFields

Constructor Detail

Alarm

Alarm

Method Detail

getLinks

setLinks

getSchema

setSchema

getSelf

setSelf

getRevision

setRevision

getCreateTime

setCreateTime

getCreateUser

setCreateUser

getLastModifiedTime

setLastModifiedTime

getLastModifiedUser

setLastModifiedUser

getProtection

setProtection

getSystemOwned

setSystemOwned

getDescription

setDescription

getDisplayName

setDisplayName

getId

setId

getResourceType

setResourceType

getTags

setTags

getAlarmSource

setAlarmSource

getAlarmSourceType

setAlarmSourceType

getEntityId

setEntityId

getEntityResourceType

setEntityResourceType

getEventTags

setEventTags

getEventType

setEventType

getEventTypeDisplayName

setEventTypeDisplayName

getFeatureDisplayName

setFeatureDisplayName

getFeatureName

setFeatureName

getKbArticle

setKbArticle

getLastReportedTime

setLastReportedTime

getNodeDisplayName

setNodeDisplayName

getNodeId

setNodeId

getNodeIpAddresses