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

# VcnUnderlyingNetworkTemplate

*** ** * ** ***


`
public


abstract
class
VcnUnderlyingNetworkTemplate
`


`

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


`

`


`

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

|---|
| Known direct subclasses [VcnCellUnderlyingNetworkTemplate](https://developer.android.com/reference/android/net/vcn/VcnCellUnderlyingNetworkTemplate), [VcnWifiUnderlyingNetworkTemplate](https://developer.android.com/reference/android/net/vcn/VcnWifiUnderlyingNetworkTemplate) |---|---| | [VcnCellUnderlyingNetworkTemplate](https://developer.android.com/reference/android/net/vcn/VcnCellUnderlyingNetworkTemplate) | This class represents a configuration for a network template class of underlying cellular networks. | | [VcnWifiUnderlyingNetworkTemplate](https://developer.android.com/reference/android/net/vcn/VcnWifiUnderlyingNetworkTemplate) | This class represents a configuration for a network template class of underlying Carrier WiFi networks. | |

<br />

*** ** * ** ***

This class represents a template containing set of underlying network requirements for doing
route selection.

Apps provisioning a VCN can configure the underlying network priority for each Gateway
Connection by setting a list (in priority order, most to least preferred) of the appropriate
subclasses in the VcnGatewayConnectionConfig. See `https://developer.android.com/reference/android/net/vcn/VcnGatewayConnectionConfig.Builder#setVcnUnderlyingNetworkPriorities(java.util.List<android.net.vcn.VcnUnderlyingNetworkTemplate>)`

## Summary

| ### Constants ||
|---|---|
| `int` | `https://developer.android.com/reference/android/net/vcn/VcnUnderlyingNetworkTemplate#MATCH_ANY` Used to configure the matching criteria of a network characteristic. |
| `int` | `https://developer.android.com/reference/android/net/vcn/VcnUnderlyingNetworkTemplate#MATCH_FORBIDDEN` Used to configure the matching criteria of a network characteristic. |
| `int` | `https://developer.android.com/reference/android/net/vcn/VcnUnderlyingNetworkTemplate#MATCH_REQUIRED` Used to configure the matching criteria of a network characteristic. |

| ### Public methods ||
|---|---|
| ` boolean` | ` https://developer.android.com/reference/android/net/vcn/VcnUnderlyingNetworkTemplate#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/VcnUnderlyingNetworkTemplate#getMetered()() ` Return the matching criteria for metered networks. |
| ` int` | ` https://developer.android.com/reference/android/net/vcn/VcnUnderlyingNetworkTemplate#getMinEntryDownstreamBandwidthKbps()() ` Returns the minimum entry downstream bandwidth allowed by this template. |
| ` int` | ` https://developer.android.com/reference/android/net/vcn/VcnUnderlyingNetworkTemplate#getMinEntryUpstreamBandwidthKbps()() ` Returns the minimum entry upstream bandwidth allowed by this template. |
| ` int` | ` https://developer.android.com/reference/android/net/vcn/VcnUnderlyingNetworkTemplate#getMinExitDownstreamBandwidthKbps()() ` Returns the minimum exit downstream bandwidth allowed by this template. |
| ` int` | ` https://developer.android.com/reference/android/net/vcn/VcnUnderlyingNetworkTemplate#getMinExitUpstreamBandwidthKbps()() ` Returns the minimum exit upstream bandwidth allowed by this template. |
| ` int` | ` https://developer.android.com/reference/android/net/vcn/VcnUnderlyingNetworkTemplate#hashCode()() ` Returns a hash code value for the object. |

| ### 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

### MATCH_ANY

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

```
public static final int MATCH_ANY
```

Used to configure the matching criteria of a network characteristic. This may include network
capabilities, or cellular subscription information. Denotes that networks with or without the
characteristic are both acceptable to match this template.

<br />

Constant Value:

0
(0x00000000)


### MATCH_FORBIDDEN

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

```
public static final int MATCH_FORBIDDEN
```

Used to configure the matching criteria of a network characteristic. This may include network
capabilities, or cellular subscription information. Denotes that a network MUST NOT have the
capability in order to match this template.

<br />

Constant Value:

2
(0x00000002)


### MATCH_REQUIRED

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

```
public static final int MATCH_REQUIRED
```

Used to configure the matching criteria of a network characteristic. This may include network
capabilities, or cellular subscription information. Denotes that a network MUST have the
capability in order to match this template.

<br />

Constant Value:

1
(0x00000001)


## Public methods

### equals

Added in [API level 33](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 /> |

### getMetered

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

```
public int getMetered ()
```

Return the matching criteria for metered networks.

<br />

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

**See also:**

- `https://developer.android.com/reference/android/net/vcn/VcnWifiUnderlyingNetworkTemplate.Builder#setMetered(int)`
- `https://developer.android.com/reference/android/net/vcn/VcnCellUnderlyingNetworkTemplate.Builder#setMetered(int)`

### getMinEntryDownstreamBandwidthKbps

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

```
public int getMinEntryDownstreamBandwidthKbps ()
```

Returns the minimum entry downstream bandwidth allowed by this template.

<br />

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

**See also:**

- `https://developer.android.com/reference/android/net/vcn/VcnWifiUnderlyingNetworkTemplate.Builder#setMinDownstreamBandwidthKbps(int,%20int)`
- `https://developer.android.com/reference/android/net/vcn/VcnCellUnderlyingNetworkTemplate.Builder#setMinDownstreamBandwidthKbps(int,%20int)`

### getMinEntryUpstreamBandwidthKbps

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

```
public int getMinEntryUpstreamBandwidthKbps ()
```

Returns the minimum entry upstream bandwidth allowed by this template.

<br />

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

**See also:**

- `https://developer.android.com/reference/android/net/vcn/VcnWifiUnderlyingNetworkTemplate.Builder#setMinUpstreamBandwidthKbps(int,%20int)`
- `https://developer.android.com/reference/android/net/vcn/VcnCellUnderlyingNetworkTemplate.Builder#setMinUpstreamBandwidthKbps(int,%20int)`

### getMinExitDownstreamBandwidthKbps

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

```
public int getMinExitDownstreamBandwidthKbps ()
```

Returns the minimum exit downstream bandwidth allowed by this template.

<br />

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

**See also:**

- `https://developer.android.com/reference/android/net/vcn/VcnWifiUnderlyingNetworkTemplate.Builder#setMinDownstreamBandwidthKbps(int,%20int)`
- `https://developer.android.com/reference/android/net/vcn/VcnCellUnderlyingNetworkTemplate.Builder#setMinDownstreamBandwidthKbps(int,%20int)`

### getMinExitUpstreamBandwidthKbps

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

```
public int getMinExitUpstreamBandwidthKbps ()
```

Returns the minimum exit upstream bandwidth allowed by this template.

<br />

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

**See also:**

- `https://developer.android.com/reference/android/net/vcn/VcnWifiUnderlyingNetworkTemplate.Builder#setMinUpstreamBandwidthKbps(int,%20int)`
- `https://developer.android.com/reference/android/net/vcn/VcnCellUnderlyingNetworkTemplate.Builder#setMinUpstreamBandwidthKbps(int,%20int)`

### hashCode

Added in [API level 33](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 /> |