Added in API level 33

VcnUnderlyingNetworkTemplate

abstract class VcnUnderlyingNetworkTemplate
kotlin.Any
   ↳ android.net.vcn.VcnUnderlyingNetworkTemplate

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 android.net.vcn.VcnGatewayConnectionConfig.Builder#setVcnUnderlyingNetworkPriorities

Summary

Constants
static Int

Used to configure the matching criteria of a network characteristic.
static Int

Used to configure the matching criteria of a network characteristic.
static Int

Used to configure the matching criteria of a network characteristic.
Public methods
open Boolean
equals(other: Any?)

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

Return the matching criteria for metered networks.
open Int

Returns the minimum entry downstream bandwidth allowed by this template.
open Int

Returns the minimum entry upstream bandwidth allowed by this template.
open Int

Returns the minimum exit downstream bandwidth allowed by this template.
open Int

Returns the minimum exit upstream bandwidth allowed by this template.
open Int

Constants

MATCH_ANY

Added in API level 33
static val MATCH_ANY: Int

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.

Value: 0

MATCH_FORBIDDEN

Added in API level 33
static val MATCH_FORBIDDEN: Int

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.

Value: 2

MATCH_REQUIRED

Added in API level 33
static val MATCH_REQUIRED: Int

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.

Value: 1

Public methods

equals

Added in API level 33
open fun equals(other: Any?): Boolean

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.

Parameters
obj the reference object with which to compare.
other Any?: This value may be null.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getMetered

Added in API level 33
open fun getMetered(): Int

Return the matching criteria for metered networks.

getMinEntryDownstreamBandwidthKbps

Added in API level 33
open fun getMinEntryDownstreamBandwidthKbps(): Int

Returns the minimum entry downstream bandwidth allowed by this template.

getMinEntryUpstreamBandwidthKbps

Added in API level 33
open fun getMinEntryUpstreamBandwidthKbps(): Int

Returns the minimum entry upstream bandwidth allowed by this template.

getMinExitDownstreamBandwidthKbps

Added in API level 33
open fun getMinExitDownstreamBandwidthKbps(): Int

Returns the minimum exit downstream bandwidth allowed by this template.

getMinExitUpstreamBandwidthKbps

Added in API level 33
open fun getMinExitUpstreamBandwidthKbps(): Int

Returns the minimum exit upstream bandwidth allowed by this template.

hashCode

Added in API level 33
open fun hashCode(): Int
Return
Int a hash code value for this object.