Class AndroidWorkProfileVpnConfiguration

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

    public class AndroidWorkProfileVpnConfiguration
    extends DeviceConfiguration
    implements com.github.davidmoten.odata.client.ODataEntityType
    “By providing the configurations in this profile you can instruct the Android Work Profile device 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.”
    • Constructor Detail

      • AndroidWorkProfileVpnConfiguration

        protected AndroidWorkProfileVpnConfiguration()
    • Method Detail

      • odataTypeName

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

        public static AndroidWorkProfileVpnConfiguration.Builder builderAndroidWorkProfileVpnConfiguration()
        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 DeviceConfiguration
      • postInject

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

        public Optional<Boolean> getAlwaysOn()
        “Whether or not to enable always-on VPN connection.”
        Returns:
        property alwaysOn
      • withAlwaysOn

        public AndroidWorkProfileVpnConfiguration withAlwaysOn​(Boolean alwaysOn)
        Returns an immutable copy of this with just the alwaysOn 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 or not to enable always-on VPN connection.”

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

        public Optional<Boolean> getAlwaysOnLockdown()
        “If always-on VPN connection is enabled, whether or not to lock network traffic when that VPN is disconnected.”
        Returns:
        property alwaysOnLockdown
      • withAlwaysOnLockdown

        public AndroidWorkProfileVpnConfiguration withAlwaysOnLockdown​(Boolean alwaysOnLockdown)
        Returns an immutable copy of this with just the alwaysOnLockdown 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.

        “If always-on VPN connection is enabled, whether or not to lock network traffic when that VPN is disconnected.”

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

        public Optional<VpnAuthenticationMethod> getAuthenticationMethod()
        “Authentication method.”
        Returns:
        property authenticationMethod
      • withAuthenticationMethod

        public AndroidWorkProfileVpnConfiguration 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.”

        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 AndroidWorkProfileVpnConfiguration 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 AndroidWorkProfileVpnConfiguration withConnectionType​(AndroidWorkProfileVpnConnectionType 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 Citrix. This collection can contain a maximum of 25 elements.”
        Returns:
        property customData
      • withCustomData

        public AndroidWorkProfileVpnConfiguration 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 Citrix. 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 Citrix. 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 Citrix. This collection can contain a maximum of 25 elements.”
        Returns:
        property customKeyValueData
      • withCustomKeyValueData

        public AndroidWorkProfileVpnConfiguration 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 Citrix. 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 Citrix. This collection can contain a maximum of 25 elements.”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property customKeyValueData
      • getFingerprint

        public Optional<String> getFingerprint()
        “Fingerprint is a string that will be used to verify the VPN server can be trusted, which is only applicable when connection type is Check Point Capsule VPN.”
        Returns:
        property fingerprint
      • withFingerprint

        public AndroidWorkProfileVpnConfiguration withFingerprint​(String fingerprint)
        Returns an immutable copy of this with just the fingerprint 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.

        “Fingerprint is a string that will be used to verify the VPN server can be trusted, which is only applicable when connection type is Check Point Capsule VPN.”

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

        public Optional<String> getMicrosoftTunnelSiteId()
        “Microsoft Tunnel site ID.”
        Returns:
        property microsoftTunnelSiteId
      • withMicrosoftTunnelSiteId

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

        “Microsoft Tunnel site ID.”

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

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

        public AndroidWorkProfileVpnConfiguration 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 AndroidWorkProfileVpnConfiguration 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 AndroidWorkProfileVpnConfiguration 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
      • getServers

        public com.github.davidmoten.odata.client.CollectionPage<VpnServer> getServers()
        “List of VPN Servers on the network. Make sure end users can access these network locations. This collection can contain a maximum of 500 elements.”
        Returns:
        property servers
      • withServers

        public AndroidWorkProfileVpnConfiguration withServers​(List<VpnServer> servers)
        Returns an immutable copy of this with just the servers 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.

        “List of VPN Servers on the network. Make sure end users can access these network locations. This collection can contain a maximum of 500 elements.”

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

        public com.github.davidmoten.odata.client.CollectionPage<VpnServer> getServers​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “List of VPN Servers on the network. Make sure end users can access these network locations. This collection can contain a maximum of 500 elements.”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property servers
      • getTargetedMobileApps

        public com.github.davidmoten.odata.client.CollectionPage<AppListItem> getTargetedMobileApps()
        “Targeted mobile apps. This collection can contain a maximum of 500 elements.”
        Returns:
        property targetedMobileApps
      • withTargetedMobileApps

        public AndroidWorkProfileVpnConfiguration withTargetedMobileApps​(List<AppListItem> targetedMobileApps)
        Returns an immutable copy of this with just the targetedMobileApps 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.

        “Targeted mobile apps. This collection can contain a maximum of 500 elements.”

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

        public com.github.davidmoten.odata.client.CollectionPage<AppListItem> getTargetedMobileApps​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “Targeted mobile apps. This collection can contain a maximum of 500 elements.”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property targetedMobileApps
      • getTargetedPackageIds

        public com.github.davidmoten.odata.client.CollectionPage<String> getTargetedPackageIds()
        “Targeted App package IDs.”
        Returns:
        property targetedPackageIds
      • withTargetedPackageIds

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

        “Targeted App package IDs.”

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

        public com.github.davidmoten.odata.client.CollectionPage<String> getTargetedPackageIds​(com.github.davidmoten.odata.client.HttpRequestOptions options)
        “Targeted App package IDs.”
        Parameters:
        options - specify connect and read timeouts
        Returns:
        property targetedPackageIds
      • getIdentityCertificate

        public AndroidWorkProfileCertificateProfileBaseRequest 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 DeviceConfiguration
      • patch

        public AndroidWorkProfileVpnConfiguration 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 AndroidWorkProfileVpnConfiguration 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