com.vmware.nsx.model

Class MonitoringEvent.Builder

java.lang.Object

com.vmware.nsx.model.MonitoringEvent.Builder

Enclosing class:

MonitoringEvent

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

Builder class for MonitoringEvent.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
MonitoringEvent	build()
MonitoringEvent.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.
MonitoringEvent.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.
MonitoringEvent.Builder	setDescription(java.lang.String description) Detailed description of the event.
MonitoringEvent.Builder	setDescriptionOnClear(java.lang.String descriptionOnClear) Description of Event when an Event instance transitions from True to False.
MonitoringEvent.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
MonitoringEvent.Builder	setEntityResourceType(java.lang.String entityResourceType) Resource Type of entity where this event is applicable eg.
MonitoringEvent.Builder	setEventFalseSnmpOid(java.lang.String eventFalseSnmpOid) Optional field containing OID for SNMP trap sent when Event instance is False.
MonitoringEvent.Builder	setEventTags(java.util.List<java.lang.String> eventTags) Tags applicable to event, for example, INFRASTRUCTURE or INTELLIGENCE.
MonitoringEvent.Builder	setEventTrueSnmpOid(java.lang.String eventTrueSnmpOid) Optional field containing OID for SNMP trap sent when Event instance is True.
MonitoringEvent.Builder	setEventType(java.lang.String eventType) Name of Event, e.g.
MonitoringEvent.Builder	setEventTypeDisplayName(java.lang.String eventTypeDisplayName) Display name of Event type.
MonitoringEvent.Builder	setFeatureDisplayName(java.lang.String featureDisplayName) Display name of feature defining this Event.
MonitoringEvent.Builder	setFeatureName(java.lang.String featureName) Feature defining this Event, e.g.
MonitoringEvent.Builder	setId(java.lang.String id) Unique identifier in the form of feature_name.event_type.
MonitoringEvent.Builder	setIsDisabled(java.lang.Boolean isDisabled) Flag to indicate whether sampling for this Event is off or on.
MonitoringEvent.Builder	setIsSensitivityFixed(java.lang.Boolean isSensitivityFixed) Indicates if the sensitivity property is configurable via the API.
MonitoringEvent.Builder	setIsThresholdFixed(java.lang.Boolean isThresholdFixed) Indicates if the threshold property is configurable via the API.
MonitoringEvent.Builder	setIsThresholdFloatingPoint(java.lang.Boolean isThresholdFloatingPoint) Flag to indicate if the threshold for this Event is a floating point number.
MonitoringEvent.Builder	setKbArticle(java.lang.String kbArticle) KB article link that contains more information on this event and recommended actions.
MonitoringEvent.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.
MonitoringEvent.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.
MonitoringEvent.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
MonitoringEvent.Builder	setMaxThreshold(java.lang.Long maxThreshold) Maximum allowed threshold value if the threshold is configurable and a maximum value is applicable.
MonitoringEvent.Builder	setMaxThresholdFloatingPoint(java.lang.Double maxThresholdFloatingPoint) Maximum allowed floating point threshold value if the threshold_floating_point is configurable and a maximum value is applicable.
MonitoringEvent.Builder	setMinThreshold(java.lang.Long minThreshold) Minimum allowed threshold value if the threshold is configurable and a minimum value is applicable.
MonitoringEvent.Builder	setMinThresholdFloatingPoint(java.lang.Double minThresholdFloatingPoint) Minimum allowed floating point threshold value if the threshold_floating_point is configurable and a minimum value is applicable.
MonitoringEvent.Builder	setNodeTypes(java.util.List<java.lang.String> nodeTypes) Possible values are: MonitoringEvent.NODE_TYPES_AUTONOMOUS_EDGE MonitoringEvent.NODE_TYPES_BMS MonitoringEvent.NODE_TYPES_EDGE MonitoringEvent.NODE_TYPES_ESX MonitoringEvent.NODE_TYPES_GLOBAL_MANAGER MonitoringEvent.NODE_TYPES_INTELLIGENCE MonitoringEvent.NODE_TYPES_KVM MonitoringEvent.NODE_TYPES_MANAGER MonitoringEvent.NODE_TYPES_PUBLIC_CLOUD_GATEWAY MonitoringEvent.NODE_TYPES_DPU MonitoringEvent.NODE_TYPES_AAS Array identifying the nodes on which this Event is applicable.
MonitoringEvent.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.
MonitoringEvent.Builder	setRecommendedAction(java.lang.String recommendedAction) Recommended action for the alarm condition.
MonitoringEvent.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
MonitoringEvent.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
MonitoringEvent.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.
MonitoringEvent.Builder	setSelf(SelfResourceLink self)
MonitoringEvent.Builder	setSensitivity(java.lang.Long sensitivity) Percentage of samples to consider and used in combination with threshold when determining whether an Event instance status is True or False.
MonitoringEvent.Builder	setSeverity(java.lang.String severity) Possible values are: MonitoringEvent.SEVERITY_CRITICAL MonitoringEvent.SEVERITY_HIGH MonitoringEvent.SEVERITY_MEDIUM MonitoringEvent.SEVERITY_LOW Severity of the Event.Can be one of - CRITICAL, HIGH, MEDIUM, LOW.
MonitoringEvent.Builder	setSummary(java.lang.String summary) Summary description of the event.
MonitoringEvent.Builder	setSuppressAlarm(java.lang.Boolean suppressAlarm) Flag to suppress Alarm generation.
MonitoringEvent.Builder	setSuppressSnmpTrap(java.lang.Boolean suppressSnmpTrap) Flag to suppress SNMP trap generation.
MonitoringEvent.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.
MonitoringEvent.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
MonitoringEvent.Builder	setThreshold(java.lang.Long threshold) Threshold to determine if a single sample is True.
MonitoringEvent.Builder	setThresholdFloatingPoint(java.lang.Double thresholdFloatingPoint) Floating point threshold to determine if a single sample is True.
MonitoringEvent.Builder	setThresholdUnitType(java.lang.String thresholdUnitType) Possible values are: MonitoringEvent.THRESHOLD_UNIT_TYPE_DAYS MonitoringEvent.THRESHOLD_UNIT_TYPE_PERCENT MonitoringEvent.THRESHOLD_UNIT_TYPE_SECONDS Identifies the unit type of the threshold value.
MonitoringEvent.Builder	setVisibility(java.lang.String visibility) Possible values are: MonitoringEvent.VISIBILITY_NONE MonitoringEvent.VISIBILITY_READ The visibility property enables enterprise_admin and site_reliability_engineer users to specify whether an event’s corresponding alarm is visible to users assigned tenant roles in a multi-tenant deployment.
MonitoringEvent.Builder	setVisibilityPaths(java.util.List<java.lang.String> visibilityPaths) The visiblity_paths property must be set if visibility is set to TENANT_READ and must not be set if visibility is set to TENANT_NONE or not set.

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 MonitoringEvent.

Method Detail

setLinks

public MonitoringEvent.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 MonitoringEvent.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 MonitoringEvent.Builder setSelf(SelfResourceLink self)

Parameters:

self - New value for the property.

setRevision

public MonitoringEvent.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 MonitoringEvent.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 MonitoringEvent.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 MonitoringEvent.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 MonitoringEvent.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 MonitoringEvent.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 MonitoringEvent.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 MonitoringEvent.Builder setDescription(java.lang.String description)

Detailed description of the 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:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

public MonitoringEvent.Builder setId(java.lang.String id)

Unique identifier in the form of 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:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setDescriptionOnClear

public MonitoringEvent.Builder setDescriptionOnClear(java.lang.String descriptionOnClear)

Description of Event when an Event instance transitions from True to False. 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:

descriptionOnClear - New value for the property.

setEntityResourceType

public MonitoringEvent.Builder setEntityResourceType(java.lang.String entityResourceType)

Resource Type of entity where this event is applicable eg. LogicalSwitch, LogicalPort etc. 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.

setEventFalseSnmpOid

public MonitoringEvent.Builder setEventFalseSnmpOid(java.lang.String eventFalseSnmpOid)

Optional field containing OID for SNMP trap sent when Event instance is False. This value is null if suppress_snmp_trap or suppress_clear_oid is True. 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:

eventFalseSnmpOid - New value for the property.

setEventTags

public MonitoringEvent.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.

setEventTrueSnmpOid

public MonitoringEvent.Builder setEventTrueSnmpOid(java.lang.String eventTrueSnmpOid)

Optional field containing OID for SNMP trap sent when Event instance is True. This value is null if suppress_snmp_trap is True. 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:

eventTrueSnmpOid - New value for the property.

setEventType

public MonitoringEvent.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 MonitoringEvent.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 MonitoringEvent.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 MonitoringEvent.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.

setIsDisabled

public MonitoringEvent.Builder setIsDisabled(java.lang.Boolean isDisabled)

Flag to indicate whether sampling for this Event is off or on.

Parameters:

isDisabled - New value for the property.

setIsSensitivityFixed

public MonitoringEvent.Builder setIsSensitivityFixed(java.lang.Boolean isSensitivityFixed)

Indicates if the sensitivity property is configurable via the API. 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:

isSensitivityFixed - New value for the property.

setIsThresholdFixed

public MonitoringEvent.Builder setIsThresholdFixed(java.lang.Boolean isThresholdFixed)

Indicates if the threshold property is configurable via the API. 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:

isThresholdFixed - New value for the property.

setIsThresholdFloatingPoint

public MonitoringEvent.Builder setIsThresholdFloatingPoint(java.lang.Boolean isThresholdFloatingPoint)

Flag to indicate if the threshold for this Event is a floating point number. If this value is true, the threshold_floating_point property is used to indicate the threshold at runtime; otherwise, the threshold property is used. 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:

isThresholdFloatingPoint - New value for the property.

setKbArticle

public MonitoringEvent.Builder setKbArticle(java.lang.String kbArticle)

KB article link that contains more information on this event 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.

setMaxThreshold

public MonitoringEvent.Builder setMaxThreshold(java.lang.Long maxThreshold)

Maximum allowed threshold value if the threshold is configurable and a maximum value is applicable. 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:

maxThreshold - New value for the property.

setMaxThresholdFloatingPoint

public MonitoringEvent.Builder setMaxThresholdFloatingPoint(java.lang.Double maxThresholdFloatingPoint)

Maximum allowed floating point threshold value if the threshold_floating_point is configurable and a maximum value is applicable. 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:

maxThresholdFloatingPoint - New value for the property.

setMinThreshold

public MonitoringEvent.Builder setMinThreshold(java.lang.Long minThreshold)

Minimum allowed threshold value if the threshold is configurable and a minimum value is applicable. 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:

minThreshold - New value for the property.

setMinThresholdFloatingPoint

public MonitoringEvent.Builder setMinThresholdFloatingPoint(java.lang.Double minThresholdFloatingPoint)

Minimum allowed floating point threshold value if the threshold_floating_point is configurable and a minimum value is applicable. 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:

minThresholdFloatingPoint - New value for the property.

setNodeTypes

public MonitoringEvent.Builder setNodeTypes(java.util.List<java.lang.String> nodeTypes)

Possible values are:

• MonitoringEvent.NODE_TYPES_AUTONOMOUS_EDGE
• MonitoringEvent.NODE_TYPES_BMS
• MonitoringEvent.NODE_TYPES_EDGE
• MonitoringEvent.NODE_TYPES_ESX
• MonitoringEvent.NODE_TYPES_GLOBAL_MANAGER
• MonitoringEvent.NODE_TYPES_INTELLIGENCE
• MonitoringEvent.NODE_TYPES_KVM
• MonitoringEvent.NODE_TYPES_MANAGER
• MonitoringEvent.NODE_TYPES_PUBLIC_CLOUD_GATEWAY
• MonitoringEvent.NODE_TYPES_DPU
• MonitoringEvent.NODE_TYPES_AAS

Array identifying the nodes on which this Event is applicable. Can be one or more of the following values - nsx_public_cloud_gateway, nsx_edge, nsx_esx, nsx_kvm, nsx_manager. 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:

nodeTypes - New value for the property.

setRecommendedAction

public MonitoringEvent.Builder setRecommendedAction(java.lang.String recommendedAction)

Recommended action for the alarm condition. 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.

setSensitivity

public MonitoringEvent.Builder setSensitivity(java.lang.Long sensitivity)

Percentage of samples to consider and used in combination with threshold when determining whether an Event instance status is True or False. Event evaluation uses sampling to determine Event instance status. A higher sensitivity value specifies that more samples are used to ensure accuracy and ignore infrequent or rare spikes in sampled data. format: int64

Parameters:

sensitivity - New value for the property.

setSeverity

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

Possible values are:

• MonitoringEvent.SEVERITY_CRITICAL
• MonitoringEvent.SEVERITY_HIGH
• MonitoringEvent.SEVERITY_MEDIUM
• MonitoringEvent.SEVERITY_LOW

Severity of the Event.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.

setSummary

public MonitoringEvent.Builder setSummary(java.lang.String summary)

Summary description of the 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:

summary - New value for the property.

setSuppressAlarm

public MonitoringEvent.Builder setSuppressAlarm(java.lang.Boolean suppressAlarm)

Flag to suppress Alarm generation. Alarms are not generated for this Event when this is set to True.

Parameters:

suppressAlarm - New value for the property.

setSuppressSnmpTrap

public MonitoringEvent.Builder setSuppressSnmpTrap(java.lang.Boolean suppressSnmpTrap)

Flag to suppress SNMP trap generation. SNMP traps are not sent for this Event when this is set to True.

Parameters:

suppressSnmpTrap - New value for the property.

setThreshold

public MonitoringEvent.Builder setThreshold(java.lang.Long threshold)

Threshold to determine if a single sample is True. For example, if the configured threshold is 95% and the current CPU sample is 99%, then the current sample is considered True. Note, if is_threshold_floating_point is true, the threshold_floating_point property is used to indicate the threshold value. format: int64

Parameters:

threshold - New value for the property.

setThresholdFloatingPoint

public MonitoringEvent.Builder setThresholdFloatingPoint(java.lang.Double thresholdFloatingPoint)

Floating point threshold to determine if a single sample is True. For example, if the configured threshold is 66.6 percent and the sample value is 68.8 percent, the current sample is considered True. Note, if is_threshold_floating_point is false, the threshold property is used to indicate the threshold value.

Parameters:

thresholdFloatingPoint - New value for the property.

setThresholdUnitType

public MonitoringEvent.Builder setThresholdUnitType(java.lang.String thresholdUnitType)

Possible values are:

• MonitoringEvent.THRESHOLD_UNIT_TYPE_DAYS
• MonitoringEvent.THRESHOLD_UNIT_TYPE_PERCENT
• MonitoringEvent.THRESHOLD_UNIT_TYPE_SECONDS

Identifies the unit type of the threshold value. 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:

thresholdUnitType - New value for the property.

setVisibility

public MonitoringEvent.Builder setVisibility(java.lang.String visibility)

Possible values are:

• MonitoringEvent.VISIBILITY_NONE
• MonitoringEvent.VISIBILITY_READ

The visibility property enables enterprise_admin and site_reliability_engineer users to specify whether an event’s corresponding alarm is visible to users assigned tenant roles in a multi-tenant deployment. By default, when the visibility property is not set, tenant users only see an alarm if they have access to the alarming entity per RBAC rules. Setting visibility to TENANT_NONE means even if a tenant user has RBAC access to the alarming entity, the user will not see the alarm. Setting visibility to TENANT_READ means if a tenant user does not have access to the alarming entity, the user will still have read only access to the alarm as long as the user has access to one of the paths specified in the visibility_paths property.

Parameters:

visibility - New value for the property.

setVisibilityPaths

public MonitoringEvent.Builder setVisibilityPaths(java.util.List<java.lang.String> visibilityPaths)

The visiblity_paths property must be set if visibility is set to TENANT_READ and must not be set if visibility is set to TENANT_NONE or not set. If a tenant user in a multi-tenant deployment does not have access to the alarming entity, the user will not be able to access the corresponding alarm unless visibility TENANT_READ is set and the user has access to at least one of the paths specified in visibility_paths.

Parameters:

visibilityPaths - New value for the property.

build

public MonitoringEvent build()