Class Windows10VpnConfiguration

  • All Implemented Interfaces:
    com.github.davidmoten.odata.client.ODataEntityType, com.github.davidmoten.odata.client.ODataType

    public class Windows10VpnConfiguration
    extends WindowsVpnConfiguration
    implements com.github.davidmoten.odata.client.ODataEntityType
    “By providing the configurations in this profile you can instruct the Windows 10 device (desktop or mobile) to connect to desired VPN endpoint. By specifying the authentication method and security types expected by VPN endpoint you can make the VPN connection seamless for end user.”
    • Field Detail

      • associatedAppsNextLink

        protected String associatedAppsNextLink
      • dnsRulesNextLink

        protected String dnsRulesNextLink
      • dnsSuffixesNextLink

        protected String dnsSuffixesNextLink
      • eapXml

        protected byte[] eapXml
      • enableAlwaysOn

        protected Boolean enableAlwaysOn
      • enableConditionalAccess

        protected Boolean enableConditionalAccess
      • enableDeviceTunnel

        protected Boolean enableDeviceTunnel
      • enableDnsRegistration

        protected Boolean enableDnsRegistration
      • enableSingleSignOnWithAlternateCertificate

        protected Boolean enableSingleSignOnWithAlternateCertificate
      • enableSplitTunneling

        protected Boolean enableSplitTunneling
      • microsoftTunnelSiteId

        protected String microsoftTunnelSiteId
      • onlyAssociatedAppsCanUseConnection

        protected Boolean onlyAssociatedAppsCanUseConnection
      • rememberUserCredentials

        protected Boolean rememberUserCredentials
      • routesNextLink

        protected String routesNextLink
      • singleSignOnIssuerHash

        protected String singleSignOnIssuerHash
      • trafficRulesNextLink

        protected String trafficRulesNextLink
      • trustedNetworkDomains

        protected List<String> trustedNetworkDomains
      • trustedNetworkDomainsNextLink

        protected String trustedNetworkDomainsNextLink
      • windowsInformationProtectionDomain

        protected String windowsInformationProtectionDomain
    • Constructor Detail

      • Windows10VpnConfiguration

        protected Windows10VpnConfiguration()
    • Method Detail

      • builderWindows10VpnConfiguration

        public static Windows10VpnConfiguration.Builder builderWindows10VpnConfiguration()
        Returns a builder which is used to create a new instance of this class (given that this class is immutable).
        Returns:
        a new Builder for this class
      • getChangedFields

        public com.github.davidmoten.odata.client.internal.ChangedFields getChangedFields()
        Specified by:
        getChangedFields in interface com.github.davidmoten.odata.client.ODataEntityType
        Overrides:
        getChangedFields in class WindowsVpnConfiguration
      • postInject

        public void postInject​(boolean addKeysToContextPath)
        Specified by:
        postInject in interface com.github.davidmoten.odata.client.ODataType
        Overrides:
        postInject in class WindowsVpnConfiguration
      • getAssociatedApps

        public com.github.davidmoten.odata.client.CollectionPage<Windows10AssociatedApps> getAssociatedApps()
        “Associated Apps. This collection can contain a maximum of 10000 elements.”
        Returns:
        property associatedApps
      • withAssociatedApps

        public Windows10VpnConfiguration withAssociatedApps​(List<Windows10AssociatedApps> associatedApps)
        Returns an immutable copy of this with just the associatedApps field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Associated Apps. This collection can contain a maximum of 10000 elements.”

        Parameters:
        associatedApps - new value of associatedApps field (as defined in service metadata)
        Returns:
        immutable copy of this with just the associatedApps field changed
      • getAssociatedApps

        public com.github.davidmoten.odata.client.CollectionPage<Windows10AssociatedApps> getAssociatedApps​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “Associated Apps. This collection can contain a maximum of 10000 elements.”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property associatedApps
      • withAuthenticationMethod

        public Windows10VpnConfiguration withAuthenticationMethod​(Windows10VpnAuthenticationMethod authenticationMethod)
        Returns an immutable copy of this with just the authenticationMethod field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Authentication method.”

        Parameters:
        authenticationMethod - new value of authenticationMethod field (as defined in service metadata)
        Returns:
        immutable copy of this with just the authenticationMethod field changed
      • withConnectionType

        public Windows10VpnConfiguration withConnectionType​(Windows10VpnConnectionType connectionType)
        Returns an immutable copy of this with just the connectionType field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Connection type.”

        Parameters:
        connectionType - new value of connectionType field (as defined in service metadata)
        Returns:
        immutable copy of this with just the connectionType field changed
      • getCryptographySuite

        public Optional<CryptographySuite> getCryptographySuite()
        “Cryptography Suite security settings for IKEv2 VPN in Windows10 and above”
        Returns:
        property cryptographySuite
      • withCryptographySuite

        public Windows10VpnConfiguration withCryptographySuite​(CryptographySuite cryptographySuite)
        Returns an immutable copy of this with just the cryptographySuite field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Cryptography Suite security settings for IKEv2 VPN in Windows10 and above”

        Parameters:
        cryptographySuite - new value of cryptographySuite field (as defined in service metadata)
        Returns:
        immutable copy of this with just the cryptographySuite field changed
      • getDnsRules

        public com.github.davidmoten.odata.client.CollectionPage<VpnDnsRule> getDnsRules()
        “DNS rules. This collection can contain a maximum of 1000 elements.”
        Returns:
        property dnsRules
      • withDnsRules

        public Windows10VpnConfiguration withDnsRules​(List<VpnDnsRule> dnsRules)
        Returns an immutable copy of this with just the dnsRules field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “DNS rules. This collection can contain a maximum of 1000 elements.”

        Parameters:
        dnsRules - new value of dnsRules field (as defined in service metadata)
        Returns:
        immutable copy of this with just the dnsRules field changed
      • getDnsRules

        public com.github.davidmoten.odata.client.CollectionPage<VpnDnsRule> getDnsRules​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “DNS rules. This collection can contain a maximum of 1000 elements.”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property dnsRules
      • getDnsSuffixes

        public com.github.davidmoten.odata.client.CollectionPage<String> getDnsSuffixes()
        “Specify DNS suffixes to add to the DNS search list to properly route short names .”
        Returns:
        property dnsSuffixes
      • withDnsSuffixes

        public Windows10VpnConfiguration withDnsSuffixes​(List<String> dnsSuffixes)
        Returns an immutable copy of this with just the dnsSuffixes field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Specify DNS suffixes to add to the DNS search list to properly route short names .”

        Parameters:
        dnsSuffixes - new value of dnsSuffixes field (as defined in service metadata)
        Returns:
        immutable copy of this with just the dnsSuffixes field changed
      • getDnsSuffixes

        public com.github.davidmoten.odata.client.CollectionPage<String> getDnsSuffixes​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “Specify DNS suffixes to add to the DNS search list to properly route short names .”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property dnsSuffixes
      • getEapXml

        public Optional<byte[]> getEapXml()
        “Extensible Authentication Protocol (EAP) XML. (UTF8 encoded byte array)”
        Returns:
        property eapXml
      • withEapXml

        public Windows10VpnConfiguration withEapXml​(byte[] eapXml)
        Returns an immutable copy of this with just the eapXml field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Extensible Authentication Protocol (EAP) XML. (UTF8 encoded byte array)”

        Parameters:
        eapXml - new value of eapXml field (as defined in service metadata)
        Returns:
        immutable copy of this with just the eapXml field changed
      • getEnableAlwaysOn

        public Optional<Boolean> getEnableAlwaysOn()
        “Enable Always On mode.”
        Returns:
        property enableAlwaysOn
      • withEnableAlwaysOn

        public Windows10VpnConfiguration withEnableAlwaysOn​(Boolean enableAlwaysOn)
        Returns an immutable copy of this with just the enableAlwaysOn field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Enable Always On mode.”

        Parameters:
        enableAlwaysOn - new value of enableAlwaysOn field (as defined in service metadata)
        Returns:
        immutable copy of this with just the enableAlwaysOn field changed
      • getEnableConditionalAccess

        public Optional<Boolean> getEnableConditionalAccess()
        “Enable conditional access.”
        Returns:
        property enableConditionalAccess
      • withEnableConditionalAccess

        public Windows10VpnConfiguration withEnableConditionalAccess​(Boolean enableConditionalAccess)
        Returns an immutable copy of this with just the enableConditionalAccess field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Enable conditional access.”

        Parameters:
        enableConditionalAccess - new value of enableConditionalAccess field (as defined in service metadata)
        Returns:
        immutable copy of this with just the enableConditionalAccess field changed
      • getEnableDeviceTunnel

        public Optional<Boolean> getEnableDeviceTunnel()
        “Enable device tunnel.”
        Returns:
        property enableDeviceTunnel
      • withEnableDeviceTunnel

        public Windows10VpnConfiguration withEnableDeviceTunnel​(Boolean enableDeviceTunnel)
        Returns an immutable copy of this with just the enableDeviceTunnel field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Enable device tunnel.”

        Parameters:
        enableDeviceTunnel - new value of enableDeviceTunnel field (as defined in service metadata)
        Returns:
        immutable copy of this with just the enableDeviceTunnel field changed
      • getEnableDnsRegistration

        public Optional<Boolean> getEnableDnsRegistration()
        “Enable IP address registration with internal DNS.”
        Returns:
        property enableDnsRegistration
      • withEnableDnsRegistration

        public Windows10VpnConfiguration withEnableDnsRegistration​(Boolean enableDnsRegistration)
        Returns an immutable copy of this with just the enableDnsRegistration field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Enable IP address registration with internal DNS.”

        Parameters:
        enableDnsRegistration - new value of enableDnsRegistration field (as defined in service metadata)
        Returns:
        immutable copy of this with just the enableDnsRegistration field changed
      • getEnableSingleSignOnWithAlternateCertificate

        public Optional<Boolean> getEnableSingleSignOnWithAlternateCertificate()
        “Enable single sign-on (SSO) with alternate certificate.”
        Returns:
        property enableSingleSignOnWithAlternateCertificate
      • withEnableSingleSignOnWithAlternateCertificate

        public Windows10VpnConfiguration withEnableSingleSignOnWithAlternateCertificate​(Boolean enableSingleSignOnWithAlternateCertificate)
        Returns an immutable copy of this with just the enableSingleSignOnWithAlternateCertificate field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Enable single sign-on (SSO) with alternate certificate.”

        Parameters:
        enableSingleSignOnWithAlternateCertificate - new value of enableSingleSignOnWithAlternateCertificate field (as defined in service metadata)
        Returns:
        immutable copy of this with just the enableSingleSignOnWithAlternateCertificate field changed
      • getEnableSplitTunneling

        public Optional<Boolean> getEnableSplitTunneling()
        “Enable split tunneling.”
        Returns:
        property enableSplitTunneling
      • withEnableSplitTunneling

        public Windows10VpnConfiguration withEnableSplitTunneling​(Boolean enableSplitTunneling)
        Returns an immutable copy of this with just the enableSplitTunneling field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Enable split tunneling.”

        Parameters:
        enableSplitTunneling - new value of enableSplitTunneling field (as defined in service metadata)
        Returns:
        immutable copy of this with just the enableSplitTunneling field changed
      • getMicrosoftTunnelSiteId

        public Optional<String> getMicrosoftTunnelSiteId()
        “ID of the Microsoft Tunnel site associated with the VPN profile.”
        Returns:
        property microsoftTunnelSiteId
      • withMicrosoftTunnelSiteId

        public Windows10VpnConfiguration withMicrosoftTunnelSiteId​(String microsoftTunnelSiteId)
        Returns an immutable copy of this with just the microsoftTunnelSiteId field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “ID of the Microsoft Tunnel site associated with the VPN profile.”

        Parameters:
        microsoftTunnelSiteId - new value of microsoftTunnelSiteId field (as defined in service metadata)
        Returns:
        immutable copy of this with just the microsoftTunnelSiteId field changed
      • getOnlyAssociatedAppsCanUseConnection

        public Optional<Boolean> getOnlyAssociatedAppsCanUseConnection()
        “Only associated Apps can use connection (per-app VPN).”
        Returns:
        property onlyAssociatedAppsCanUseConnection
      • withOnlyAssociatedAppsCanUseConnection

        public Windows10VpnConfiguration withOnlyAssociatedAppsCanUseConnection​(Boolean onlyAssociatedAppsCanUseConnection)
        Returns an immutable copy of this with just the onlyAssociatedAppsCanUseConnection field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Only associated Apps can use connection (per-app VPN).”

        Parameters:
        onlyAssociatedAppsCanUseConnection - new value of onlyAssociatedAppsCanUseConnection field (as defined in service metadata)
        Returns:
        immutable copy of this with just the onlyAssociatedAppsCanUseConnection field changed
      • withProfileTarget

        public Windows10VpnConfiguration withProfileTarget​(Windows10VpnProfileTarget profileTarget)
        Returns an immutable copy of this with just the profileTarget field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Profile target type.”

        Parameters:
        profileTarget - new value of profileTarget field (as defined in service metadata)
        Returns:
        immutable copy of this with just the profileTarget field changed
      • withProxyServer

        public Windows10VpnConfiguration withProxyServer​(Windows10VpnProxyServer proxyServer)
        Returns an immutable copy of this with just the proxyServer field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Proxy Server.”

        Parameters:
        proxyServer - new value of proxyServer field (as defined in service metadata)
        Returns:
        immutable copy of this with just the proxyServer field changed
      • getRememberUserCredentials

        public Optional<Boolean> getRememberUserCredentials()
        “Remember user credentials.”
        Returns:
        property rememberUserCredentials
      • withRememberUserCredentials

        public Windows10VpnConfiguration withRememberUserCredentials​(Boolean rememberUserCredentials)
        Returns an immutable copy of this with just the rememberUserCredentials field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Remember user credentials.”

        Parameters:
        rememberUserCredentials - new value of rememberUserCredentials field (as defined in service metadata)
        Returns:
        immutable copy of this with just the rememberUserCredentials field changed
      • getRoutes

        public com.github.davidmoten.odata.client.CollectionPage<VpnRoute> getRoutes()
        “Routes (optional for third-party providers). This collection can contain a maximum of 1000 elements.”
        Returns:
        property routes
      • withRoutes

        public Windows10VpnConfiguration withRoutes​(List<VpnRoute> routes)
        Returns an immutable copy of this with just the routes field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Routes (optional for third-party providers). This collection can contain a maximum of 1000 elements.”

        Parameters:
        routes - new value of routes field (as defined in service metadata)
        Returns:
        immutable copy of this with just the routes field changed
      • getRoutes

        public com.github.davidmoten.odata.client.CollectionPage<VpnRoute> getRoutes​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “Routes (optional for third-party providers). This collection can contain a maximum of 1000 elements.”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property routes
      • getSingleSignOnEku

        public Optional<ExtendedKeyUsage> getSingleSignOnEku()
        “Single sign-on Extended Key Usage (EKU).”
        Returns:
        property singleSignOnEku
      • withSingleSignOnEku

        public Windows10VpnConfiguration withSingleSignOnEku​(ExtendedKeyUsage singleSignOnEku)
        Returns an immutable copy of this with just the singleSignOnEku field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Single sign-on Extended Key Usage (EKU).”

        Parameters:
        singleSignOnEku - new value of singleSignOnEku field (as defined in service metadata)
        Returns:
        immutable copy of this with just the singleSignOnEku field changed
      • getSingleSignOnIssuerHash

        public Optional<String> getSingleSignOnIssuerHash()
        “Single sign-on issuer hash.”
        Returns:
        property singleSignOnIssuerHash
      • withSingleSignOnIssuerHash

        public Windows10VpnConfiguration withSingleSignOnIssuerHash​(String singleSignOnIssuerHash)
        Returns an immutable copy of this with just the singleSignOnIssuerHash field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Single sign-on issuer hash.”

        Parameters:
        singleSignOnIssuerHash - new value of singleSignOnIssuerHash field (as defined in service metadata)
        Returns:
        immutable copy of this with just the singleSignOnIssuerHash field changed
      • getTrafficRules

        public com.github.davidmoten.odata.client.CollectionPage<VpnTrafficRule> getTrafficRules()
        “Traffic rules. This collection can contain a maximum of 1000 elements.”
        Returns:
        property trafficRules
      • withTrafficRules

        public Windows10VpnConfiguration withTrafficRules​(List<VpnTrafficRule> trafficRules)
        Returns an immutable copy of this with just the trafficRules field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this. patch() is called (if available)on the returned object only the changed fields are submitted.

        “Traffic rules. This collection can contain a maximum of 1000 elements.”

        Parameters:
        trafficRules - new value of trafficRules field (as defined in service metadata)
        Returns:
        immutable copy of this with just the trafficRules field changed
      • getTrafficRules

        public com.github.davidmoten.odata.client.CollectionPage<VpnTrafficRule> getTrafficRules​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “Traffic rules. This collection can contain a maximum of 1000 elements.”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property trafficRules
      • getTrustedNetworkDomains

        public com.github.davidmoten.odata.client.CollectionPage<String> getTrustedNetworkDomains()
        “Trusted Network Domains”
        Returns:
        property trustedNetworkDomains
      • withTrustedNetworkDomains

        public Windows10VpnConfiguration withTrustedNetworkDomains​(List<String> trustedNetworkDomains)
        Returns an immutable copy of this with just the trustedNetworkDomains field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Trusted Network Domains”

        Parameters:
        trustedNetworkDomains - new value of trustedNetworkDomains field (as defined in service metadata)
        Returns:
        immutable copy of this with just the trustedNetworkDomains field changed
      • getTrustedNetworkDomains

        public com.github.davidmoten.odata.client.CollectionPage<String> getTrustedNetworkDomains​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “Trusted Network Domains”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property trustedNetworkDomains
      • getWindowsInformationProtectionDomain

        public Optional<String> getWindowsInformationProtectionDomain()
        “Windows Information Protection (WIP) domain to associate with this connection.”
        Returns:
        property windowsInformationProtectionDomain
      • withWindowsInformationProtectionDomain

        public Windows10VpnConfiguration withWindowsInformationProtectionDomain​(String windowsInformationProtectionDomain)
        Returns an immutable copy of this with just the windowsInformationProtectionDomain field changed. Field description below. The field name is also added to an internal map of changed fields in the returned object so that when this.patch() is called (if available)on the returned object only the changed fields are submitted.

        “Windows Information Protection (WIP) domain to associate with this connection.”

        Parameters:
        windowsInformationProtectionDomain - new value of windowsInformationProtectionDomain field (as defined in service metadata)
        Returns:
        immutable copy of this with just the windowsInformationProtectionDomain field changed
      • getIdentityCertificate

        public WindowsCertificateProfileBaseRequest getIdentityCertificate()
        “Identity certificate for client authentication when authentication method is certificate.”
        Returns:
        navigational property identityCertificate
      • getUnmappedFields

        public com.github.davidmoten.odata.client.UnmappedFields getUnmappedFields()
        Specified by:
        getUnmappedFields in interface com.github.davidmoten.odata.client.ODataType
        Overrides:
        getUnmappedFields in class WindowsVpnConfiguration
      • patch

        public Windows10VpnConfiguration patch()
        Submits only changed fields for update and returns an immutable copy of this with changed fields reset.
        Overrides:
        patch in class WindowsVpnConfiguration
        Returns:
        a copy of this with changed fields reset
        Throws:
        com.github.davidmoten.odata.client.ClientException - if HTTP response is not as expected
      • put

        public Windows10VpnConfiguration put()
        Submits all fields for update and returns an immutable copy of this with changed fields reset (they were ignored anyway).
        Overrides:
        put in class WindowsVpnConfiguration
        Returns:
        a copy of this with changed fields reset
        Throws:
        com.github.davidmoten.odata.client.ClientException - if HTTP response is not as expected