Package odata.msgraph.client.beta.entity

Class AppleVpnConfiguration

  • All Implemented Interfaces:
    com.github.davidmoten.odata.client.ODataEntityType, com.github.davidmoten.odata.client.ODataType
    Direct Known Subclasses:
    IosVpnConfiguration, MacOSVpnConfiguration
    public class AppleVpnConfiguration
extends DeviceConfiguration
implements com.github.davidmoten.odata.client.ODataEntityType
    “Apple VPN configuration profile.”

    • Field Detail

      • associatedDomains

        protected List<String> associatedDomains

      • associatedDomainsNextLink

        protected String associatedDomainsNextLink

      • connectionName

        protected String connectionName

      • customDataNextLink

        protected String customDataNextLink

      • customKeyValueDataNextLink

        protected String customKeyValueDataNextLink

      • disableOnDemandUserOverride

        protected Boolean disableOnDemandUserOverride

      • disconnectOnIdle

        protected Boolean disconnectOnIdle

      • disconnectOnIdleTimerInSeconds

        protected Integer disconnectOnIdleTimerInSeconds

      • enablePerApp

        protected Boolean enablePerApp

      • enableSplitTunneling

        protected Boolean enableSplitTunneling

      • excludedDomains

        protected List<String> excludedDomains

      • excludedDomainsNextLink

        protected String excludedDomainsNextLink

      • identifier

        protected String identifier

      • loginGroupOrDomain

        protected String loginGroupOrDomain

      • onDemandRulesNextLink

        protected String onDemandRulesNextLink

      • optInToDeviceIdSharing

        protected Boolean optInToDeviceIdSharing

      • realm

        protected String realm

      • safariDomains

        protected List<String> safariDomains

      • safariDomainsNextLink

        protected String safariDomainsNextLink

    • Constructor Detail

      • AppleVpnConfiguration

        protected AppleVpnConfiguration()

    • Method Detail

      • odataTypeName

        public String odataTypeName()
        Specified by:
        odataTypeName in interface com.github.davidmoten.odata.client.ODataType
        Overrides:
        odataTypeName in class DeviceConfiguration

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

      • postInject

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

      • getAssociatedDomains

        public com.github.davidmoten.odata.client.CollectionPage<String> getAssociatedDomains()
        “Associated Domains”
        Returns:
        property associatedDomains

      • withAssociatedDomains

        public AppleVpnConfiguration withAssociatedDomains​(List<String> associatedDomains)
        Returns an immutable copy of this with just the associatedDomains 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 Domains”

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

      • getAssociatedDomains

        public com.github.davidmoten.odata.client.CollectionPage<String> getAssociatedDomains​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “Associated Domains”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property associatedDomains

      • getAuthenticationMethod

        public Optional<VpnAuthenticationMethod> getAuthenticationMethod()
        “Authentication method for this VPN connection.”
        Returns:
        property authenticationMethod

      • withAuthenticationMethod

        public AppleVpnConfiguration withAuthenticationMethod​(VpnAuthenticationMethod 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 for this VPN connection.”

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

      • getConnectionName

        public Optional<String> getConnectionName()
        “Connection name displayed to the user.”
        Returns:
        property connectionName

      • withConnectionName

        public AppleVpnConfiguration withConnectionName​(String connectionName)
        Returns an immutable copy of this with just the connectionName 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 name displayed to the user.”

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

      • withConnectionType

        public AppleVpnConfiguration withConnectionType​(AppleVpnConnectionType 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

      • getCustomData

        public com.github.davidmoten.odata.client.CollectionPage<KeyValue> getCustomData()
        “Custom data when connection type is set to Custom VPN. Use this field to enable functionality not supported by Intune, but available in your VPN solution. Contact your VPN vendor to learn how to add these key/value pairs. This collection can contain a maximum of 25 elements.”
        Returns:
        property customData

      • withCustomData

        public AppleVpnConfiguration withCustomData​(List<KeyValue> customData)
        Returns an immutable copy of this with just the customData 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.

        “Custom data when connection type is set to Custom VPN. Use this field to enable functionality not supported by Intune, but available in your VPN solution. Contact your VPN vendor to learn how to add these key/value pairs. This collection can contain a maximum of 25 elements.”

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

      • getCustomData

        public com.github.davidmoten.odata.client.CollectionPage<KeyValue> getCustomData​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “Custom data when connection type is set to Custom VPN. Use this field to enable functionality not supported by Intune, but available in your VPN solution. Contact your VPN vendor to learn how to add these key/value pairs. This collection can contain a maximum of 25 elements.”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property customData

      • getCustomKeyValueData

        public com.github.davidmoten.odata.client.CollectionPage<KeyValuePair> getCustomKeyValueData()
        “Custom data when connection type is set to Custom VPN. Use this field to enable functionality not supported by Intune, but available in your VPN solution. Contact your VPN vendor to learn how to add these key/value pairs. This collection can contain a maximum of 25 elements.”
        Returns:
        property customKeyValueData

      • withCustomKeyValueData

        public AppleVpnConfiguration withCustomKeyValueData​(List<KeyValuePair> customKeyValueData)
        Returns an immutable copy of this with just the customKeyValueData 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.

        “Custom data when connection type is set to Custom VPN. Use this field to enable functionality not supported by Intune, but available in your VPN solution. Contact your VPN vendor to learn how to add these key/value pairs. This collection can contain a maximum of 25 elements.”

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

      • getCustomKeyValueData

        public com.github.davidmoten.odata.client.CollectionPage<KeyValuePair> getCustomKeyValueData​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “Custom data when connection type is set to Custom VPN. Use this field to enable functionality not supported by Intune, but available in your VPN solution. Contact your VPN vendor to learn how to add these key/value pairs. This collection can contain a maximum of 25 elements.”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property customKeyValueData

      • getDisableOnDemandUserOverride

        public Optional<Boolean> getDisableOnDemandUserOverride()
        “Toggle to prevent user from disabling automatic VPN in the Settings app”
        Returns:
        property disableOnDemandUserOverride

      • withDisableOnDemandUserOverride

        public AppleVpnConfiguration withDisableOnDemandUserOverride​(Boolean disableOnDemandUserOverride)
        Returns an immutable copy of this with just the disableOnDemandUserOverride 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.

        “Toggle to prevent user from disabling automatic VPN in the Settings app”

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

      • getDisconnectOnIdle

        public Optional<Boolean> getDisconnectOnIdle()
        “Whether to disconnect after on-demand connection idles”
        Returns:
        property disconnectOnIdle

      • withDisconnectOnIdle

        public AppleVpnConfiguration withDisconnectOnIdle​(Boolean disconnectOnIdle)
        Returns an immutable copy of this with just the disconnectOnIdle 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.

        “Whether to disconnect after on-demand connection idles”

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

      • getDisconnectOnIdleTimerInSeconds

        public Optional<Integer> getDisconnectOnIdleTimerInSeconds()
        “The length of time in seconds to wait before disconnecting an on-demand connection. Valid values 0 to 65535”
        Returns:
        property disconnectOnIdleTimerInSeconds

      • withDisconnectOnIdleTimerInSeconds

        public AppleVpnConfiguration withDisconnectOnIdleTimerInSeconds​(Integer disconnectOnIdleTimerInSeconds)
        Returns an immutable copy of this with just the disconnectOnIdleTimerInSeconds 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.

        “The length of time in seconds to wait before disconnecting an on-demand connection. Valid values 0 to 65535”

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

      • getEnablePerApp

        public Optional<Boolean> getEnablePerApp()
        “Setting this to true creates Per-App VPN payload which can later be associated with Apps that can trigger this VPN conneciton on the end user's iOS device.”
        Returns:
        property enablePerApp

      • withEnablePerApp

        public AppleVpnConfiguration withEnablePerApp​(Boolean enablePerApp)
        Returns an immutable copy of this with just the enablePerApp 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.

        “Setting this to true creates Per-App VPN payload which can later be associated with Apps that can trigger this VPN conneciton on the end user's iOS device.”

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

      • getEnableSplitTunneling

        public Optional<Boolean> getEnableSplitTunneling()
        “Send all network traffic through VPN.”
        Returns:
        property enableSplitTunneling

      • withEnableSplitTunneling

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

        “Send all network traffic through VPN.”

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

      • getExcludedDomains

        public com.github.davidmoten.odata.client.CollectionPage<String> getExcludedDomains()
        “Domains that are accessed through the public internet instead of through VPN, even when per-app VPN is activated”
        Returns:
        property excludedDomains

      • withExcludedDomains

        public AppleVpnConfiguration withExcludedDomains​(List<String> excludedDomains)
        Returns an immutable copy of this with just the excludedDomains 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.

        “Domains that are accessed through the public internet instead of through VPN, even when per-app VPN is activated”

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

      • getExcludedDomains

        public com.github.davidmoten.odata.client.CollectionPage<String> getExcludedDomains​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “Domains that are accessed through the public internet instead of through VPN, even when per-app VPN is activated”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property excludedDomains

      • getIdentifier

        public Optional<String> getIdentifier()
        “Identifier provided by VPN vendor when connection type is set to Custom VPN. For example: Cisco AnyConnect uses an identifier of the form com.cisco.anyconnect. applevpn.plugin”
        Returns:
        property identifier

      • withIdentifier

        public AppleVpnConfiguration withIdentifier​(String identifier)
        Returns an immutable copy of this with just the identifier 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.

        “Identifier provided by VPN vendor when connection type is set to Custom VPN. For example: Cisco AnyConnect uses an identifier of the form com.cisco.anyconnect. applevpn.plugin”

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

      • getLoginGroupOrDomain

        public Optional<String> getLoginGroupOrDomain()
        “Login group or domain when connection type is set to Dell SonicWALL Mobile Connection.”
        Returns:
        property loginGroupOrDomain

      • withLoginGroupOrDomain

        public AppleVpnConfiguration withLoginGroupOrDomain​(String loginGroupOrDomain)
        Returns an immutable copy of this with just the loginGroupOrDomain 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.

        “Login group or domain when connection type is set to Dell SonicWALL Mobile Connection.”

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

      • getOnDemandRules

        public com.github.davidmoten.odata.client.CollectionPage<VpnOnDemandRule> getOnDemandRules()
        “On-Demand Rules. This collection can contain a maximum of 500 elements.”
        Returns:
        property onDemandRules

      • withOnDemandRules

        public AppleVpnConfiguration withOnDemandRules​(List<VpnOnDemandRule> onDemandRules)
        Returns an immutable copy of this with just the onDemandRules 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.

        “On-Demand Rules. This collection can contain a maximum of 500 elements.”

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

      • getOnDemandRules

        public com.github.davidmoten.odata.client.CollectionPage<VpnOnDemandRule> getOnDemandRules​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “On-Demand Rules. This collection can contain a maximum of 500 elements.”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property onDemandRules

      • getOptInToDeviceIdSharing

        public Optional<Boolean> getOptInToDeviceIdSharing()
        “Opt-In to sharing the device's Id to third-party vpn clients for use during network access control validation.”
        Returns:
        property optInToDeviceIdSharing

      • withOptInToDeviceIdSharing

        public AppleVpnConfiguration withOptInToDeviceIdSharing​(Boolean optInToDeviceIdSharing)
        Returns an immutable copy of this with just the optInToDeviceIdSharing 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.

        “Opt-In to sharing the device's Id to third-party vpn clients for use during network access control validation.”

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

      • getProviderType

        public Optional<VpnProviderType> getProviderType()
        “Provider type for per-app VPN.”
        Returns:
        property providerType

      • withProviderType

        public AppleVpnConfiguration withProviderType​(VpnProviderType providerType)
        Returns an immutable copy of this with just the providerType 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.

        “Provider type for per-app VPN.”

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

      • getProxyServer

        public Optional<VpnProxyServer> getProxyServer()
        “Proxy Server.”
        Returns:
        property proxyServer

      • withProxyServer

        public AppleVpnConfiguration withProxyServer​(VpnProxyServer 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

      • getRealm

        public Optional<String> getRealm()
        “Realm when connection type is set to Pulse Secure.”
        Returns:
        property realm

      • withRealm

        public AppleVpnConfiguration withRealm​(String realm)
        Returns an immutable copy of this with just the realm 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.

        “Realm when connection type is set to Pulse Secure.”

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

      • getRole

        public Optional<String> getRole()
        “Role when connection type is set to Pulse Secure.”
        Returns:
        property role

      • withRole

        public AppleVpnConfiguration withRole​(String role)
        Returns an immutable copy of this with just the role 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.

        “Role when connection type is set to Pulse Secure.”

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

      • getSafariDomains

        public com.github.davidmoten.odata.client.CollectionPage<String> getSafariDomains()
        “Safari domains when this VPN per App setting is enabled. In addition to the apps associated with this VPN, Safari domains specified here will also be able to trigger this VPN connection.”
        Returns:
        property safariDomains

      • withSafariDomains

        public AppleVpnConfiguration withSafariDomains​(List<String> safariDomains)
        Returns an immutable copy of this with just the safariDomains 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.

        “Safari domains when this VPN per App setting is enabled. In addition to the apps associated with this VPN, Safari domains specified here will also be able to trigger this VPN connection.”

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

      • getSafariDomains

        public com.github.davidmoten.odata.client.CollectionPage<String> getSafariDomains​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “Safari domains when this VPN per App setting is enabled. In addition to the apps associated with this VPN, Safari domains specified here will also be able to trigger this VPN connection.”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property safariDomains

      • getServer

        public Optional<VpnServer> getServer()
        “VPN Server on the network. Make sure end users can access this network location.”
        Returns:
        property server

      • withServer

        public AppleVpnConfiguration withServer​(VpnServer server)
        Returns an immutable copy of this with just the server 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.

        “VPN Server on the network. Make sure end users can access this network location.”

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

      • getUnmappedFields

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

      • patch

        public AppleVpnConfiguration patch()
        Submits only changed fields for update and returns an immutable copy of this with changed fields reset.
        Overrides:
        patch in class DeviceConfiguration
        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 AppleVpnConfiguration 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 DeviceConfiguration
        Returns:
        a copy of this with changed fields reset
        Throws:
        com.github.davidmoten.odata.client.ClientException - if HTTP response is not as expected