com.vmware.nsx_policy.model

Class IdsProfile.Builder

java.lang.Object

com.vmware.nsx_policy.model.IdsProfile.Builder

Enclosing class:

IdsProfile

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

Builder class for IdsProfile.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
IdsProfile	build()
IdsProfile.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
IdsProfile.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.
IdsProfile.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.
IdsProfile.Builder	setCriteria(java.util.List<com.vmware.vapi.bindings.Structure> criteria) Represents the filtering criteria for the IDS Profile.
IdsProfile.Builder	setDescription(java.lang.String description) Description of this resource
IdsProfile.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
IdsProfile.Builder	setId(java.lang.String id) Unique identifier of this resource
IdsProfile.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.
IdsProfile.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.
IdsProfile.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
IdsProfile.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
IdsProfile.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
IdsProfile.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
IdsProfile.Builder	setOverriddenSignatures(java.util.List<IdsProfileLocalSignature> overriddenSignatures) Represents the signatures that has been overridden for this Profile.
IdsProfile.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing who owns this object.
IdsProfile.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.
IdsProfile.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.
IdsProfile.Builder	setPcapConfig(IdsPcapConfig pcapConfig)
IdsProfile.Builder	setProfileSeverity(java.util.List<java.lang.String> profileSeverity) Possible values are: IdsProfile.PROFILE_SEVERITY_CRITICAL IdsProfile.PROFILE_SEVERITY_HIGH IdsProfile.PROFILE_SEVERITY_MEDIUM IdsProfile.PROFILE_SEVERITY_LOW IdsProfile.PROFILE_SEVERITY_SUSPICIOUS Represents the severities of signatures which are part of this profile.
IdsProfile.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.
IdsProfile.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
IdsProfile.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.
IdsProfile.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.
IdsProfile.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
IdsProfile.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
IdsProfile.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.
IdsProfile.Builder	setSelf(SelfResourceLink self)
IdsProfile.Builder	setSeverities(java.util.List<IdsProfileSeverity> severities) Represents the severities of signatures which are part of this profile.
IdsProfile.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.
IdsProfile.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
IdsProfile.Builder	setUniqueId(java.lang.String uniqueId) This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.

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

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

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

setCriteria

public IdsProfile.Builder setCriteria(java.util.List<com.vmware.vapi.bindings.Structure> criteria)

Represents the filtering criteria for the IDS Profile. 1. A non-empty criteria list, must be of odd size. In a list, with indices starting from 0, all IdsProfileFilterCriteria must be at even indices, separated by the IdsProfileConjunctionOperator AND at odd indices. 2. There may be at most 7 IdsProfileCriteria objects inside a list.

Parameters:

criteria - 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 IdsProfileCriteria. When methods return a value of this class as a return value, the property will contain all the properties defined in IdsProfileCriteria.

setOverriddenSignatures

public IdsProfile.Builder setOverriddenSignatures(java.util.List<IdsProfileLocalSignature> overriddenSignatures)

Represents the signatures that has been overridden for this Profile.

Parameters:

overriddenSignatures - New value for the property.

setPcapConfig

public IdsProfile.Builder setPcapConfig(IdsPcapConfig pcapConfig)

Parameters:

pcapConfig - New value for the property.

setProfileSeverity

public IdsProfile.Builder setProfileSeverity(java.util.List<java.lang.String> profileSeverity)

Possible values are:

• IdsProfile.PROFILE_SEVERITY_CRITICAL
• IdsProfile.PROFILE_SEVERITY_HIGH
• IdsProfile.PROFILE_SEVERITY_MEDIUM
• IdsProfile.PROFILE_SEVERITY_LOW
• IdsProfile.PROFILE_SEVERITY_SUSPICIOUS

Represents the severities of signatures which are part of this profile.

Parameters:

profileSeverity - New value for the property.

setSeverities

public IdsProfile.Builder setSeverities(java.util.List<IdsProfileSeverity> severities)

Represents the severities of signatures which are part of this profile.

Parameters:

severities - New value for the property.

build

public IdsProfile build()