com.vmware.nsx.model

Class Alarm.Builder

java.lang.Object

com.vmware.nsx.model.Alarm.Builder

Enclosing class:

Alarm

public static final class Alarm.Builder
extends java.lang.Object

Builder class for Alarm.

Constructor Summary

Constructors

Constructor and Description
Builder() Constructor with parameters for the required properties of Alarm.

Method Summary

Modifier and Type	Method and Description
Alarm	build()
Alarm.Builder	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.
Alarm.Builder	setAlarmSourceType(java.lang.String alarmSourceType) Possible values are: Alarm.ALARM_SOURCE_TYPE_INTENT_PATH Alarm.ALARM_SOURCE_TYPE_ENTITY_ID Alarm.ALARM_SOURCE_TYPE_SYSTEM_ID Type of alarm source of the Event instance.
Alarm.Builder	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.
Alarm.Builder	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.
Alarm.Builder	setDescription(java.lang.String description) Detailed description of Alarm.
Alarm.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
Alarm.Builder	setEntityId(java.lang.String entityId) The entity that the Event instance applies to.
Alarm.Builder	setEntityResourceType(java.lang.String entityResourceType) The entity type that the Event instance applies to.
Alarm.Builder	setEventTags(java.util.List<java.lang.String> eventTags) Tags applicable to event, for example, INFRASTRUCTURE or INTELLIGENCE.
Alarm.Builder	setEventType(java.lang.String eventType) Name of Event, e.g.
Alarm.Builder	setEventTypeDisplayName(java.lang.String eventTypeDisplayName) Display name of Event type.
Alarm.Builder	setFeatureDisplayName(java.lang.String featureDisplayName) Display name of feature defining this Event.
Alarm.Builder	setFeatureName(java.lang.String featureName) Feature defining this Event, e.g.
Alarm.Builder	setId(java.lang.String id) ID that uniquely identifies an Alarm.
Alarm.Builder	setKbArticle(java.lang.String kbArticle) KB article link that contains more information on this alarm and recommended actions.
Alarm.Builder	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.
Alarm.Builder	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.
Alarm.Builder	setLastReportedTime(java.lang.Long lastReportedTime) Indicates when the corresponding Event instance was last reported in milliseconds since epoch.
Alarm.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
Alarm.Builder	setNodeDisplayName(java.lang.String nodeDisplayName) Display name of node that the event instance applies to.
Alarm.Builder	setNodeId(java.lang.String nodeId) The UUID of the node that the Event instance applies to.
Alarm.Builder	setNodeIpAddresses(java.util.List<java.lang.String> nodeIpAddresses) IP addresses of node that the event instance applies to.
Alarm.Builder	setNodeResourceType(java.lang.String nodeResourceType) The resource type of node that the Event instance applies to eg.
Alarm.Builder	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.
Alarm.Builder	setRecommendedAction(java.lang.String recommendedAction) Recommended action for Alarm.
Alarm.Builder	setReoccurrencesWhileSuppressed(java.lang.Long reoccurrencesWhileSuppressed) The number of reoccurrences since this alarm has been SUPPRESSED.
Alarm.Builder	setResolvedBy(java.lang.String resolvedBy) User ID of the user that set the status value to RESOLVED.
Alarm.Builder	setResolvedTime(java.lang.Long resolvedTime) Indicates when the Alarm was resolved in milliseconds since epoch.
Alarm.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
Alarm.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
Alarm.Builder	setRuntimeData(java.lang.String runtimeData) Runtime data for Alarm.
Alarm.Builder	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.
Alarm.Builder	setSelf(SelfResourceLink self)
Alarm.Builder	setSeverity(java.lang.String severity) Possible values are: Alarm.SEVERITY_CRITICAL Alarm.SEVERITY_HIGH Alarm.SEVERITY_MEDIUM Alarm.SEVERITY_LOW Severity of the Alarm.Can be one of - CRITICAL, HIGH, MEDIUM, LOW.
Alarm.Builder	setStatus(java.lang.String status) Possible values are: Alarm.STATUS_OPEN Alarm.STATUS_ACKNOWLEDGED Alarm.STATUS_SUPPRESSED Alarm.STATUS_RESOLVED Indicate the status which the Alarm is in.
Alarm.Builder	setSummary(java.lang.String summary) Summary description of Alarm.
Alarm.Builder	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.
Alarm.Builder	setSuppressedBy(java.lang.String suppressedBy) User ID of the user that set the status value to SUPPRESSED.
Alarm.Builder	setSuppressStartTime(java.lang.Long suppressStartTime) Indicates when the Alarm was suppressed in milliseconds since epoch.
Alarm.Builder	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.
Alarm.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Constructor with parameters for the required properties of Alarm.

Method Detail

setLinks

public Alarm.Builder 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.

setSchema

public Alarm.Builder 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.

setSelf

public Alarm.Builder setSelf(SelfResourceLink self)

Parameters:

self - New value for the property.

setRevision

public Alarm.Builder 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.

setCreateTime

public Alarm.Builder 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.

setCreateUser

public Alarm.Builder 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.

setLastModifiedTime

public Alarm.Builder 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.

setLastModifiedUser

public Alarm.Builder 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.

setProtection

public Alarm.Builder 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.

setSystemOwned

public Alarm.Builder 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.

setDescription

public Alarm.Builder 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.

setDisplayName

public Alarm.Builder setDisplayName(java.lang.String displayName)

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

public Alarm.Builder 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.

setResourceType

public Alarm.Builder setResourceType(java.lang.String resourceType)

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

public Alarm.Builder setTags(java.util.List<Tag> tags)

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setAlarmSource

public Alarm.Builder 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.

setAlarmSourceType

public Alarm.Builder setAlarmSourceType(java.lang.String alarmSourceType)

Possible values are:

• Alarm.ALARM_SOURCE_TYPE_INTENT_PATH
• Alarm.ALARM_SOURCE_TYPE_ENTITY_ID
• Alarm.ALARM_SOURCE_TYPE_SYSTEM_ID

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.

setEntityId

public Alarm.Builder 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.

setEntityResourceType

public Alarm.Builder 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.

setEventTags

public Alarm.Builder 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.

setEventType

public Alarm.Builder 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.

setEventTypeDisplayName

public Alarm.Builder 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.

setFeatureDisplayName

public Alarm.Builder 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.

setFeatureName

public Alarm.Builder 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.

setKbArticle

public Alarm.Builder 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.

setLastReportedTime

public Alarm.Builder 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.

setNodeDisplayName

public Alarm.Builder 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.

setNodeId

public Alarm.Builder 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.

setNodeIpAddresses

public Alarm.Builder 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.

setNodeResourceType

public Alarm.Builder 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.

setRecommendedAction

public Alarm.Builder 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.

setReoccurrencesWhileSuppressed

public Alarm.Builder 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.

setResolvedBy

public Alarm.Builder 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.

setResolvedTime

public Alarm.Builder 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.

setRuntimeData

public Alarm.Builder 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.

setSeverity

public Alarm.Builder setSeverity(java.lang.String severity)

Possible values are:

• Alarm.SEVERITY_CRITICAL
• Alarm.SEVERITY_HIGH
• Alarm.SEVERITY_MEDIUM
• Alarm.SEVERITY_LOW

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.

setStatus

public Alarm.Builder setStatus(java.lang.String status)

Possible values are:

• Alarm.STATUS_OPEN
• Alarm.STATUS_ACKNOWLEDGED
• Alarm.STATUS_SUPPRESSED
• Alarm.STATUS_RESOLVED

Indicate the status which the Alarm is in.

Parameters:

status - New value for the property.

setSummary

public Alarm.Builder 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.

setSuppressDuration

public Alarm.Builder 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.

setSuppressStartTime

public Alarm.Builder 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.

setSuppressedBy

public Alarm.Builder 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.

build

public Alarm build()