Package com.vmware.nsx_policy.model

Class IPSecVpnSession.Builder

    • Constructor Detail

      • Builder

        public Builder()
        Constructor with parameters for the required properties of IPSecVpnSession.

    • Method Detail

      • setLinks

        public IPSecVpnSession.Builder setLinks​(java.util.List<ResourceLink> links)
        The server will populate this field when returing the resource. Ignored on PUT and POST. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        links - New value for the property.

      • setSchema

        public IPSecVpnSession.Builder setSchema​(java.lang.String schema)
        Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        schema - New value for the property.

      • setRevision

        public IPSecVpnSession.Builder setRevision​(java.lang.Long revision)
        The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32
        Parameters:
        revision - New value for the property.

      • setCreateTime

        public IPSecVpnSession.Builder setCreateTime​(java.lang.Long createTime)
        Timestamp of resource creation format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        createTime - New value for the property.

      • setCreateUser

        public IPSecVpnSession.Builder setCreateUser​(java.lang.String createUser)
        ID of the user who created this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        createUser - New value for the property.

      • setLastModifiedTime

        public IPSecVpnSession.Builder setLastModifiedTime​(java.lang.Long lastModifiedTime)
        Timestamp of last modification format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        lastModifiedTime - New value for the property.

      • setLastModifiedUser

        public IPSecVpnSession.Builder setLastModifiedUser​(java.lang.String lastModifiedUser)
        ID of the user who last modified this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        lastModifiedUser - New value for the property.

      • setProtection

        public IPSecVpnSession.Builder setProtection​(java.lang.String protection)
        Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        protection - New value for the property.

      • setSystemOwned

        public IPSecVpnSession.Builder setSystemOwned​(java.lang.Boolean systemOwned)
        Indicates system owned resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        systemOwned - New value for the property.

      • setDescription

        public IPSecVpnSession.Builder setDescription​(java.lang.String description)
        Description of this resource
        Parameters:
        description - New value for the property.

      • setDisplayName

        public IPSecVpnSession.Builder setDisplayName​(java.lang.String displayName)
        Defaults to ID if not set
        Parameters:
        displayName - New value for the property.

      • setId

        public IPSecVpnSession.Builder setId​(java.lang.String id)
        Unique identifier of this resource
        Parameters:
        id - New value for the property.

      • setTags

        public IPSecVpnSession.Builder setTags​(java.util.List<Tag> tags)
        Opaque identifiers meaningful to the API user
        Parameters:
        tags - New value for the property.

      • setOriginSiteId

        public IPSecVpnSession.Builder setOriginSiteId​(java.lang.String originSiteId)
        This is a UUID generated by the system for knowing which site owns an object. This is used in NSX+. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        originSiteId - New value for the property.

      • setOwnerId

        public IPSecVpnSession.Builder setOwnerId​(java.lang.String ownerId)
        This is a UUID generated by the system for knowing who owns this object. This is used in NSX+. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        ownerId - New value for the property.

      • setParentPath

        public IPSecVpnSession.Builder setParentPath​(java.lang.String parentPath)
        Path of its parent This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        parentPath - New value for the property.

      • setPath

        public IPSecVpnSession.Builder setPath​(java.lang.String path)
        Absolute path of this object This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        path - New value for the property.

      • setRealizationId

        public IPSecVpnSession.Builder setRealizationId​(java.lang.String realizationId)
        This is a UUID generated by the system for realizing the entity object. In most cases this should be same as 'unique_id' of the entity. However, in some cases this can be different because of entities have migrated their unique identifier to NSX Policy intent objects later in the timeline and did not use unique_id for realization. Realization id is helpful for users to debug data path to correlate the configuration with corresponding intent. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        realizationId - New value for the property.

      • setRelativePath

        public IPSecVpnSession.Builder setRelativePath​(java.lang.String relativePath)
        Path relative from its parent This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        relativePath - New value for the property.

      • setRemotePath

        public IPSecVpnSession.Builder setRemotePath​(java.lang.String remotePath)
        This is the path of the object on the local managers when queried on the NSX+ service, and path of the object on NSX+ service when queried from the local managers. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        remotePath - New value for the property.

      • setUniqueId

        public IPSecVpnSession.Builder setUniqueId​(java.lang.String uniqueId)
        This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        uniqueId - New value for the property.

      • setChildren

        public IPSecVpnSession.Builder setChildren​(java.util.List<com.vmware.vapi.bindings.Structure> children)
        Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only.
        Parameters:
        children - New value for the property. When clients pass a value of this class as a parameter, the property must contain all the properties defined in ChildPolicyConfigResource. When methods return a value of this class as a return value, the property will contain all the properties defined in ChildPolicyConfigResource.

      • setMarkedForDelete

        public IPSecVpnSession.Builder setMarkedForDelete​(java.lang.Boolean markedForDelete)
        Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        markedForDelete - New value for the property.

      • setOverridden

        public IPSecVpnSession.Builder setOverridden​(java.lang.Boolean overridden)
        Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
        Parameters:
        overridden - New value for the property.

      • setAuthenticationMode

        public IPSecVpnSession.Builder setAuthenticationMode​(java.lang.String authenticationMode)
        Possible values are: Peer authentication mode. PSK - In this mode a secret key shared between local and peer sites is to be used for authentication. The secret key can be a string with a maximum length of 128 characters. CERTIFICATE - In this mode a certificate defined at the global level is to be used for authentication.
        Parameters:
        authenticationMode - New value for the property.

      • setConnectionInitiationMode

        public IPSecVpnSession.Builder setConnectionInitiationMode​(java.lang.String connectionInitiationMode)
        Possible values are: Connection initiation mode used by local endpoint to establish ike connection with peer site. INITIATOR - In this mode local endpoint initiates tunnel setup and will also respond to incoming tunnel setup requests from peer gateway. RESPOND_ONLY - In this mode, local endpoint shall only respond to incoming tunnel setup requests. It shall not initiate the tunnel setup. ON_DEMAND - In this mode local endpoint will initiate tunnel creation once first packet matching the policy rule is received and will also respond to incoming initiation request.
        Parameters:
        connectionInitiationMode - New value for the property.

      • setDpdProfilePath

        public IPSecVpnSession.Builder setDpdProfilePath​(java.lang.String dpdProfilePath)
        Policy path referencing Dead Peer Detection (DPD) profile. Default is set to system default profile.
        Parameters:
        dpdProfilePath - New value for the property.

      • setEnabled

        public IPSecVpnSession.Builder setEnabled​(java.lang.Boolean enabled)
        Enable/Disable IPSec VPN session.
        Parameters:
        enabled - New value for the property.

      • setIkeProfilePath

        public IPSecVpnSession.Builder setIkeProfilePath​(java.lang.String ikeProfilePath)
        Policy path referencing IKE profile to be used. Default is set according to system default profile.
        Parameters:
        ikeProfilePath - New value for the property.

      • setLocalEndpointPath

        public IPSecVpnSession.Builder setLocalEndpointPath​(java.lang.String localEndpointPath)
        Policy path referencing Local endpoint. This property is mandatory on LM. It is required on GM only in case of site_overrides property not provided.
        Parameters:
        localEndpointPath - New value for the property.

      • setPeerAddress

        public IPSecVpnSession.Builder setPeerAddress​(java.lang.String peerAddress)
        Public IPV4 or IPV6 address of the remote device terminating the VPN connection. This property is mandatory on LM. It is required on GM only in case of site_overrides property not provided. Please note that configuring peer_address as IPv6 address is not supported in the deprecated IPSecVpnSession Patch/PUT APIs. format: ip
        Parameters:
        peerAddress - New value for the property.

      • setPeerId

        public IPSecVpnSession.Builder setPeerId​(java.lang.String peerId)
        Peer ID to uniquely identify the peer site. The peer ID is the public IP address of the remote device terminating the VPN tunnel. When NAT is configured for the peer, enter the private IP address of the peer. This property is mandatory on LM. It is required on GM only in case of site_overrides property not provided.
        Parameters:
        peerId - New value for the property.

      • setPsk

        public IPSecVpnSession.Builder setPsk​(java.lang.String psk)
        IPSec Pre-shared key. Maximum length of this field is 128 characters.
        Parameters:
        psk - New value for the property.

      • setSiteOverrides

        public IPSecVpnSession.Builder setSiteOverrides​(java.util.List<SiteOverride> siteOverrides)
        A collection of site specific attributes specificed only on GM
        Parameters:
        siteOverrides - New value for the property.

      • setTunnelProfilePath

        public IPSecVpnSession.Builder setTunnelProfilePath​(java.lang.String tunnelProfilePath)
        Policy path referencing Tunnel profile to be used. Default is set to system default profile.
        Parameters:
        tunnelProfilePath - New value for the property.