Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/net/vcn/VcnGatewayConnectionConfig#nestedclasses) \| [Constants](https://developer.android.com/reference/android/net/vcn/VcnGatewayConnectionConfig#constants) \| [Methods](https://developer.android.com/reference/android/net/vcn/VcnGatewayConnectionConfig#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/net/vcn/VcnGatewayConnectionConfig#inhmethods)

# VcnGatewayConnectionConfig

*** ** * ** ***


`
public

final

class
VcnGatewayConnectionConfig
`


`

extends https://developer.android.com/reference/java/lang/Object


`

`


`

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.net.vcn.VcnGatewayConnectionConfig |

<br />

*** ** * ** ***

This class represents a configuration for a connection to a Virtual Carrier Network gateway.

Each VcnGatewayConnectionConfig represents a single logical connection to a carrier gateway,
and may provide one or more telephony services (as represented by network capabilities). Each
gateway is expected to provide mobility for a given session as the device roams across `https://developer.android.com/reference/android/net/Network`s.

A VCN connection based on this configuration will be brought up dynamically based on device
settings, and filed NetworkRequests. Underlying Networks must provide INTERNET connectivity, and
must be part of the subscription group under which this configuration is registered (see `https://developer.android.com/reference/android/net/vcn/VcnManager#setVcnConfig(android.os.ParcelUuid,%20android.net.vcn.VcnConfig)`).

As an abstraction of a cellular network, services that can be provided by a VCN network are
limited to services provided by cellular networks:

- `https://developer.android.com/reference/android/net/NetworkCapabilities#NET_CAPABILITY_MMS`
- `https://developer.android.com/reference/android/net/NetworkCapabilities#NET_CAPABILITY_SUPL`
- `https://developer.android.com/reference/android/net/NetworkCapabilities#NET_CAPABILITY_DUN`
- `https://developer.android.com/reference/android/net/NetworkCapabilities#NET_CAPABILITY_FOTA`
- `https://developer.android.com/reference/android/net/NetworkCapabilities#NET_CAPABILITY_IMS`
- `https://developer.android.com/reference/android/net/NetworkCapabilities#NET_CAPABILITY_CBS`
- `https://developer.android.com/reference/android/net/NetworkCapabilities#NET_CAPABILITY_IA`
- `https://developer.android.com/reference/android/net/NetworkCapabilities#NET_CAPABILITY_RCS`
- `https://developer.android.com/reference/android/net/NetworkCapabilities#NET_CAPABILITY_XCAP`
- `https://developer.android.com/reference/android/net/NetworkCapabilities#NET_CAPABILITY_EIMS`
- `https://developer.android.com/reference/android/net/NetworkCapabilities#NET_CAPABILITY_INTERNET`
- `https://developer.android.com/reference/android/net/NetworkCapabilities#NET_CAPABILITY_MCX`

<br />

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/net/vcn/VcnGatewayConnectionConfig.Builder` This class is used to incrementally build `https://developer.android.com/reference/android/net/vcn/VcnGatewayConnectionConfig` objects. |

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/net/vcn/VcnGatewayConnectionConfig#MIN_UDP_PORT_4500_NAT_TIMEOUT_UNSET` Minimum NAT timeout not set. |
| `int` | `https://developer.android.com/reference/android/net/vcn/VcnGatewayConnectionConfig#VCN_GATEWAY_OPTION_ENABLE_DATA_STALL_RECOVERY_WITH_MOBILITY` Perform mobility update to attempt recovery from suspected data stalls. |

| ### Public methods ||
|---|---|
| ` boolean` | ` https://developer.android.com/reference/android/net/vcn/VcnGatewayConnectionConfig#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object other) ` Indicates whether some other object is "equal to" this one. |
| ` int[]` | ` https://developer.android.com/reference/android/net/vcn/VcnGatewayConnectionConfig#getExposedCapabilities()() ` Returns all exposed capabilities. |
| ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/android/net/vcn/VcnGatewayConnectionConfig#getGatewayConnectionName()() ` Returns the configured Gateway Connection name. |
| ` int` | ` https://developer.android.com/reference/android/net/vcn/VcnGatewayConnectionConfig#getMaxMtu()() ` Retrieves the maximum MTU allowed for this Gateway Connection. |
| ` int` | ` https://developer.android.com/reference/android/net/vcn/VcnGatewayConnectionConfig#getMinUdpPort4500NatTimeoutSeconds()() ` Retrieves the maximum supported IKEv2/IPsec NATT keepalive timeout. |
| ` long[]` | ` https://developer.android.com/reference/android/net/vcn/VcnGatewayConnectionConfig#getRetryIntervalsMillis()() ` Retrieves the configured retry intervals. |
| ` https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/net/vcn/VcnUnderlyingNetworkTemplate>` | ` https://developer.android.com/reference/android/net/vcn/VcnGatewayConnectionConfig#getVcnUnderlyingNetworkPriorities()() ` Retrieve the VcnUnderlyingNetworkTemplate list, or a default list if it is not configured. |
| ` boolean` | ` https://developer.android.com/reference/android/net/vcn/VcnGatewayConnectionConfig#hasGatewayOption(int)(int option) ` Checks if the given VCN gateway option is enabled. |
| ` int` | ` https://developer.android.com/reference/android/net/vcn/VcnGatewayConnectionConfig#hashCode()() ` Returns a hash code value for the object. |
| ` boolean` | ` https://developer.android.com/reference/android/net/vcn/VcnGatewayConnectionConfig#isSafeModeEnabled()() ` Check whether safe mode is enabled |

| ### Inherited methods |
|---|---|
| From class ` https://developer.android.com/reference/java/lang/Object ` |---|---| | ` https://developer.android.com/reference/java/lang/Object` | ` https://developer.android.com/reference/java/lang/Object#clone()() ` Creates and returns a copy of this object. | | ` boolean` | ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) ` Indicates whether some other object is "equal to" this one. | | ` void` | ` https://developer.android.com/reference/java/lang/Object#finalize()() ` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. | | ` final https://developer.android.com/reference/java/lang/Class<?>` | ` https://developer.android.com/reference/java/lang/Object#getClass()() ` Returns the runtime class of this `Object`. | | ` int` | ` https://developer.android.com/reference/java/lang/Object#hashCode()() ` Returns a hash code value for the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notify()() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#notifyAll()() ` Wakes up all threads that are waiting on this object's monitor. | | ` https://developer.android.com/reference/java/lang/String` | ` https://developer.android.com/reference/java/lang/Object#toString()() ` Returns a string representation of the object. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed. | | ` final void` | ` https://developer.android.com/reference/java/lang/Object#wait()() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||

## Constants

### MIN_UDP_PORT_4500_NAT_TIMEOUT_UNSET

Added in [API level 36](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int MIN_UDP_PORT_4500_NAT_TIMEOUT_UNSET
```

Minimum NAT timeout not set.

When the timeout is not set, the device will automatically choose a keepalive interval and
may reduce the keepalive frequency for power-optimization.

<br />

Constant Value:

-1
(0xffffffff)


### VCN_GATEWAY_OPTION_ENABLE_DATA_STALL_RECOVERY_WITH_MOBILITY

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public static final int VCN_GATEWAY_OPTION_ENABLE_DATA_STALL_RECOVERY_WITH_MOBILITY
```

Perform mobility update to attempt recovery from suspected data stalls.

If set, the gateway connection will monitor the data stall detection of the VCN network.
When there is a suspected data stall, the gateway connection will attempt recovery by
performing a mobility update on the underlying IKE session.

<br />

Constant Value:

0
(0x00000000)


## Public methods

### equals

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean equals (Object other)
```

Indicates whether some other object is "equal to" this one.


The `equals` method implements an equivalence relation
on non-null object references:

- It is *reflexive*: for any non-null reference value `x`, `x.equals(x)` should return `true`.
- It is *symmetric*: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`.
- It is *transitive*: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`.
- It is *consistent*: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified.
- For any non-null reference value `x`, `x.equals(null)` should return `false`.


An equivalence relation partitions the elements it operates on
into *equivalence classes*; all the members of an
equivalence class are equal to each other. Members of an
equivalence class are substitutable for each other, at least
for some purposes.

<br />

| Parameters ||
|---|---|
| `other` | `Object`: This value may be `null`. <br /> |

| Returns ||
|---|---|
| `boolean` | `true` if this object is the same as the obj argument; `false` otherwise. <br /> |

### getExposedCapabilities

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int[] getExposedCapabilities ()
```

Returns all exposed capabilities.

The returned integer-value capabilities will not contain duplicates, and will be sorted in
ascending numerical order.

<br />

| Returns ||
|---|---|
| `int[]` | This value cannot be `null`. <br /> |

**See also:**

- `https://developer.android.com/reference/android/net/vcn/VcnGatewayConnectionConfig.Builder#addExposedCapability(int)`
- `https://developer.android.com/reference/android/net/vcn/VcnGatewayConnectionConfig.Builder#removeExposedCapability(int)`

### getGatewayConnectionName

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public String getGatewayConnectionName ()
```

Returns the configured Gateway Connection name.

This name is used by the configuring apps to distinguish between
VcnGatewayConnectionConfigs configured on a single `https://developer.android.com/reference/android/net/vcn/VcnConfig`. This will be used as
the identifier in VcnStatusCallback invocations.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/lang/String` | This value cannot be `null`. <br /> |

**See also:**

- `https://developer.android.com/reference/android/net/vcn/VcnManager.VcnStatusCallback#onGatewayConnectionError(java.lang.String,%20int,%20java.lang.Throwable)`

### getMaxMtu

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getMaxMtu ()
```

Retrieves the maximum MTU allowed for this Gateway Connection.

<br />

| Returns ||
|---|---|
| `int` | Value is `https://developer.android.com/` or greater <br /> |

**See also:**

- `https://developer.android.com/reference/android/net/vcn/VcnGatewayConnectionConfig.Builder#setMaxMtu(int)`

### getMinUdpPort4500NatTimeoutSeconds

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int getMinUdpPort4500NatTimeoutSeconds ()
```

Retrieves the maximum supported IKEv2/IPsec NATT keepalive timeout.

<br />

| Returns ||
|---|---|
| `int` | <br /> |

**See also:**

- `https://developer.android.com/reference/android/net/vcn/VcnGatewayConnectionConfig.Builder#setMinUdpPort4500NatTimeoutSeconds(int)`

### getRetryIntervalsMillis

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public long[] getRetryIntervalsMillis ()
```

Retrieves the configured retry intervals.

<br />

| Returns ||
|---|---|
| `long[]` | This value cannot be `null`. <br /> |

**See also:**

- `https://developer.android.com/reference/android/net/vcn/VcnGatewayConnectionConfig.Builder#setRetryIntervalsMillis(long[])`

### getVcnUnderlyingNetworkPriorities

Added in [API level 33](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public List<VcnUnderlyingNetworkTemplate> getVcnUnderlyingNetworkPriorities ()
```

Retrieve the VcnUnderlyingNetworkTemplate list, or a default list if it is not configured.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/net/vcn/VcnUnderlyingNetworkTemplate>` | This value cannot be `null`. <br /> |

**See also:**

- `https://developer.android.com/reference/android/net/vcn/VcnGatewayConnectionConfig.Builder#setVcnUnderlyingNetworkPriorities(java.util.List<android.net.vcn.VcnUnderlyingNetworkTemplate>)`

### hasGatewayOption

Added in [API level 34](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean hasGatewayOption (int option)
```

Checks if the given VCN gateway option is enabled.

<br />

| Parameters ||
|---|---|
| `option` | `int`: the option to check. Value is one of the following: - `https://developer.android.com/reference/android/net/vcn/VcnGatewayConnectionConfig#VCN_GATEWAY_OPTION_ENABLE_DATA_STALL_RECOVERY_WITH_MOBILITY` |

| Returns ||
|---|---|
| `boolean` | <br /> |

| Throws ||
|---|---|
| `https://developer.android.com/reference/java/lang/IllegalArgumentException` | if the provided option is invalid. |

**See also:**

- `https://developer.android.com/reference/android/net/vcn/VcnGatewayConnectionConfig.Builder#addGatewayOption(int)`
- `https://developer.android.com/reference/android/net/vcn/VcnGatewayConnectionConfig.Builder#removeGatewayOption(int)`

### hashCode

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public int hashCode ()
```

Returns a hash code value for the object. This method is
supported for the benefit of hash tables such as those provided by
`https://developer.android.com/reference/java/util/HashMap`.


The general contract of `hashCode` is:

- Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
- If two objects are equal according to the `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` method, then calling the `hashCode` method on each of the two objects must produce the same integer result.
- It is *not* required that if two objects are unequal according to the `https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

<br />

<br />

| Returns ||
|---|---|
| `int` | a hash code value for this object. <br /> |

### isSafeModeEnabled

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public boolean isSafeModeEnabled ()
```

Check whether safe mode is enabled

<br />

| Returns ||
|---|---|
| `boolean` | <br /> |

**See also:**

- `https://developer.android.com/reference/android/net/vcn/VcnGatewayConnectionConfig.Builder#setSafeModeEnabled(boolean)`