Package com.vmware.nsx_policy.model

Class Rule

  • All Implemented Interfaces:
    com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
    public final class Rule
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
    A rule indicates the action to be performed for various types of traffic flowing between workload groups.
    See Also:
    Serialized Form

    • Nested Class Summary

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

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
        Rule()
      Default constructor.
      protected Rule​(com.vmware.vapi.data.StructValue __dynamicStructureFields)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete 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 Rule _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 Rule _newInstance2​(com.vmware.vapi.data.StructValue structValue)
      WARNING: Internal method, subject to change in future versions.
      Serves as a versioning mechanism.
      void _setDynamicField​(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)  
      protected void _updateDataValue​(com.vmware.vapi.data.StructValue structValue)  
      void _validate()  
      boolean equals​(java.lang.Object obj)  
      java.lang.String getAction()
      Possible values are: ACTION_ALLOW ACTION_DROP ACTION_REJECT ACTION_JUMP_TO_APPLICATION The action to be applied to all the services The JUMP_TO_APPLICATION action is only supported for rules created in the Environment category.
      java.util.List<com.vmware.vapi.bindings.Structure> getChildren()
      Subtree for this type within policy tree containing nested elements.
      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.String getDescription()
      Description of this resource
      java.util.List<java.lang.String> getDestinationGroups()
      We need paths as duplicate names may exist for groups under different domains.
      java.lang.Boolean getDestinationsExcluded()
      If set to true, the rule gets applied on all the groups that are NOT part of the destination groups.
      java.lang.String getDirection()
      Possible values are: DIRECTION_IN DIRECTION_OUT DIRECTION_IN_OUT Define direction of traffic.
      java.lang.Boolean getDisabled()
      Flag to deactivate the rule.
      java.lang.String getDisplayName()
      Defaults to ID if not set
      java.lang.String getId()
      Unique identifier of this resource
      java.lang.String getIpProtocol()
      Possible values are: IP_PROTOCOL_IPV4 IP_PROTOCOL_IPV6 IP_PROTOCOL_IPV4_IPV6 Type of IP packet that should be matched while enforcing the rule.
      java.lang.Boolean getIsDefault()
      A flag to indicate whether rule is a default rule.
      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 getLogged()
      Flag to enable packet logging.
      java.lang.Boolean getMarkedForDelete()
      Intent objects are not directly deleted from the system when a delete is invoked on them.
      java.lang.String getNotes()
      Text for additional notes on changes.
      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.util.List<java.lang.String> getProfiles()
      Holds the list of layer 7 service profile paths.
      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 getRuleId()
      This is a unique 4 byte positive number that is assigned by the system.
      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 policy paths where the rule is applied LR/Edge/T0/T1/LRP etc.
      SelfResourceLink getSelf()  
      java.lang.Long getSequenceNumber()
      This field is used to resolve conflicts between multiple Rules under Security or Gateway Policy for a Domain If no sequence number is specified in the payload, a value of 0 is assigned by default.
      java.util.List<com.vmware.vapi.bindings.Structure> getServiceEntries()
      In order to specify raw services this can be used, along with services which contains path to services.
      java.util.List<java.lang.String> getServices()
      In order to specify all services, use the constant \"ANY\".
      java.util.List<java.lang.String> getSourceGroups()
      We need paths as duplicate names may exist for groups under different domains.
      java.lang.Boolean getSourcesExcluded()
      If set to true, the rule gets applied on all the groups that are NOT part of the source groups.
      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.lang.String getTag()
      User level field which will be printed in CLI and packet logs.
      java.util.List<Tag> getTags()
      Opaque identifiers meaningful to the API user
      java.lang.String getUniqueId()
      This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.
      int hashCode()  
      void setAction​(java.lang.String action)
      Possible values are: ACTION_ALLOW ACTION_DROP ACTION_REJECT ACTION_JUMP_TO_APPLICATION The action to be applied to all the services The JUMP_TO_APPLICATION action is only supported for rules created in the Environment category.
      void setChildren​(java.util.List<com.vmware.vapi.bindings.Structure> children)
      Subtree for this type within policy tree containing nested elements.
      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 setDescription​(java.lang.String description)
      Description of this resource
      void setDestinationGroups​(java.util.List<java.lang.String> destinationGroups)
      We need paths as duplicate names may exist for groups under different domains.
      void setDestinationsExcluded​(java.lang.Boolean destinationsExcluded)
      If set to true, the rule gets applied on all the groups that are NOT part of the destination groups.
      void setDirection​(java.lang.String direction)
      Possible values are: DIRECTION_IN DIRECTION_OUT DIRECTION_IN_OUT Define direction of traffic.
      void setDisabled​(java.lang.Boolean disabled)
      Flag to deactivate the rule.
      void setDisplayName​(java.lang.String displayName)
      Defaults to ID if not set
      void setId​(java.lang.String id)
      Unique identifier of this resource
      void setIpProtocol​(java.lang.String ipProtocol)
      Possible values are: IP_PROTOCOL_IPV4 IP_PROTOCOL_IPV6 IP_PROTOCOL_IPV4_IPV6 Type of IP packet that should be matched while enforcing the rule.
      void setIsDefault​(java.lang.Boolean isDefault)
      A flag to indicate whether rule is a default rule.
      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 setLogged​(java.lang.Boolean logged)
      Flag to enable packet logging.
      void setMarkedForDelete​(java.lang.Boolean markedForDelete)
      Intent objects are not directly deleted from the system when a delete is invoked on them.
      void setNotes​(java.lang.String notes)
      Text for additional notes on changes.
      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 setProfiles​(java.util.List<java.lang.String> profiles)
      Holds the list of layer 7 service profile paths.
      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 setRuleId​(java.lang.Long ruleId)
      This is a unique 4 byte positive number that is assigned by the system.
      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 policy paths where the rule is applied LR/Edge/T0/T1/LRP etc.
      void setSelf​(SelfResourceLink self)  
      void setSequenceNumber​(java.lang.Long sequenceNumber)
      This field is used to resolve conflicts between multiple Rules under Security or Gateway Policy for a Domain If no sequence number is specified in the payload, a value of 0 is assigned by default.
      void setServiceEntries​(java.util.List<com.vmware.vapi.bindings.Structure> serviceEntries)
      In order to specify raw services this can be used, along with services which contains path to services.
      void setServices​(java.util.List<java.lang.String> services)
      In order to specify all services, use the constant \"ANY\".
      void setSourceGroups​(java.util.List<java.lang.String> sourceGroups)
      We need paths as duplicate names may exist for groups under different domains.
      void setSourcesExcluded​(java.lang.Boolean sourcesExcluded)
      If set to true, the rule gets applied on all the groups that are NOT part of the source groups.
      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 setTag​(java.lang.String tag)
      User level field which will be printed in CLI and packet logs.
      void setTags​(java.util.List<Tag> tags)
      Opaque identifiers meaningful to the API user
      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()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Field Detail

      • DIRECTION_IN_OUT

        public static final java.lang.String DIRECTION_IN_OUT
        See Also:
        Constant Field Values

      • IP_PROTOCOL_IPV4

        public static final java.lang.String IP_PROTOCOL_IPV4
        See Also:
        Constant Field Values

      • IP_PROTOCOL_IPV6

        public static final java.lang.String IP_PROTOCOL_IPV6
        See Also:
        Constant Field Values

      • IP_PROTOCOL_IPV4_IPV6

        public static final java.lang.String IP_PROTOCOL_IPV4_IPV6
        See Also:
        Constant Field Values

      • ACTION_JUMP_TO_APPLICATION

        public static final java.lang.String ACTION_JUMP_TO_APPLICATION
        See Also:
        Constant Field Values

      • __dynamicStructureFields

        protected com.vmware.vapi.data.StructValue __dynamicStructureFields

    • Constructor Detail

      • Rule

        public Rule()
        Default constructor.

      • Rule

        protected Rule​(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 in ChildPolicyConfigResource.

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

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

      • getDestinationGroups

        public java.util.List<java.lang.String> getDestinationGroups()
        We need paths as duplicate names may exist for groups under different domains. Along with paths we support IP Address of type IPv4 and IPv6. IP Address can be in one of the format(CIDR, IP Address, Range of IP Address). In order to specify all groups, use the constant \"ANY\". This is case insensitive. If \"ANY\" is used, it should be the ONLY element in the group array. Error will be thrown if ANY is used in conjunction with other values.
        Returns:
        The current value of the property.

      • setDestinationGroups

        public void setDestinationGroups​(java.util.List<java.lang.String> destinationGroups)
        We need paths as duplicate names may exist for groups under different domains. Along with paths we support IP Address of type IPv4 and IPv6. IP Address can be in one of the format(CIDR, IP Address, Range of IP Address). In order to specify all groups, use the constant \"ANY\". This is case insensitive. If \"ANY\" is used, it should be the ONLY element in the group array. Error will be thrown if ANY is used in conjunction with other values.
        Parameters:
        destinationGroups - New value for the property.

      • getDestinationsExcluded

        public java.lang.Boolean getDestinationsExcluded()
        If set to true, the rule gets applied on all the groups that are NOT part of the destination groups. If false, the rule applies to the destination groups
        Returns:
        The current value of the property.

      • setDestinationsExcluded

        public void setDestinationsExcluded​(java.lang.Boolean destinationsExcluded)
        If set to true, the rule gets applied on all the groups that are NOT part of the destination groups. If false, the rule applies to the destination groups
        Parameters:
        destinationsExcluded - New value for the property.

      • setDirection

        public void setDirection​(java.lang.String direction)
        Possible values are: Define direction of traffic.
        Parameters:
        direction - New value for the property.

      • getDisabled

        public java.lang.Boolean getDisabled()
        Flag to deactivate the rule. Default is activated.
        Returns:
        The current value of the property.

      • setDisabled

        public void setDisabled​(java.lang.Boolean disabled)
        Flag to deactivate the rule. Default is activated.
        Parameters:
        disabled - New value for the property.

      • getIpProtocol

        public java.lang.String getIpProtocol()
        Possible values are: Type of IP packet that should be matched while enforcing the rule. The value is set to IPV4_IPV6 for Layer3 rule if not specified. For Layer2/Ether rule the value must be null.
        Returns:
        The current value of the property.

      • setIpProtocol

        public void setIpProtocol​(java.lang.String ipProtocol)
        Possible values are: Type of IP packet that should be matched while enforcing the rule. The value is set to IPV4_IPV6 for Layer3 rule if not specified. For Layer2/Ether rule the value must be null.
        Parameters:
        ipProtocol - New value for the property.

      • getIsDefault

        public java.lang.Boolean getIsDefault()
        A flag to indicate whether rule is a default rule. 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 rule is a default rule. 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.

      • getLogged

        public java.lang.Boolean getLogged()
        Flag to enable packet logging. Default is deactivated.
        Returns:
        The current value of the property.

      • setLogged

        public void setLogged​(java.lang.Boolean logged)
        Flag to enable packet logging. Default is deactivated.
        Parameters:
        logged - New value for the property.

      • getNotes

        public java.lang.String getNotes()
        Text for additional notes on changes.
        Returns:
        The current value of the property.

      • setNotes

        public void setNotes​(java.lang.String notes)
        Text for additional notes on changes.
        Parameters:
        notes - New value for the property.

      • getProfiles

        public java.util.List<java.lang.String> getProfiles()
        Holds the list of layer 7 service profile paths. These profiles accept attributes and sub-attributes of various network services (e.g. L4 AppId, encryption algorithm, domain name, etc) as key value pairs. Instead of Layer 7 service profiles you can use a L7 access profile. One of either Layer 7 service profiles or L7 Access Profile can be used in firewall rule. In case of L7 access profile only one is allowed.
        Returns:
        The current value of the property.

      • setProfiles

        public void setProfiles​(java.util.List<java.lang.String> profiles)
        Holds the list of layer 7 service profile paths. These profiles accept attributes and sub-attributes of various network services (e.g. L4 AppId, encryption algorithm, domain name, etc) as key value pairs. Instead of Layer 7 service profiles you can use a L7 access profile. One of either Layer 7 service profiles or L7 Access Profile can be used in firewall rule. In case of L7 access profile only one is allowed.
        Parameters:
        profiles - New value for the property.

      • getRuleId

        public java.lang.Long getRuleId()
        This is a unique 4 byte positive number that is assigned by the system. This rule id is passed all the way down to the data path. The first 1GB (1000 to 2^30) will be shared by GM and LM with zebra style striped number space. For E.g 1000 to (1Million -1) by LM, (1M - 2M-1) by GM and so on. format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Returns:
        The current value of the property.

      • setRuleId

        public void setRuleId​(java.lang.Long ruleId)
        This is a unique 4 byte positive number that is assigned by the system. This rule id is passed all the way down to the data path. The first 1GB (1000 to 2^30) will be shared by GM and LM with zebra style striped number space. For E.g 1000 to (1Million -1) by LM, (1M - 2M-1) by GM and so on. format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        ruleId - New value for the property.

      • getScope

        public java.util.List<java.lang.String> getScope()
        The list of policy paths where the rule is applied LR/Edge/T0/T1/LRP etc. Note that a given rule can be applied on multiple LRs/LRPs.
        Returns:
        The current value of the property.

      • setScope

        public void setScope​(java.util.List<java.lang.String> scope)
        The list of policy paths where the rule is applied LR/Edge/T0/T1/LRP etc. Note that a given rule can be applied on multiple LRs/LRPs.
        Parameters:
        scope - New value for the property.

      • getSequenceNumber

        public java.lang.Long getSequenceNumber()
        This field is used to resolve conflicts between multiple Rules under Security or Gateway Policy for a Domain If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple rules with the same sequence number then their order is not deterministic. If a specific order of rules is desired, then one has to specify unique sequence numbers or use the POST request on the rule entity with a query parameter action=revise to let the framework assign a sequence number 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 multiple Rules under Security or Gateway Policy for a Domain If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple rules with the same sequence number then their order is not deterministic. If a specific order of rules is desired, then one has to specify unique sequence numbers or use the POST request on the rule entity with a query parameter action=revise to let the framework assign a sequence number format: int32
        Parameters:
        sequenceNumber - New value for the property.

      • getServiceEntries

        public java.util.List<com.vmware.vapi.bindings.Structure> getServiceEntries()
        In order to specify raw services this can be used, along with services which contains path to services. This can be empty or null.
        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 ServiceEntry. When methods return a value of this class as a return value, the property will contain all the properties defined in ServiceEntry.

      • setServiceEntries

        public void setServiceEntries​(java.util.List<com.vmware.vapi.bindings.Structure> serviceEntries)
        In order to specify raw services this can be used, along with services which contains path to services. This can be empty or null.
        Parameters:
        serviceEntries - 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 ServiceEntry. When methods return a value of this class as a return value, the property will contain all the properties defined in ServiceEntry.

      • getServices

        public java.util.List<java.lang.String> getServices()
        In order to specify all services, use the constant \"ANY\". This is case insensitive. If \"ANY\" is used, it should be the ONLY element in the services array. Error will be thrown if ANY is used in conjunction with other values.
        Returns:
        The current value of the property.

      • setServices

        public void setServices​(java.util.List<java.lang.String> services)
        In order to specify all services, use the constant \"ANY\". This is case insensitive. If \"ANY\" is used, it should be the ONLY element in the services array. Error will be thrown if ANY is used in conjunction with other values.
        Parameters:
        services - New value for the property.

      • getSourceGroups

        public java.util.List<java.lang.String> getSourceGroups()
        We need paths as duplicate names may exist for groups under different domains. Along with paths we support IP Address of type IPv4 and IPv6. IP Address can be in one of the format(CIDR, IP Address, Range of IP Address). In order to specify all groups, use the constant \"ANY\". This is case insensitive. If \"ANY\" is used, it should be the ONLY element in the group array. Error will be thrown if ANY is used in conjunction with other values.
        Returns:
        The current value of the property.

      • setSourceGroups

        public void setSourceGroups​(java.util.List<java.lang.String> sourceGroups)
        We need paths as duplicate names may exist for groups under different domains. Along with paths we support IP Address of type IPv4 and IPv6. IP Address can be in one of the format(CIDR, IP Address, Range of IP Address). In order to specify all groups, use the constant \"ANY\". This is case insensitive. If \"ANY\" is used, it should be the ONLY element in the group array. Error will be thrown if ANY is used in conjunction with other values.
        Parameters:
        sourceGroups - New value for the property.

      • getSourcesExcluded

        public java.lang.Boolean getSourcesExcluded()
        If set to true, the rule gets applied on all the groups that are NOT part of the source groups. If false, the rule applies to the source groups
        Returns:
        The current value of the property.

      • setSourcesExcluded

        public void setSourcesExcluded​(java.lang.Boolean sourcesExcluded)
        If set to true, the rule gets applied on all the groups that are NOT part of the source groups. If false, the rule applies to the source groups
        Parameters:
        sourcesExcluded - New value for the property.

      • getTag

        public java.lang.String getTag()
        User level field which will be printed in CLI and packet logs. Even though there is no limitation on length of a tag, internally tag will get truncated after 32 characters.
        Returns:
        The current value of the property.

      • setTag

        public void setTag​(java.lang.String tag)
        User level field which will be printed in CLI and packet logs. Even though there is no limitation on length of a tag, internally tag will get truncated after 32 characters.
        Parameters:
        tag - New value for the property.

      • getAction

        public java.lang.String getAction()
        Possible values are: The action to be applied to all the services The JUMP_TO_APPLICATION action is only supported for rules created in the Environment category. Once a match is hit then the rule processing will jump to the rules present in the Application category, skipping all further rules in the Environment category. If no rules match in the Application category then the default application rule will be hit. This is applicable only for DFW.
        Returns:
        The current value of the property.

      • setAction

        public void setAction​(java.lang.String action)
        Possible values are: The action to be applied to all the services The JUMP_TO_APPLICATION action is only supported for rules created in the Environment category. Once a match is hit then the rule processing will jump to the rules present in the Application category, skipping all further rules in the Environment category. If no rules match in the Application category then the default application rule will be hit. This is applicable only for DFW.
        Parameters:
        action - New value for the property.

      • _getType

        public com.vmware.vapi.bindings.type.StructType _getType()
        Specified by:
        _getType in interface com.vmware.vapi.bindings.StaticStructure

      • _getDataValue

        public com.vmware.vapi.data.StructValue _getDataValue()
        Specified by:
        _getDataValue in interface com.vmware.vapi.bindings.Structure

      • _updateDataValue

        protected void _updateDataValue​(com.vmware.vapi.data.StructValue structValue)

      • _validate

        public void _validate()
        Specified by:
        _validate in interface com.vmware.vapi.bindings.StaticStructure

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Specified by:
        toString in interface com.vmware.vapi.bindings.StaticStructure
        Overrides:
        toString in class java.lang.Object

      • _hasTypeNameOf

        public boolean _hasTypeNameOf​(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
        Specified by:
        _hasTypeNameOf in interface com.vmware.vapi.bindings.Structure

      • _convertTo

        public <T extends com.vmware.vapi.bindings.Structure> T _convertTo​(java.lang.Class<T> clazz)
        Specified by:
        _convertTo in interface com.vmware.vapi.bindings.Structure

      • _setDynamicField

        public void _setDynamicField​(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)
        Specified by:
        _setDynamicField in interface com.vmware.vapi.bindings.StaticStructure

      • _getDynamicField

        public com.vmware.vapi.data.DataValue _getDynamicField​(java.lang.String fieldName)
        Specified by:
        _getDynamicField in interface com.vmware.vapi.bindings.StaticStructure

      • _getDynamicFieldNames

        public java.util.Set<java.lang.String> _getDynamicFieldNames()
        Specified by:
        _getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure

      • _getClassType

        public static com.vmware.vapi.bindings.type.StructType _getClassType()
        WARNING: Internal method, subject to change in future versions.
        Returns:
        StructType instance representing the static bindings type for this Structure.

      • _getCanonicalName

        public java.lang.String _getCanonicalName()
        Specified by:
        _getCanonicalName in interface com.vmware.vapi.bindings.Structure

      • _getCanonicalTypeName

        public static java.lang.String _getCanonicalTypeName()
        Returns the canonical type name. See _getCanonicalName().
        Returns:
        canonical type name

      • _newInstance

        public static Rule _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 Rule _newInstance2​(com.vmware.vapi.data.StructValue structValue)
        WARNING: Internal method, subject to change in future versions.
        Serves as a versioning mechanism.