Package com.vmware.nsx_policy.model
Class SecurityPolicy
- java.lang.Object
-
- com.vmware.nsx_policy.model.SecurityPolicy
-
- All Implemented Interfaces:
com.vmware.vapi.bindings.StaticStructure
,com.vmware.vapi.bindings.Structure
,java.io.Serializable
public final class SecurityPolicy extends java.lang.Object implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
Ordered list of Rules.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SecurityPolicy.Builder
Builder class forSecurityPolicy
.
-
Field Summary
Fields Modifier and Type Field Description protected com.vmware.vapi.data.StructValue
__dynamicStructureFields
static java.lang.String
CONNECTIVITY_PREFERENCE_ALLOWLIST
static java.lang.String
CONNECTIVITY_PREFERENCE_ALLOWLIST_ENABLE_LOGGING
static java.lang.String
CONNECTIVITY_PREFERENCE_DENYLIST
static java.lang.String
CONNECTIVITY_PREFERENCE_DENYLIST_ENABLE_LOGGING
static java.lang.String
CONNECTIVITY_PREFERENCE_NONE
static java.lang.String
CONNECTIVITY_STRATEGY_BLACKLIST
static java.lang.String
CONNECTIVITY_STRATEGY_BLACKLIST_ENABLE_LOGGING
static java.lang.String
CONNECTIVITY_STRATEGY_NONE
static java.lang.String
CONNECTIVITY_STRATEGY_WHITELIST
static java.lang.String
CONNECTIVITY_STRATEGY_WHITELIST_ENABLE_LOGGING
-
Constructor Summary
Constructors Modifier Constructor Description SecurityPolicy()
Default constructor.protected
SecurityPolicy(com.vmware.vapi.data.StructValue __dynamicStructureFields)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method 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 SecurityPolicy
_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 SecurityPolicy
_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.util.List<ApplicationConnectivityStrategy>
getApplicationConnectivityStrategy()
This field indicates the application connectivity policy for the security policy.java.lang.String
getCategory()
- Distributed Firewall - Policy framework provides five pre-defined categories for classifying a security policy.java.util.List<com.vmware.vapi.bindings.Structure>
getChildren()
Subtree for this type within policy tree containing nested elements.java.lang.String
getComments()
Comments for security policy lock/unlock.java.lang.String
getConnectivityPreference()
Possible values are:CONNECTIVITY_PREFERENCE_ALLOWLIST
CONNECTIVITY_PREFERENCE_DENYLIST
CONNECTIVITY_PREFERENCE_ALLOWLIST_ENABLE_LOGGING
CONNECTIVITY_PREFERENCE_DENYLIST_ENABLE_LOGGING
CONNECTIVITY_PREFERENCE_NONE
This field indicates the default connectivity policy for the security policy.java.lang.String
getConnectivityStrategy()
Deprecated.java.lang.Long
getCreateTime()
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.java.lang.String
getCreateUser()
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.java.lang.Long
getDefaultRuleId()
Based on the value of the connectivity strategy, a default rule is created for the security policy.java.lang.String
getDescription()
Description of this resourcejava.lang.String
getDisplayName()
Defaults to ID if not setjava.lang.String
getId()
Unique identifier of this resourcejava.lang.Long
getInternalSequenceNumber()
This field is to indicate the internal sequence number of a policy with respect to the policies across categories.java.lang.Boolean
getIsDefault()
A flag to indicate whether policy is a default policy.java.lang.Long
getLastModifiedTime()
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.java.lang.String
getLastModifiedUser()
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.java.util.List<ResourceLink>
getLinks()
The server will populate this field when returing the resource.java.lang.Boolean
getLocked()
Indicates whether a security policy should be locked.java.lang.String
getLockModifiedBy()
ID of the user who last modified the lock for the secruity policy.java.lang.Long
getLockModifiedTime()
SecurityPolicy locked/unlocked time in epoch milliseconds.java.lang.Boolean
getLoggingEnabled()
Deprecated.java.lang.Boolean
getMarkedForDelete()
Intent objects are not directly deleted from the system when a delete is invoked on them.java.lang.String
getOriginSiteId()
This is a UUID generated by the system for knowing which site owns an object.java.lang.Boolean
getOverridden()
Global intent objects cannot be modified by the user.java.lang.String
getOwnerId()
This is a UUID generated by the system for knowing who owns this object.java.lang.String
getParentPath()
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.java.lang.String
getPath()
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.java.lang.String
getProtection()
Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it.java.lang.String
getRealizationId()
This is a UUID generated by the system for realizing the entity object.java.lang.String
getRelativePath()
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.java.lang.String
getRemotePath()
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.java.lang.String
getResourceType()
The type of this resource.java.lang.Long
getRevision()
The _revision property describes the current revision of the resource.java.lang.Long
getRuleCount()
The count of rules in the policy.java.util.List<Rule>
getRules()
Rules that are a part of this SecurityPolicyjava.lang.String
getSchedulerPath()
Provides a mechanism to apply the rules in this policy for a specified time duration.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.java.util.List<java.lang.String>
getScope()
The list of group paths where the rules in this policy will get applied.SelfResourceLink
getSelf()
java.lang.Long
getSequenceNumber()
This field is used to resolve conflicts between security policies across domains.java.lang.Boolean
getStateful()
Stateful or Stateless nature of security policy is enforced on all rules in this security policy.java.lang.Boolean
getSystemOwned()
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.java.util.List<Tag>
getTags()
Opaque identifiers meaningful to the API userjava.lang.Boolean
getTcpStrict()
Ensures that a 3 way TCP handshake is done before the data packets are sent.java.lang.String
getUniqueId()
This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.int
hashCode()
void
setApplicationConnectivityStrategy(java.util.List<ApplicationConnectivityStrategy> applicationConnectivityStrategy)
This field indicates the application connectivity policy for the security policy.void
setCategory(java.lang.String category)
- Distributed Firewall - Policy framework provides five pre-defined categories for classifying a security policy.void
setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children)
Subtree for this type within policy tree containing nested elements.void
setComments(java.lang.String comments)
Comments for security policy lock/unlock.void
setConnectivityPreference(java.lang.String connectivityPreference)
Possible values are:CONNECTIVITY_PREFERENCE_ALLOWLIST
CONNECTIVITY_PREFERENCE_DENYLIST
CONNECTIVITY_PREFERENCE_ALLOWLIST_ENABLE_LOGGING
CONNECTIVITY_PREFERENCE_DENYLIST_ENABLE_LOGGING
CONNECTIVITY_PREFERENCE_NONE
This field indicates the default connectivity policy for the security policy.void
setConnectivityStrategy(java.lang.String connectivityStrategy)
Deprecated.void
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.void
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.void
setDefaultRuleId(java.lang.Long defaultRuleId)
Based on the value of the connectivity strategy, a default rule is created for the security policy.void
setDescription(java.lang.String description)
Description of this resourcevoid
setDisplayName(java.lang.String displayName)
Defaults to ID if not setvoid
setId(java.lang.String id)
Unique identifier of this resourcevoid
setInternalSequenceNumber(java.lang.Long internalSequenceNumber)
This field is to indicate the internal sequence number of a policy with respect to the policies across categories.void
setIsDefault(java.lang.Boolean isDefault)
A flag to indicate whether policy is a default policy.void
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.void
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.void
setLinks(java.util.List<ResourceLink> links)
The server will populate this field when returing the resource.void
setLocked(java.lang.Boolean locked)
Indicates whether a security policy should be locked.void
setLockModifiedBy(java.lang.String lockModifiedBy)
ID of the user who last modified the lock for the secruity policy.void
setLockModifiedTime(java.lang.Long lockModifiedTime)
SecurityPolicy locked/unlocked time in epoch milliseconds.void
setLoggingEnabled(java.lang.Boolean loggingEnabled)
Deprecated.void
setMarkedForDelete(java.lang.Boolean markedForDelete)
Intent objects are not directly deleted from the system when a delete is invoked on them.void
setOriginSiteId(java.lang.String originSiteId)
This is a UUID generated by the system for knowing which site owns an object.void
setOverridden(java.lang.Boolean overridden)
Global intent objects cannot be modified by the user.void
setOwnerId(java.lang.String ownerId)
This is a UUID generated by the system for knowing who owns this object.void
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.void
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.void
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.void
setRealizationId(java.lang.String realizationId)
This is a UUID generated by the system for realizing the entity object.void
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.void
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.void
setResourceType(java.lang.String resourceType)
The type of this resource.void
setRevision(java.lang.Long revision)
The _revision property describes the current revision of the resource.void
setRuleCount(java.lang.Long ruleCount)
The count of rules in the policy.void
setRules(java.util.List<Rule> rules)
Rules that are a part of this SecurityPolicyvoid
setSchedulerPath(java.lang.String schedulerPath)
Provides a mechanism to apply the rules in this policy for a specified time duration.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
setScope(java.util.List<java.lang.String> scope)
The list of group paths where the rules in this policy will get applied.void
setSelf(SelfResourceLink self)
void
setSequenceNumber(java.lang.Long sequenceNumber)
This field is used to resolve conflicts between security policies across domains.void
setStateful(java.lang.Boolean stateful)
Stateful or Stateless nature of security policy is enforced on all rules in this security policy.void
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.void
setTags(java.util.List<Tag> tags)
Opaque identifiers meaningful to the API uservoid
setTcpStrict(java.lang.Boolean tcpStrict)
Ensures that a 3 way TCP handshake is done before the data packets are sent.void
setUniqueId(java.lang.String uniqueId)
This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.java.lang.String
toString()
-
-
-
Field Detail
-
CONNECTIVITY_PREFERENCE_ALLOWLIST
public static final java.lang.String CONNECTIVITY_PREFERENCE_ALLOWLIST
- See Also:
- Constant Field Values
-
CONNECTIVITY_PREFERENCE_DENYLIST
public static final java.lang.String CONNECTIVITY_PREFERENCE_DENYLIST
- See Also:
- Constant Field Values
-
CONNECTIVITY_PREFERENCE_ALLOWLIST_ENABLE_LOGGING
public static final java.lang.String CONNECTIVITY_PREFERENCE_ALLOWLIST_ENABLE_LOGGING
- See Also:
- Constant Field Values
-
CONNECTIVITY_PREFERENCE_DENYLIST_ENABLE_LOGGING
public static final java.lang.String CONNECTIVITY_PREFERENCE_DENYLIST_ENABLE_LOGGING
- See Also:
- Constant Field Values
-
CONNECTIVITY_PREFERENCE_NONE
public static final java.lang.String CONNECTIVITY_PREFERENCE_NONE
- See Also:
- Constant Field Values
-
CONNECTIVITY_STRATEGY_WHITELIST
public static final java.lang.String CONNECTIVITY_STRATEGY_WHITELIST
- See Also:
- Constant Field Values
-
CONNECTIVITY_STRATEGY_BLACKLIST
public static final java.lang.String CONNECTIVITY_STRATEGY_BLACKLIST
- See Also:
- Constant Field Values
-
CONNECTIVITY_STRATEGY_WHITELIST_ENABLE_LOGGING
public static final java.lang.String CONNECTIVITY_STRATEGY_WHITELIST_ENABLE_LOGGING
- See Also:
- Constant Field Values
-
CONNECTIVITY_STRATEGY_BLACKLIST_ENABLE_LOGGING
public static final java.lang.String CONNECTIVITY_STRATEGY_BLACKLIST_ENABLE_LOGGING
- See Also:
- Constant Field Values
-
CONNECTIVITY_STRATEGY_NONE
public static final java.lang.String CONNECTIVITY_STRATEGY_NONE
- See Also:
- Constant Field Values
-
__dynamicStructureFields
protected 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.
-
getRevision
public java.lang.Long getRevision()
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- Returns:
- The current value of the property.
-
setRevision
public void 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.
-
getCreateTime
public java.lang.Long getCreateTime()
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.- Returns:
- The current value of the property.
-
setCreateTime
public void 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.
-
getCreateUser
public java.lang.String getCreateUser()
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.- Returns:
- The current value of the property.
-
setCreateUser
public void 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.
-
getLastModifiedTime
public java.lang.Long getLastModifiedTime()
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.- Returns:
- The current value of the property.
-
setLastModifiedTime
public void 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.
-
getLastModifiedUser
public java.lang.String getLastModifiedUser()
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.- Returns:
- The current value of the property.
-
setLastModifiedUser
public void 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.
-
getProtection
public java.lang.String getProtection()
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.- Returns:
- The current value of the property.
-
setProtection
public void 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.
-
getSystemOwned
public java.lang.Boolean getSystemOwned()
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.- Returns:
- The current value of the property.
-
setSystemOwned
public void 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.
-
getDescription
public java.lang.String getDescription()
Description of this resource- Returns:
- The current value of the property.
-
setDescription
public void setDescription(java.lang.String description)
Description of this resource- Parameters:
description
- New value for the property.
-
getDisplayName
public java.lang.String getDisplayName()
Defaults to ID if not set- Returns:
- The current value of the property.
-
setDisplayName
public void setDisplayName(java.lang.String displayName)
Defaults to ID if not set- Parameters:
displayName
- New value for the property.
-
getId
public java.lang.String getId()
Unique identifier of this resource- Returns:
- The current value of the property.
-
setId
public void setId(java.lang.String id)
Unique identifier of this resource- Parameters:
id
- New value for the property.
-
getResourceType
public java.lang.String getResourceType()
The type of this resource.- Returns:
- The current value of the property.
-
setResourceType
public void setResourceType(java.lang.String resourceType)
The type of this resource.- Parameters:
resourceType
- New value for the property.
-
getTags
public java.util.List<Tag> getTags()
Opaque identifiers meaningful to the API user- Returns:
- The current value of the property.
-
setTags
public void setTags(java.util.List<Tag> tags)
Opaque identifiers meaningful to the API user- Parameters:
tags
- New value for the property.
-
getOriginSiteId
public java.lang.String getOriginSiteId()
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.- Returns:
- The current value of the property.
-
setOriginSiteId
public void 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.
-
getOwnerId
public java.lang.String getOwnerId()
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.- Returns:
- The current value of the property.
-
setOwnerId
public void 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.
-
getParentPath
public java.lang.String getParentPath()
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.- Returns:
- The current value of the property.
-
setParentPath
public void 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.
-
getPath
public java.lang.String getPath()
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.- Returns:
- The current value of the property.
-
setPath
public void 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.
-
getRealizationId
public java.lang.String getRealizationId()
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.- Returns:
- The current value of the property.
-
setRealizationId
public void 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.
-
getRelativePath
public java.lang.String getRelativePath()
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.- Returns:
- The current value of the property.
-
setRelativePath
public void 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.
-
getRemotePath
public java.lang.String getRemotePath()
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.- Returns:
- The current value of the property.
-
setRemotePath
public void 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.
-
getUniqueId
public java.lang.String getUniqueId()
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.- Returns:
- The current value of the property.
-
setUniqueId
public void 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.
-
getChildren
public java.util.List<com.vmware.vapi.bindings.Structure> getChildren()
Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only.- Returns:
- The current value of 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 inChildPolicyConfigResource
.
-
setChildren
public void 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 inChildPolicyConfigResource
. When methods return a value of this class as a return value, the property will contain all the properties defined inChildPolicyConfigResource
.
-
getMarkedForDelete
public java.lang.Boolean getMarkedForDelete()
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.- Returns:
- The current value of the property.
-
setMarkedForDelete
public void 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.
-
getOverridden
public java.lang.Boolean getOverridden()
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.- Returns:
- The current value of the property.
-
setOverridden
public void 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.
-
getCategory
public java.lang.String getCategory()
- Distributed Firewall - Policy framework provides five pre-defined categories for classifying a security policy. They are \"Ethernet\",\"Emergency\", \"Infrastructure\" \"Environment\" and \"Application\". There is a pre-determined order in which the policy framework manages the priority of these security policies. Ethernet category is for supporting layer 2 firewall rules. The other four categories are applicable for layer 3 rules. Amongst them, the Emergency category has the highest priority followed by Infrastructure, Environment and then Application rules. Administrator can choose to categorize a security policy into the above categories or can choose to leave it empty. If empty it will have the least precedence w.r.t the above four categories. - Edge Firewall - Policy Framework for Edge Firewall provides six pre-defined categories \"Emergency\", \"SystemRules\", \"SharedPreRules\", \"LocalGatewayRules\", \"AutoServiceRules\" and \"Default\", in order of priority of rules. All categories are allowed for Gatetway Policies that belong to 'default' Domain. However, for user created domains, category is restricted to \"SharedPreRules\" or \"LocalGatewayRules\" only. Also, the users can add/modify/delete rules from only the \"SharedPreRules\" and \"LocalGatewayRules\" categories. If user doesn't specify the category then defaulted to \"Rules\". System generated category is used by NSX created rules, for example BFD rules. Autoplumbed category used by NSX verticals to autoplumb data path rules. Finally, \"Default\" category is the placeholder default rules with lowest in the order of priority.- Returns:
- The current value of the property.
-
setCategory
public void setCategory(java.lang.String category)
- Distributed Firewall - Policy framework provides five pre-defined categories for classifying a security policy. They are \"Ethernet\",\"Emergency\", \"Infrastructure\" \"Environment\" and \"Application\". There is a pre-determined order in which the policy framework manages the priority of these security policies. Ethernet category is for supporting layer 2 firewall rules. The other four categories are applicable for layer 3 rules. Amongst them, the Emergency category has the highest priority followed by Infrastructure, Environment and then Application rules. Administrator can choose to categorize a security policy into the above categories or can choose to leave it empty. If empty it will have the least precedence w.r.t the above four categories. - Edge Firewall - Policy Framework for Edge Firewall provides six pre-defined categories \"Emergency\", \"SystemRules\", \"SharedPreRules\", \"LocalGatewayRules\", \"AutoServiceRules\" and \"Default\", in order of priority of rules. All categories are allowed for Gatetway Policies that belong to 'default' Domain. However, for user created domains, category is restricted to \"SharedPreRules\" or \"LocalGatewayRules\" only. Also, the users can add/modify/delete rules from only the \"SharedPreRules\" and \"LocalGatewayRules\" categories. If user doesn't specify the category then defaulted to \"Rules\". System generated category is used by NSX created rules, for example BFD rules. Autoplumbed category used by NSX verticals to autoplumb data path rules. Finally, \"Default\" category is the placeholder default rules with lowest in the order of priority.- Parameters:
category
- New value for the property.
-
getComments
public java.lang.String getComments()
Comments for security policy lock/unlock.- Returns:
- The current value of the property.
-
setComments
public void setComments(java.lang.String comments)
Comments for security policy lock/unlock.- Parameters:
comments
- New value for the property.
-
getInternalSequenceNumber
public java.lang.Long getInternalSequenceNumber()
This field is to indicate the internal sequence number of a policy with respect to the policies across categories. format: int32 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.
-
setInternalSequenceNumber
public void setInternalSequenceNumber(java.lang.Long internalSequenceNumber)
This field is to indicate the internal sequence number of a policy with respect to the policies across categories. format: int32 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:
internalSequenceNumber
- New value for the property.
-
getIsDefault
public java.lang.Boolean getIsDefault()
A flag to indicate whether policy is a default policy. 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.
-
setIsDefault
public void setIsDefault(java.lang.Boolean isDefault)
A flag to indicate whether policy is a default policy. 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:
isDefault
- New value for the property.
-
getLockModifiedBy
public java.lang.String getLockModifiedBy()
ID of the user who last modified the lock for the secruity policy. 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.
-
setLockModifiedBy
public void setLockModifiedBy(java.lang.String lockModifiedBy)
ID of the user who last modified the lock for the secruity policy. 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:
lockModifiedBy
- New value for the property.
-
getLockModifiedTime
public java.lang.Long getLockModifiedTime()
SecurityPolicy locked/unlocked time 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.
-
setLockModifiedTime
public void setLockModifiedTime(java.lang.Long lockModifiedTime)
SecurityPolicy locked/unlocked time 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:
lockModifiedTime
- New value for the property.
-
getLocked
public java.lang.Boolean getLocked()
Indicates whether a security policy should be locked. If the security policy is locked by a user, then no other user would be able to modify this security policy. Once the user releases the lock, other users can update this security policy.- Returns:
- The current value of the property.
-
setLocked
public void setLocked(java.lang.Boolean locked)
Indicates whether a security policy should be locked. If the security policy is locked by a user, then no other user would be able to modify this security policy. Once the user releases the lock, other users can update this security policy.- Parameters:
locked
- New value for the property.
-
getRuleCount
public java.lang.Long getRuleCount()
The count of rules in the policy. format: int32 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.
-
setRuleCount
public void setRuleCount(java.lang.Long ruleCount)
The count of rules in the policy. format: int32 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:
ruleCount
- New value for the property.
-
getSchedulerPath
public java.lang.String getSchedulerPath()
Provides a mechanism to apply the rules in this policy for a specified time duration.- Returns:
- The current value of the property.
-
setSchedulerPath
public void setSchedulerPath(java.lang.String schedulerPath)
Provides a mechanism to apply the rules in this policy for a specified time duration.- Parameters:
schedulerPath
- New value for the property.
-
getScope
public java.util.List<java.lang.String> getScope()
The list of group paths where the rules in this policy will get applied. This scope will take precedence over rule level scope. Supported only for security and redirection policies. In case of RedirectionPolicy, it is expected only when the policy is NS and redirecting to service chain.- Returns:
- The current value of the property.
-
setScope
public void setScope(java.util.List<java.lang.String> scope)
The list of group paths where the rules in this policy will get applied. This scope will take precedence over rule level scope. Supported only for security and redirection policies. In case of RedirectionPolicy, it is expected only when the policy is NS and redirecting to service chain.- Parameters:
scope
- New value for the property.
-
getSequenceNumber
public java.lang.Long getSequenceNumber()
This field is used to resolve conflicts between security policies across domains. In order to change the sequence number of a policy one can fire a POST request on the policy entity with a query parameter action=revise The sequence number field will reflect the value of the computed sequence number upon execution of the above mentioned POST request. For scenarios where the administrator is using a template to update several security policies, the only way to set the sequence number is to explicitly specify the sequence number for each security policy. If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple policies with the same sequence number then their order is not deterministic. If a specific order of policies is desired, then one has to specify unique sequence numbers or use the POST request on the policy entity with a query parameter action=revise to let the framework assign a sequence number. The value of sequence number must be between 0 and 999,999. format: int32- Returns:
- The current value of the property.
-
setSequenceNumber
public void setSequenceNumber(java.lang.Long sequenceNumber)
This field is used to resolve conflicts between security policies across domains. In order to change the sequence number of a policy one can fire a POST request on the policy entity with a query parameter action=revise The sequence number field will reflect the value of the computed sequence number upon execution of the above mentioned POST request. For scenarios where the administrator is using a template to update several security policies, the only way to set the sequence number is to explicitly specify the sequence number for each security policy. If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple policies with the same sequence number then their order is not deterministic. If a specific order of policies is desired, then one has to specify unique sequence numbers or use the POST request on the policy entity with a query parameter action=revise to let the framework assign a sequence number. The value of sequence number must be between 0 and 999,999. format: int32- Parameters:
sequenceNumber
- New value for the property.
-
getStateful
public java.lang.Boolean getStateful()
Stateful or Stateless nature of security policy is enforced on all rules in this security policy. When it is stateful, the state of the network connects are tracked and a stateful packet inspection is performed. Layer3 security policies can be stateful or stateless. By default, they are stateful. Layer2 security policies can only be stateless.- Returns:
- The current value of the property.
-
setStateful
public void setStateful(java.lang.Boolean stateful)
Stateful or Stateless nature of security policy is enforced on all rules in this security policy. When it is stateful, the state of the network connects are tracked and a stateful packet inspection is performed. Layer3 security policies can be stateful or stateless. By default, they are stateful. Layer2 security policies can only be stateless.- Parameters:
stateful
- New value for the property.
-
getTcpStrict
public java.lang.Boolean getTcpStrict()
Ensures that a 3 way TCP handshake is done before the data packets are sent. tcp_strict=true is supported only for stateful security policies. If the tcp_strict flag is not specified and the security policy is stateful, then tcp_strict will be set to true.- Returns:
- The current value of the property.
-
setTcpStrict
public void setTcpStrict(java.lang.Boolean tcpStrict)
Ensures that a 3 way TCP handshake is done before the data packets are sent. tcp_strict=true is supported only for stateful security policies. If the tcp_strict flag is not specified and the security policy is stateful, then tcp_strict will be set to true.- Parameters:
tcpStrict
- New value for the property.
-
getApplicationConnectivityStrategy
public java.util.List<ApplicationConnectivityStrategy> getApplicationConnectivityStrategy()
This field indicates the application connectivity policy for the security policy.- Returns:
- The current value of the property.
-
setApplicationConnectivityStrategy
public void setApplicationConnectivityStrategy(java.util.List<ApplicationConnectivityStrategy> applicationConnectivityStrategy)
This field indicates the application connectivity policy for the security policy.- Parameters:
applicationConnectivityStrategy
- New value for the property.
-
getConnectivityPreference
public java.lang.String getConnectivityPreference()
Possible values are: This field indicates the default connectivity policy for the security policy. Based on the connectivity preference, a default rule for this security policy will be created. An appropriate action will be set on the rule based on the value of the connectivity preference. If NONE is selected or no connectivity preference is specified, then no default rule for the security policy gets created. The default rule that gets created will be a any-any rule and applied to entities specified in the scope of the security policy. Specifying the connectivity_preference without specifying the scope is not allowed. The scope has to be a Group and one cannot specify IPAddress directly in the group that is used as scope. This default rule is only applicable for the Layer3 security policies. ALLOWLIST - Adds a default drop rule. Administrator can then use \"allow\" rules to allow traffic between groups DENYLIST - Adds a default allow rule. Admin can then use \"drop\" rules to block traffic between groups ALLOWLIST_ENABLE_LOGGING - Allowlisting with logging enabled DENYLIST_ENABLE_LOGGING - Denylisting with logging enabled NONE - No default rule is created.- Returns:
- The current value of the property.
-
setConnectivityPreference
public void setConnectivityPreference(java.lang.String connectivityPreference)
Possible values are: This field indicates the default connectivity policy for the security policy. Based on the connectivity preference, a default rule for this security policy will be created. An appropriate action will be set on the rule based on the value of the connectivity preference. If NONE is selected or no connectivity preference is specified, then no default rule for the security policy gets created. The default rule that gets created will be a any-any rule and applied to entities specified in the scope of the security policy. Specifying the connectivity_preference without specifying the scope is not allowed. The scope has to be a Group and one cannot specify IPAddress directly in the group that is used as scope. This default rule is only applicable for the Layer3 security policies. ALLOWLIST - Adds a default drop rule. Administrator can then use \"allow\" rules to allow traffic between groups DENYLIST - Adds a default allow rule. Admin can then use \"drop\" rules to block traffic between groups ALLOWLIST_ENABLE_LOGGING - Allowlisting with logging enabled DENYLIST_ENABLE_LOGGING - Denylisting with logging enabled NONE - No default rule is created.- Parameters:
connectivityPreference
- New value for the property.
-
getConnectivityStrategy
@Deprecated public java.lang.String getConnectivityStrategy()
Deprecated.Possible values are: This field indicates the default connectivity policy for the security policy. Based on the connectivity strategy, a default rule for this security policy will be created. An appropriate action will be set on the rule based on the value of the connectivity strategy. If NONE is selected or no connectivity strategy is specified, then no default rule for the security policy gets created. The default rule that gets created will be a any-any rule and applied to entities specified in the scope of the security policy. Specifying the connectivity_strategy without specifying the scope is not allowed. The scope has to be a Group and one cannot specify IPAddress directly in the group that is used as scope. This default rule is only applicable for the Layer3 security policies. This property is deprecated. Use the type connectivity_preference instead. WHITELIST - Adds a default drop rule. Administrator can then use \"allow\" rules (aka whitelist) to allow traffic between groups BLACKLIST - Adds a default allow rule. Admin can then use \"drop\" rules (aka blacklist) to block traffic between groups WHITELIST_ENABLE_LOGGING - Whitelising with logging enabled BLACKLIST_ENABLE_LOGGING - Blacklisting with logging enabled NONE - No default rule is created.- Returns:
- The current value of the property.
-
setConnectivityStrategy
@Deprecated public void setConnectivityStrategy(java.lang.String connectivityStrategy)
Deprecated.Possible values are: This field indicates the default connectivity policy for the security policy. Based on the connectivity strategy, a default rule for this security policy will be created. An appropriate action will be set on the rule based on the value of the connectivity strategy. If NONE is selected or no connectivity strategy is specified, then no default rule for the security policy gets created. The default rule that gets created will be a any-any rule and applied to entities specified in the scope of the security policy. Specifying the connectivity_strategy without specifying the scope is not allowed. The scope has to be a Group and one cannot specify IPAddress directly in the group that is used as scope. This default rule is only applicable for the Layer3 security policies. This property is deprecated. Use the type connectivity_preference instead. WHITELIST - Adds a default drop rule. Administrator can then use \"allow\" rules (aka whitelist) to allow traffic between groups BLACKLIST - Adds a default allow rule. Admin can then use \"drop\" rules (aka blacklist) to block traffic between groups WHITELIST_ENABLE_LOGGING - Whitelising with logging enabled BLACKLIST_ENABLE_LOGGING - Blacklisting with logging enabled NONE - No default rule is created.- Parameters:
connectivityStrategy
- New value for the property.
-
getDefaultRuleId
public java.lang.Long getDefaultRuleId()
Based on the value of the connectivity strategy, a default rule is created for the security policy. The rule id is internally assigned by the system for this default rule. 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.
-
setDefaultRuleId
public void setDefaultRuleId(java.lang.Long defaultRuleId)
Based on the value of the connectivity strategy, a default rule is created for the security policy. The rule id is internally assigned by the system for this default rule. 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:
defaultRuleId
- New value for the property.
-
getLoggingEnabled
@Deprecated public java.lang.Boolean getLoggingEnabled()
Deprecated.This property is deprecated. Flag to enable logging for all the rules in the security policy. If the value is true then logging will be enabled for all the rules in the security policy. If the value is false, then the rule level logging value will be honored.- Returns:
- The current value of the property.
-
setLoggingEnabled
@Deprecated public void setLoggingEnabled(java.lang.Boolean loggingEnabled)
Deprecated.This property is deprecated. Flag to enable logging for all the rules in the security policy. If the value is true then logging will be enabled for all the rules in the security policy. If the value is false, then the rule level logging value will be honored.- Parameters:
loggingEnabled
- New value for the property.
-
getRules
public java.util.List<Rule> getRules()
Rules that are a part of this SecurityPolicy- Returns:
- The current value of the property.
-
setRules
public void setRules(java.util.List<Rule> rules)
Rules that are a part of this SecurityPolicy- Parameters:
rules
- New value for the property.
-
_getType
public com.vmware.vapi.bindings.type.StructType _getType()
- Specified by:
_getType
in interfacecom.vmware.vapi.bindings.StaticStructure
-
_getDataValue
public com.vmware.vapi.data.StructValue _getDataValue()
- Specified by:
_getDataValue
in interfacecom.vmware.vapi.bindings.Structure
-
_updateDataValue
protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)
-
_validate
public void _validate()
- Specified by:
_validate
in interfacecom.vmware.vapi.bindings.StaticStructure
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Specified by:
toString
in interfacecom.vmware.vapi.bindings.StaticStructure
- Overrides:
toString
in classjava.lang.Object
-
_hasTypeNameOf
public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
- Specified by:
_hasTypeNameOf
in interfacecom.vmware.vapi.bindings.Structure
-
_convertTo
public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)
- Specified by:
_convertTo
in interfacecom.vmware.vapi.bindings.Structure
-
_setDynamicField
public void _setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)
- Specified by:
_setDynamicField
in interfacecom.vmware.vapi.bindings.StaticStructure
-
_getDynamicField
public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)
- Specified by:
_getDynamicField
in interfacecom.vmware.vapi.bindings.StaticStructure
-
_getDynamicFieldNames
public java.util.Set<java.lang.String> _getDynamicFieldNames()
- Specified by:
_getDynamicFieldNames
in interfacecom.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 thisStructure
.
-
_getCanonicalName
public java.lang.String _getCanonicalName()
- Specified by:
_getCanonicalName
in interfacecom.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 SecurityPolicy _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 SecurityPolicy _newInstance2(com.vmware.vapi.data.StructValue structValue)
WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.
-
-