com.vmware.nsx_policy.model

Class IdsSignature.Builder

java.lang.Object

com.vmware.nsx_policy.model.IdsSignature.Builder

Enclosing class:

IdsSignature

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

Builder class for IdsSignature.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
IdsSignature	build()
IdsSignature.Builder	setAction(java.lang.String action) Signature action.
IdsSignature.Builder	setAttackTarget(java.lang.String attackTarget) Target of the signature.
IdsSignature.Builder	setCategories(java.util.List<java.lang.String> categories) Possible values are: IdsSignature.CATEGORIES_APPLICATION IdsSignature.CATEGORIES_MALWARE IdsSignature.CATEGORIES_VULNERABILITY Represents the internal categories a signature belongs to.
IdsSignature.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
IdsSignature.Builder	setClassType(java.lang.String classType) Class type of Signature.
IdsSignature.Builder	setConfidence(java.lang.String confidence) Signature's confidence score.
IdsSignature.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.
IdsSignature.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.
IdsSignature.Builder	setCves(java.util.List<java.lang.String> cves) CVE score
IdsSignature.Builder	setCvss(java.lang.String cvss) Possible values are: IdsSignature.CVSS_NONE IdsSignature.CVSS_LOW IdsSignature.CVSS_MEDIUM IdsSignature.CVSS_HIGH IdsSignature.CVSS_CRITICAL Represents the cvss value of a Signature.
IdsSignature.Builder	setCvssScore(java.lang.String cvssScore) Represents the cvss value of a Signature.
IdsSignature.Builder	setCvssv2(java.lang.String cvssv2) Signature cvssv2 score.
IdsSignature.Builder	setCvssv3(java.lang.String cvssv3) Signature cvssv3 score.
IdsSignature.Builder	setDescription(java.lang.String description) Description of this resource
IdsSignature.Builder	setDirection(java.lang.String direction) Source-destination direction.
IdsSignature.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
IdsSignature.Builder	setEnable(java.lang.Boolean enable) Flag which tells whether the signature is enabled or not.
IdsSignature.Builder	setFlow(java.lang.String flow) Flow established from server, from client etc.
IdsSignature.Builder	setId(java.lang.String id) Unique identifier of this resource
IdsSignature.Builder	setImpact(java.lang.String impact) Impact of Signature.
IdsSignature.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.
IdsSignature.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.
IdsSignature.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
IdsSignature.Builder	setMalwareFamily(java.lang.String malwareFamily) Family of the malware tracked in the signature.
IdsSignature.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
IdsSignature.Builder	setMitreAttack(java.util.List<MitreAttack> mitreAttack) Mitre Attack details of Signature.
IdsSignature.Builder	setName(java.lang.String name) Signature name.
IdsSignature.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
IdsSignature.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
IdsSignature.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing who owns this object.
IdsSignature.Builder	setParentPath(java.lang.String parentPath) Path of its parent This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
IdsSignature.Builder	setPath(java.lang.String path) Absolute path of this object This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
IdsSignature.Builder	setPerformanceImpact(java.lang.String performanceImpact) Performance impact of the signature.
IdsSignature.Builder	setPolicy(java.util.List<java.lang.String> policy) Signature policy.
IdsSignature.Builder	setProductAffected(java.lang.String productAffected) Product affected by this signature.
IdsSignature.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.
IdsSignature.Builder	setProtocol(java.lang.String protocol) Protocol used in the packet analysis.
IdsSignature.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
IdsSignature.Builder	setRelativePath(java.lang.String relativePath) Path relative from its parent This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
IdsSignature.Builder	setRemotePath(java.lang.String remotePath) This is the path of the object on the local managers when queried on the NSX+ service, and path of the object on NSX+ service when queried from the local managers.
IdsSignature.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
IdsSignature.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
IdsSignature.Builder	setRiskScore(java.lang.String riskScore) Risk score of signature.
IdsSignature.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.
IdsSignature.Builder	setSelf(SelfResourceLink self)
IdsSignature.Builder	setSeverity(java.lang.String severity) Represents the severity of the Signature.
IdsSignature.Builder	setSignature(java.lang.String signature) Decoded Signature.
IdsSignature.Builder	setSignatureId(java.lang.String signatureId) Represents the Signature's id.
IdsSignature.Builder	setSignatureRevision(java.lang.String signatureRevision) Represents revision of the Signature.
IdsSignature.Builder	setSignatureSeverity(java.lang.String signatureSeverity) Signature vendor set severity of the signature rule.
IdsSignature.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.
IdsSignature.Builder	setTag(java.util.List<java.lang.String> tag) Vendor assigned classification tag.
IdsSignature.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
IdsSignature.Builder	setType(java.util.List<java.lang.String> type) Signature type.
IdsSignature.Builder	setUniqueId(java.lang.String uniqueId) This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.
IdsSignature.Builder	setUrls(java.util.List<java.lang.String> urls) List of mitre attack URLs pertaining to signature

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

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

public IdsSignature.Builder setOriginSiteId(java.lang.String originSiteId)

This is a UUID generated by the system for knowing which site owns an object. This is used in NSX+. 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:

originSiteId - New value for the property.

setOwnerId

public IdsSignature.Builder setOwnerId(java.lang.String ownerId)

This is a UUID generated by the system for knowing who owns this object. This is used in NSX+. 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:

ownerId - New value for the property.

setParentPath

public IdsSignature.Builder setParentPath(java.lang.String parentPath)

Path of its parent 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:

parentPath - New value for the property.

setPath

public IdsSignature.Builder setPath(java.lang.String path)

Absolute path of this object 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:

path - New value for the property.

setRealizationId

public IdsSignature.Builder setRealizationId(java.lang.String realizationId)

This is a UUID generated by the system for realizing the entity object. In most cases this should be same as 'unique_id' of the entity. However, in some cases this can be different because of entities have migrated their unique identifier to NSX Policy intent objects later in the timeline and did not use unique_id for realization. Realization id is helpful for users to debug data path to correlate the configuration with corresponding intent. 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:

realizationId - New value for the property.

setRelativePath

public IdsSignature.Builder setRelativePath(java.lang.String relativePath)

Path relative from its parent 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:

relativePath - New value for the property.

setRemotePath

public IdsSignature.Builder setRemotePath(java.lang.String remotePath)

This is the path of the object on the local managers when queried on the NSX+ service, and path of the object on NSX+ service when queried from the local managers. 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:

remotePath - New value for the property.

setUniqueId

public IdsSignature.Builder setUniqueId(java.lang.String uniqueId)

This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites. 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:

uniqueId - New value for the property.

setChildren

public IdsSignature.Builder setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children)

Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only.

Parameters:

children - New value for the property. When clients pass a value of this class as a parameter, the property must contain all the properties defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the property will contain all the properties defined in ChildPolicyConfigResource.

setMarkedForDelete

public IdsSignature.Builder setMarkedForDelete(java.lang.Boolean markedForDelete)

Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. 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:

markedForDelete - New value for the property.

setOverridden

public IdsSignature.Builder setOverridden(java.lang.Boolean overridden)

Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties. 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:

overridden - New value for the property.

setAction

public IdsSignature.Builder setAction(java.lang.String action)

Signature action.

Parameters:

action - New value for the property.

setAttackTarget

public IdsSignature.Builder setAttackTarget(java.lang.String attackTarget)

Target of the signature.

Parameters:

attackTarget - New value for the property.

setCategories

public IdsSignature.Builder setCategories(java.util.List<java.lang.String> categories)

Possible values are:

• IdsSignature.CATEGORIES_APPLICATION
• IdsSignature.CATEGORIES_MALWARE
• IdsSignature.CATEGORIES_VULNERABILITY

Represents the internal categories a signature belongs to.

Parameters:

categories - New value for the property.

setClassType

public IdsSignature.Builder setClassType(java.lang.String classType)

Class type of Signature.

Parameters:

classType - New value for the property.

setConfidence

public IdsSignature.Builder setConfidence(java.lang.String confidence)

Signature's confidence score.

Parameters:

confidence - New value for the property.

setCves

public IdsSignature.Builder setCves(java.util.List<java.lang.String> cves)

CVE score

Parameters:

cves - New value for the property.

setCvss

public IdsSignature.Builder setCvss(java.lang.String cvss)

Possible values are:

• IdsSignature.CVSS_NONE
• IdsSignature.CVSS_LOW
• IdsSignature.CVSS_MEDIUM
• IdsSignature.CVSS_HIGH
• IdsSignature.CVSS_CRITICAL

Represents the cvss value of a Signature. The value is derived from cvssv3 or cvssv2 score. NONE means cvssv3/cvssv2 score as 0.0 LOW means cvssv3/cvssv2 score as 0.1-3.9 MEDIUM means cvssv3/cvssv2 score as 4.0-6.9 HIGH means cvssv3/cvssv2 score as 7.0-8.9 CRITICAL means cvssv3/cvssv2 score as 9.0-10.0

Parameters:

cvss - New value for the property.

setCvssScore

public IdsSignature.Builder setCvssScore(java.lang.String cvssScore)

Represents the cvss value of a Signature. The value is derived from cvssv3 or cvssv2 score. If cvssv3 exists, then this is the cvssv3 score, else it is the cvssv2 score.

Parameters:

cvssScore - New value for the property.

setCvssv2

public IdsSignature.Builder setCvssv2(java.lang.String cvssv2)

Signature cvssv2 score.

Parameters:

cvssv2 - New value for the property.

setCvssv3

public IdsSignature.Builder setCvssv3(java.lang.String cvssv3)

Signature cvssv3 score.

Parameters:

cvssv3 - New value for the property.

setDirection

public IdsSignature.Builder setDirection(java.lang.String direction)

Source-destination direction.

Parameters:

direction - New value for the property.

setEnable

public IdsSignature.Builder setEnable(java.lang.Boolean enable)

Flag which tells whether the signature is enabled or not.

Parameters:

enable - New value for the property.

setFlow

public IdsSignature.Builder setFlow(java.lang.String flow)

Flow established from server, from client etc.

Parameters:

flow - New value for the property.

setImpact

public IdsSignature.Builder setImpact(java.lang.String impact)

Impact of Signature.

Parameters:

impact - New value for the property.

setMalwareFamily

public IdsSignature.Builder setMalwareFamily(java.lang.String malwareFamily)

Family of the malware tracked in the signature.

Parameters:

malwareFamily - New value for the property.

setMitreAttack

public IdsSignature.Builder setMitreAttack(java.util.List<MitreAttack> mitreAttack)

Mitre Attack details of Signature.

Parameters:

mitreAttack - New value for the property.

setName

public IdsSignature.Builder setName(java.lang.String name)

Signature name.

Parameters:

name - New value for the property.

setPerformanceImpact

public IdsSignature.Builder setPerformanceImpact(java.lang.String performanceImpact)

Performance impact of the signature.

Parameters:

performanceImpact - New value for the property.

setPolicy

public IdsSignature.Builder setPolicy(java.util.List<java.lang.String> policy)

Signature policy.

Parameters:

policy - New value for the property.

setProductAffected

public IdsSignature.Builder setProductAffected(java.lang.String productAffected)

Product affected by this signature.

Parameters:

productAffected - New value for the property.

setProtocol

public IdsSignature.Builder setProtocol(java.lang.String protocol)

Protocol used in the packet analysis.

Parameters:

protocol - New value for the property.

setRiskScore

public IdsSignature.Builder setRiskScore(java.lang.String riskScore)

Risk score of signature.

Parameters:

riskScore - New value for the property.

setSeverity

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

Represents the severity of the Signature.

Parameters:

severity - New value for the property.

setSignature

public IdsSignature.Builder setSignature(java.lang.String signature)

Decoded Signature.

Parameters:

signature - New value for the property.

setSignatureId

public IdsSignature.Builder setSignatureId(java.lang.String signatureId)

Represents the Signature's id.

Parameters:

signatureId - New value for the property.

setSignatureRevision

public IdsSignature.Builder setSignatureRevision(java.lang.String signatureRevision)

Represents revision of the Signature.

Parameters:

signatureRevision - New value for the property.

setSignatureSeverity

public IdsSignature.Builder setSignatureSeverity(java.lang.String signatureSeverity)

Signature vendor set severity of the signature rule.

Parameters:

signatureSeverity - New value for the property.

setTag

public IdsSignature.Builder setTag(java.util.List<java.lang.String> tag)

Vendor assigned classification tag.

Parameters:

tag - New value for the property.

setType

public IdsSignature.Builder setType(java.util.List<java.lang.String> type)

Signature type.

Parameters:

type - New value for the property.

setUrls

public IdsSignature.Builder setUrls(java.util.List<java.lang.String> urls)

List of mitre attack URLs pertaining to signature

Parameters:

urls - New value for the property.

build

public IdsSignature build()