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 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 |
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 |
hashCode()Returns a hash code value for the object. |
Constants
MATCH_ANY
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: 0MATCH_FORBIDDEN
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: 2MATCH_REQUIRED
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: 1Public methods
equals
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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
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
open fun getMetered(): Int
Return the matching criteria for metered networks.
getMinEntryDownstreamBandwidthKbps
open fun getMinEntryDownstreamBandwidthKbps(): Int
Returns the minimum entry downstream bandwidth allowed by this template.
getMinEntryUpstreamBandwidthKbps
open fun getMinEntryUpstreamBandwidthKbps(): Int
Returns the minimum entry upstream bandwidth allowed by this template.
getMinExitDownstreamBandwidthKbps
open fun getMinExitDownstreamBandwidthKbps(): Int
Returns the minimum exit downstream bandwidth allowed by this template.
getMinExitUpstreamBandwidthKbps
open fun getMinExitUpstreamBandwidthKbps(): Int
Returns the minimum exit upstream bandwidth allowed by this template.
hashCode
open fun hashCode(): Int
Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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
equalsmethod, then calling thehashCodemethod 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
equalsmethod, then calling thehashCodemethod 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.
| Return | |
|---|---|
Int |
a hash code value for this object. |