Builder

Builder

Builder(
    gatewayConnectionName: String, 
    tunnelConnectionParams: IkeTunnelConnectionParams)

Construct a Builder object.

addExposedCapability

fun addExposedCapability(exposedCapability: Int): VcnGatewayConnectionConfig.Builder

Add a capability that this VCN Gateway Connection will support.

addGatewayOption

fun addGatewayOption(option: Int): VcnGatewayConnectionConfig.Builder

Enables the specified VCN gateway option.

build

fun build(): VcnGatewayConnectionConfig

Builds and validates the VcnGatewayConnectionConfig.

removeExposedCapability

fun removeExposedCapability(exposedCapability: Int): VcnGatewayConnectionConfig.Builder

Remove a capability that this VCN Gateway Connection will support.

removeGatewayOption

fun removeGatewayOption(option: Int): VcnGatewayConnectionConfig.Builder

Resets (disables) the specified VCN gateway option.

setMaxMtu

fun setMaxMtu(maxMtu: Int): VcnGatewayConnectionConfig.Builder

Sets the maximum MTU allowed for this VCN Gateway Connection.

This MTU is applied to the VCN Gateway Connection exposed Networks, and represents the MTU of the virtualized network.

The system may reduce the MTU below the maximum specified based on signals such as the MTU of the underlying networks (and adjusted for Gateway Connection overhead).

setMinUdpPort4500NatTimeoutSeconds

fun setMinUdpPort4500NatTimeoutSeconds(minUdpPort4500NatTimeoutSeconds: Int): VcnGatewayConnectionConfig.Builder

Sets the maximum supported IKEv2/IPsec NATT keepalive timeout.

This is used as a power-optimization hint for other IKEv2/IPsec use cases (e.g. VPNs, or IWLAN) to reduce the necessary keepalive frequency, thus conserving power and data.

setRetryIntervalsMillis

fun setRetryIntervalsMillis(retryIntervalsMs: LongArray): VcnGatewayConnectionConfig.Builder

Set the retry interval between VCN establishment attempts upon successive failures.

The last retry interval will be repeated until safe mode is entered, or a connection is successfully established, at which point the retry timers will be reset. For power reasons, the last (repeated) retry interval MUST be at least 15 minutes.

Retry intervals MAY be subject to system power saving modes. That is to say that if the system enters a power saving mode, the retry may not occur until the device leaves the specified power saving mode. Intervals are sequential, and intervals will NOT be skipped if system power saving results in delaying retries (even if it exceed multiple retry intervals).

Each Gateway Connection will retry according to the retry intervals configured, but if safe mode is enabled, all Gateway Connection(s) will be disabled.

setSafeModeEnabled

fun setSafeModeEnabled(enabled: Boolean): VcnGatewayConnectionConfig.Builder

Enable/disable safe mode

If a VCN fails to provide connectivity within a system-provided timeout, it will enter safe mode. In safe mode, the VCN Network will be torn down and the system will restore connectivity by allowing underlying cellular or WiFi networks to be used as default. At the same time, VCN will continue to retry until it succeeds.

When safe mode is disabled and VCN connection fails to provide connectivity, end users might not have connectivity, and may not have access to carrier-owned underlying networks.

setVcnUnderlyingNetworkPriorities

fun setVcnUnderlyingNetworkPriorities(underlyingNetworkTemplates: MutableList<VcnUnderlyingNetworkTemplate!>): VcnGatewayConnectionConfig.Builder

Set the list of templates to match underlying networks against, in high-to-low priority order.

To select the VCN underlying network, the VCN connection will go through all the network candidates and return a network matching the highest priority rule.

If multiple networks match the same rule, the VCN will prefer an already-selected network as opposed to a new/unselected network. However, if both are new/unselected networks, a network will be chosen arbitrarily amongst the networks matching the highest priority rule.

If all networks fail to match the rules provided, a carrier-owned underlying network will still be selected (if available, at random if necessary).