IDSEventsSummary (Java SDK for NSX Manager API 4.1.2.0.0)

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class IDSEventsSummary
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Intrusion event with all the event and signature details, each event contains the signature id, name, severity, first and recent occurence, users and VMs affected and other signature metadata.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class IDSEventsSummary.Builder
Builder class for IDSEventsSummary.

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

Field Summary

Fields
Modifier and Type Field and Description

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`

Constructor Summary

Constructors
Modifier Constructor and Description

IDSEventsSummary()
Default constructor.

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

Constructors
Modifier	Constructor and Description
	`IDSEventsSummary()` Default constructor.
`protected`	`IDSEventsSummary(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 IDSEventsSummary`	`_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 IDSEventsSummary`	`_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.lang.Long`	`getAffectedVmCount()` Count of VMs on which a particular signature was detected.
`java.lang.Long`	`getFirstOccurence()` First occurence of the intrusion, in epoch milliseconds.
`com.vmware.vapi.bindings.Structure`	`getIdsflowDetails()` IDS event flow data specific to each IDS event.
`java.lang.Boolean`	`getIsOngoing()` Flag indicating an ongoing intrusion.
`java.lang.Boolean`	`getIsRuleValid()` Indicates if the rule id is valid or not.
`java.lang.Long`	`getLatestOccurence()` Latest occurence of the intrusion, in epoch milliseconds.
`java.util.List<ResourceLink>`	`getLinks()` The server will populate this field when returing the resource.
`java.lang.String`	`getResourceType()` IDSEvent resource type.
`java.lang.Long`	`getRuleId()` The IDS Rule id that detected this particular intrusion.
`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.Long`	`getSignatureId()` Signature ID pertaining to the detected intrusion.
`com.vmware.vapi.bindings.Structure`	`getSignatureMetadata()` Metadata about the detected signature including name, id, severity, product affected, protocol etc.
`java.lang.Long`	`getTotalCount()` Number of times this particular signature was detected.
`com.vmware.vapi.bindings.Structure`	`getUserDetails()` List of users logged into VMs on which a particular signature was detected.
`com.vmware.vapi.bindings.Structure`	`getVmDetails()` List of VMs on which a particular signature was detected with the count.
`int`	`hashCode()`
`void`	`setAffectedVmCount(java.lang.Long affectedVmCount)` Count of VMs on which a particular signature was detected.
`void`	`setFirstOccurence(java.lang.Long firstOccurence)` First occurence of the intrusion, in epoch milliseconds.
`void`	`setIdsflowDetails(com.vmware.vapi.bindings.Structure idsflowDetails)` IDS event flow data specific to each IDS event.
`void`	`setIsOngoing(java.lang.Boolean isOngoing)` Flag indicating an ongoing intrusion.
`void`	`setIsRuleValid(java.lang.Boolean isRuleValid)` Indicates if the rule id is valid or not.
`void`	`setLatestOccurence(java.lang.Long latestOccurence)` Latest occurence of the intrusion, in epoch milliseconds.
`void`	`setLinks(java.util.List<ResourceLink> links)` The server will populate this field when returing the resource.
`void`	`setResourceType(java.lang.String resourceType)` IDSEvent resource type.
`void`	`setRuleId(java.lang.Long ruleId)` The IDS Rule id that detected this particular intrusion.
`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`	`setSignatureId(java.lang.Long signatureId)` Signature ID pertaining to the detected intrusion.
`void`	`setSignatureMetadata(com.vmware.vapi.bindings.Structure signatureMetadata)` Metadata about the detected signature including name, id, severity, product affected, protocol etc.
`void`	`setTotalCount(java.lang.Long totalCount)` Number of times this particular signature was detected.
`void`	`setUserDetails(com.vmware.vapi.bindings.Structure userDetails)` List of users logged into VMs on which a particular signature was detected.
`void`	`setVmDetails(com.vmware.vapi.bindings.Structure vmDetails)` List of VMs on which a particular signature was detected with the count.
`java.lang.String`	`toString()`

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

- Field Detail
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - IDSEventsSummary
```
public IDSEventsSummary()
```
    Default constructor.
  - IDSEventsSummary
```
protected IDSEventsSummary(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.
  - getAffectedVmCount
```
public java.lang.Long getAffectedVmCount()
```
    Count of VMs on which a particular signature was detected. 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.
  - setAffectedVmCount
```
public void setAffectedVmCount(java.lang.Long affectedVmCount)
```
    Count of VMs on which a particular signature was detected. 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:
    
    affectedVmCount - New value for the property.
  - getFirstOccurence
```
public java.lang.Long getFirstOccurence()
```
    First occurence of the intrusion, in epoch milliseconds. 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.
  - setFirstOccurence
```
public void setFirstOccurence(java.lang.Long firstOccurence)
```
    First occurence of the intrusion, in epoch milliseconds. 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:
    
    firstOccurence - New value for the property.
  - getIdsflowDetails
```
public com.vmware.vapi.bindings.Structure getIdsflowDetails()
```
    IDS event flow data specific to each IDS event. The data includes source ip, source port, destination ip, destination port, and protocol. 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.
  - setIdsflowDetails
```
public void setIdsflowDetails(com.vmware.vapi.bindings.Structure idsflowDetails)
```
    IDS event flow data specific to each IDS event. The data includes source ip, source port, destination ip, destination port, and protocol. 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:
    
    idsflowDetails - New value for the property.
  - getIsOngoing
```
public java.lang.Boolean getIsOngoing()
```
    Flag indicating an ongoing intrusion. 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.
  - setIsOngoing
```
public void setIsOngoing(java.lang.Boolean isOngoing)
```
    Flag indicating an ongoing intrusion. 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:
    
    isOngoing - New value for the property.
  - getIsRuleValid
```
public java.lang.Boolean getIsRuleValid()
```
    Indicates if the rule id is valid or not. 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.
  - setIsRuleValid
```
public void setIsRuleValid(java.lang.Boolean isRuleValid)
```
    Indicates if the rule id is valid or not. 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:
    
    isRuleValid - New value for the property.
  - getLatestOccurence
```
public java.lang.Long getLatestOccurence()
```
    Latest occurence of the intrusion, in epoch milliseconds. 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.
  - setLatestOccurence
```
public void setLatestOccurence(java.lang.Long latestOccurence)
```
    Latest occurence of the intrusion, in epoch milliseconds. 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:
    
    latestOccurence - New value for the property.
  - getResourceType
```
public java.lang.String getResourceType()
```
    IDSEvent resource 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.
  - setResourceType
```
public void setResourceType(java.lang.String resourceType)
```
    IDSEvent resource 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:
    
    resourceType - New value for the property.
  - getRuleId
```
public java.lang.Long getRuleId()
```
    The IDS Rule id that detected this particular intrusion. 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.
  - setRuleId
```
public void setRuleId(java.lang.Long ruleId)
```
    The IDS Rule id that detected this particular intrusion. 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:
    
    ruleId - New value for the property.
  - getSignatureId
```
public java.lang.Long getSignatureId()
```
    Signature ID pertaining to the detected intrusion. 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.
  - setSignatureId
```
public void setSignatureId(java.lang.Long signatureId)
```
    Signature ID pertaining to the detected intrusion. 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:
    
    signatureId - New value for the property.
  - getSignatureMetadata
```
public com.vmware.vapi.bindings.Structure getSignatureMetadata()
```
    Metadata about the detected signature including name, id, severity, product affected, protocol 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.
    
    Returns:
    
    The current value of the property.
  - setSignatureMetadata
```
public void setSignatureMetadata(com.vmware.vapi.bindings.Structure signatureMetadata)
```
    Metadata about the detected signature including name, id, severity, product affected, protocol 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:
    
    signatureMetadata - New value for the property.
  - getTotalCount
```
public java.lang.Long getTotalCount()
```
    Number of times this particular signature was detected. 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.
  - setTotalCount
```
public void setTotalCount(java.lang.Long totalCount)
```
    Number of times this particular signature was detected. 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:
    
    totalCount - New value for the property.
  - getUserDetails
```
public com.vmware.vapi.bindings.Structure getUserDetails()
```
    List of users logged into VMs on which a particular signature was detected. 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.
  - setUserDetails
```
public void setUserDetails(com.vmware.vapi.bindings.Structure userDetails)
```
    List of users logged into VMs on which a particular signature was detected. 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:
    
    userDetails - New value for the property.
  - getVmDetails
```
public com.vmware.vapi.bindings.Structure getVmDetails()
```
    List of VMs on which a particular signature was detected with the count. 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.
  - setVmDetails
```
public void setVmDetails(com.vmware.vapi.bindings.Structure vmDetails)
```
    List of VMs on which a particular signature was detected with the count. 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:
    
    vmDetails - 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 IDSEventsSummary _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 IDSEventsSummary _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class IDSEventsSummary

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

IDSEventsSummary

IDSEventsSummary

Method Detail

getLinks

setLinks

getSchema

setSchema

getSelf

setSelf

getAffectedVmCount

setAffectedVmCount

getFirstOccurence

setFirstOccurence

getIdsflowDetails

setIdsflowDetails

getIsOngoing

setIsOngoing

getIsRuleValid

setIsRuleValid

getLatestOccurence

setLatestOccurence

getResourceType

setResourceType

getRuleId

setRuleId

getSignatureId

setSignatureId

getSignatureMetadata

setSignatureMetadata

getTotalCount

setTotalCount

getUserDetails

setUserDetails

getVmDetails

setVmDetails

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2