Package odata.msgraph.client.beta.entity

Class IosikEv2VpnConfiguration

  • All Implemented Interfaces:
    com.github.davidmoten.odata.client.ODataEntityType, com.github.davidmoten.odata.client.ODataType
    public class IosikEv2VpnConfiguration
extends IosVpnConfiguration
implements com.github.davidmoten.odata.client.ODataEntityType
    “By providing the configurations in this profile you can instruct the iOS device to connect to desired IKEv2 VPN endpoint.”

    • Field Detail

      • allowDefaultChildSecurityAssociationParameters

        protected Boolean allowDefaultChildSecurityAssociationParameters

      • allowDefaultSecurityAssociationParameters

        protected Boolean allowDefaultSecurityAssociationParameters

      • disableMobilityAndMultihoming

        protected Boolean disableMobilityAndMultihoming

      • disableRedirect

        protected Boolean disableRedirect

      • enableAlwaysOnConfiguration

        protected Boolean enableAlwaysOnConfiguration

      • enableCertificateRevocationCheck

        protected Boolean enableCertificateRevocationCheck

      • enableEAP

        protected Boolean enableEAP

      • enablePerfectForwardSecrecy

        protected Boolean enablePerfectForwardSecrecy

      • enableUseInternalSubnetAttributes

        protected Boolean enableUseInternalSubnetAttributes

      • mtuSizeInBytes

        protected Integer mtuSizeInBytes

      • remoteIdentifier

        protected String remoteIdentifier

      • serverCertificateCommonName

        protected String serverCertificateCommonName

      • serverCertificateIssuerCommonName

        protected String serverCertificateIssuerCommonName

      • sharedSecret

        protected String sharedSecret

      • tlsMaximumVersion

        protected String tlsMaximumVersion

      • tlsMinimumVersion

        protected String tlsMinimumVersion

    • Constructor Detail

      • IosikEv2VpnConfiguration

        protected IosikEv2VpnConfiguration()

    • Method Detail

      • odataTypeName

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

      • builderIosikEv2VpnConfiguration

        public static IosikEv2VpnConfiguration.Builder builderIosikEv2VpnConfiguration()
        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 IosVpnConfiguration

      • postInject

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

      • getAllowDefaultChildSecurityAssociationParameters

        public Optional<Boolean> getAllowDefaultChildSecurityAssociationParameters()
        “Allows the use of child security association parameters by setting all parameters to the device's default unless explicitly specified.”
        Returns:
        property allowDefaultChildSecurityAssociationParameters

      • withAllowDefaultChildSecurityAssociationParameters

        public IosikEv2VpnConfiguration withAllowDefaultChildSecurityAssociationParameters​(Boolean allowDefaultChildSecurityAssociationParameters)
        Returns an immutable copy of this with just the allowDefaultChildSecurityAssociationParameters 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.

        “Allows the use of child security association parameters by setting all parameters to the device's default unless explicitly specified.”

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

      • getAllowDefaultSecurityAssociationParameters

        public Optional<Boolean> getAllowDefaultSecurityAssociationParameters()
        “Allows the use of security association parameters by setting all parameters to the device's default unless explicitly specified.”
        Returns:
        property allowDefaultSecurityAssociationParameters

      • withAllowDefaultSecurityAssociationParameters

        public IosikEv2VpnConfiguration withAllowDefaultSecurityAssociationParameters​(Boolean allowDefaultSecurityAssociationParameters)
        Returns an immutable copy of this with just the allowDefaultSecurityAssociationParameters 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.

        “Allows the use of security association parameters by setting all parameters to the device's default unless explicitly specified.”

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

      • withAlwaysOnConfiguration

        public IosikEv2VpnConfiguration withAlwaysOnConfiguration​(AppleVpnAlwaysOnConfiguration alwaysOnConfiguration)
        Returns an immutable copy of this with just the alwaysOnConfiguration 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.

        “AlwaysOn Configuration”

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

      • getChildSecurityAssociationParameters

        public Optional<IosVpnSecurityAssociationParameters> getChildSecurityAssociationParameters()
        “Child Security Association Parameters”
        Returns:
        property childSecurityAssociationParameters

      • withChildSecurityAssociationParameters

        public IosikEv2VpnConfiguration withChildSecurityAssociationParameters​(IosVpnSecurityAssociationParameters childSecurityAssociationParameters)
        Returns an immutable copy of this with just the childSecurityAssociationParameters 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.

        “Child Security Association Parameters”

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

      • getClientAuthenticationType

        public Optional<VpnClientAuthenticationType> getClientAuthenticationType()
        “Type of Client Authentication the VPN client will use.”
        Returns:
        property clientAuthenticationType

      • withClientAuthenticationType

        public IosikEv2VpnConfiguration withClientAuthenticationType​(VpnClientAuthenticationType clientAuthenticationType)
        Returns an immutable copy of this with just the clientAuthenticationType 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.

        “Type of Client Authentication the VPN client will use.”

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

      • getDeadPeerDetectionRate

        public Optional<VpnDeadPeerDetectionRate> getDeadPeerDetectionRate()
        “Determine how often to check if a peer connection is still active.”
        Returns:
        property deadPeerDetectionRate

      • withDeadPeerDetectionRate

        public IosikEv2VpnConfiguration withDeadPeerDetectionRate​(VpnDeadPeerDetectionRate deadPeerDetectionRate)
        Returns an immutable copy of this with just the deadPeerDetectionRate 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.

        “Determine how often to check if a peer connection is still active.”

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

      • getDisableMobilityAndMultihoming

        public Optional<Boolean> getDisableMobilityAndMultihoming()
        “Disable MOBIKE”
        Returns:
        property disableMobilityAndMultihoming

      • withDisableMobilityAndMultihoming

        public IosikEv2VpnConfiguration withDisableMobilityAndMultihoming​(Boolean disableMobilityAndMultihoming)
        Returns an immutable copy of this with just the disableMobilityAndMultihoming 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.

        “Disable MOBIKE”

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

      • getDisableRedirect

        public Optional<Boolean> getDisableRedirect()
        “Disable Redirect”
        Returns:
        property disableRedirect

      • withDisableRedirect

        public IosikEv2VpnConfiguration withDisableRedirect​(Boolean disableRedirect)
        Returns an immutable copy of this with just the disableRedirect 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.

        “Disable Redirect”

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

      • getEnableAlwaysOnConfiguration

        public Optional<Boolean> getEnableAlwaysOnConfiguration()
        “Determines if Always on VPN is enabled”
        Returns:
        property enableAlwaysOnConfiguration

      • withEnableAlwaysOnConfiguration

        public IosikEv2VpnConfiguration withEnableAlwaysOnConfiguration​(Boolean enableAlwaysOnConfiguration)
        Returns an immutable copy of this with just the enableAlwaysOnConfiguration 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.

        “Determines if Always on VPN is enabled”

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

      • getEnableCertificateRevocationCheck

        public Optional<Boolean> getEnableCertificateRevocationCheck()
        “Enables a best-effort revocation check; server response timeouts will not cause it to fail”
        Returns:
        property enableCertificateRevocationCheck

      • withEnableCertificateRevocationCheck

        public IosikEv2VpnConfiguration withEnableCertificateRevocationCheck​(Boolean enableCertificateRevocationCheck)
        Returns an immutable copy of this with just the enableCertificateRevocationCheck 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.

        “Enables a best-effort revocation check; server response timeouts will not cause it to fail”

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

      • getEnableEAP

        public Optional<Boolean> getEnableEAP()
        “Enables EAP only authentication”
        Returns:
        property enableEAP

      • withEnableEAP

        public IosikEv2VpnConfiguration withEnableEAP​(Boolean enableEAP)
        Returns an immutable copy of this with just the enableEAP 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.

        “Enables EAP only authentication”

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

      • getEnablePerfectForwardSecrecy

        public Optional<Boolean> getEnablePerfectForwardSecrecy()
        “Enable Perfect Forward Secrecy (PFS).”
        Returns:
        property enablePerfectForwardSecrecy

      • withEnablePerfectForwardSecrecy

        public IosikEv2VpnConfiguration withEnablePerfectForwardSecrecy​(Boolean enablePerfectForwardSecrecy)
        Returns an immutable copy of this with just the enablePerfectForwardSecrecy 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 Perfect Forward Secrecy (PFS).”

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

      • getEnableUseInternalSubnetAttributes

        public Optional<Boolean> getEnableUseInternalSubnetAttributes()
        “Enable Use Internal Subnet Attributes.”
        Returns:
        property enableUseInternalSubnetAttributes

      • withEnableUseInternalSubnetAttributes

        public IosikEv2VpnConfiguration withEnableUseInternalSubnetAttributes​(Boolean enableUseInternalSubnetAttributes)
        Returns an immutable copy of this with just the enableUseInternalSubnetAttributes 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 Use Internal Subnet Attributes.”

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

      • getLocalIdentifier

        public Optional<VpnLocalIdentifier> getLocalIdentifier()
        “Method of identifying the client that is trying to connect via VPN.”
        Returns:
        property localIdentifier

      • withLocalIdentifier

        public IosikEv2VpnConfiguration withLocalIdentifier​(VpnLocalIdentifier localIdentifier)
        Returns an immutable copy of this with just the localIdentifier 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.

        “Method of identifying the client that is trying to connect via VPN.”

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

      • getMtuSizeInBytes

        public Optional<Integer> getMtuSizeInBytes()
        “Maximum transmission unit. Valid values 1280 to 1400”
        Returns:
        property mtuSizeInBytes

      • withMtuSizeInBytes

        public IosikEv2VpnConfiguration withMtuSizeInBytes​(Integer mtuSizeInBytes)
        Returns an immutable copy of this with just the mtuSizeInBytes 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.

        “Maximum transmission unit. Valid values 1280 to 1400”

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

      • getRemoteIdentifier

        public Optional<String> getRemoteIdentifier()
        “Address of the IKEv2 server. Must be a FQDN, UserFQDN, network address, or ASN1DN”
        Returns:
        property remoteIdentifier

      • withRemoteIdentifier

        public IosikEv2VpnConfiguration withRemoteIdentifier​(String remoteIdentifier)
        Returns an immutable copy of this with just the remoteIdentifier 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.

        “Address of the IKEv2 server. Must be a FQDN, UserFQDN, network address, or ASN1DN”

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

      • withSecurityAssociationParameters

        public IosikEv2VpnConfiguration withSecurityAssociationParameters​(IosVpnSecurityAssociationParameters securityAssociationParameters)
        Returns an immutable copy of this with just the securityAssociationParameters 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.

        “Security Association Parameters”

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

      • getServerCertificateCommonName

        public Optional<String> getServerCertificateCommonName()
        “Common name of the IKEv2 Server Certificate used in Server Authentication”
        Returns:
        property serverCertificateCommonName

      • withServerCertificateCommonName

        public IosikEv2VpnConfiguration withServerCertificateCommonName​(String serverCertificateCommonName)
        Returns an immutable copy of this with just the serverCertificateCommonName 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.

        “Common name of the IKEv2 Server Certificate used in Server Authentication”

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

      • getServerCertificateIssuerCommonName

        public Optional<String> getServerCertificateIssuerCommonName()
        “Issuer Common name of the IKEv2 Server Certificate issuer used in Authentication”
        Returns:
        property serverCertificateIssuerCommonName

      • withServerCertificateIssuerCommonName

        public IosikEv2VpnConfiguration withServerCertificateIssuerCommonName​(String serverCertificateIssuerCommonName)
        Returns an immutable copy of this with just the serverCertificateIssuerCommonName 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.

        “Issuer Common name of the IKEv2 Server Certificate issuer used in Authentication”

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

      • getServerCertificateType

        public Optional<VpnServerCertificateType> getServerCertificateType()
        “The type of certificate the VPN server will present to the VPN client for authentication.”
        Returns:
        property serverCertificateType

      • withServerCertificateType

        public IosikEv2VpnConfiguration withServerCertificateType​(VpnServerCertificateType serverCertificateType)
        Returns an immutable copy of this with just the serverCertificateType 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 type of certificate the VPN server will present to the VPN client for authentication.”

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

      • getSharedSecret

        public Optional<String> getSharedSecret()
        “Used when Shared Secret Authentication is selected”
        Returns:
        property sharedSecret

      • withSharedSecret

        public IosikEv2VpnConfiguration withSharedSecret​(String sharedSecret)
        Returns an immutable copy of this with just the sharedSecret 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.

        “Used when Shared Secret Authentication is selected”

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

      • getTlsMaximumVersion

        public Optional<String> getTlsMaximumVersion()
        “The maximum TLS version to be used with EAP-TLS authentication”
        Returns:
        property tlsMaximumVersion

      • withTlsMaximumVersion

        public IosikEv2VpnConfiguration withTlsMaximumVersion​(String tlsMaximumVersion)
        Returns an immutable copy of this with just the tlsMaximumVersion 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 maximum TLS version to be used with EAP-TLS authentication”

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

      • getTlsMinimumVersion

        public Optional<String> getTlsMinimumVersion()
        “The minimum TLS version to be used with EAP-TLS authentication”
        Returns:
        property tlsMinimumVersion

      • withTlsMinimumVersion

        public IosikEv2VpnConfiguration withTlsMinimumVersion​(String tlsMinimumVersion)
        Returns an immutable copy of this with just the tlsMinimumVersion 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 minimum TLS version to be used with EAP-TLS authentication”

        Parameters:
        tlsMinimumVersion - new value of tlsMinimumVersion field (as defined in service metadata)
        Returns:
        immutable copy of this with just the tlsMinimumVersion 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 IosVpnConfiguration

      • patch

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