VcnUnderlyingNetworkTemplate

public abstract class VcnUnderlyingNetworkTemplate
extends Object

java.lang.Object
   ↳ 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(List)

Summary

Constants

int MATCH_ANY

Used to configure the matching criteria of a network characteristic.

int MATCH_FORBIDDEN

Used to configure the matching criteria of a network characteristic.

int MATCH_REQUIRED

Used to configure the matching criteria of a network characteristic.

Public methods

boolean equals(Object other)

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

int getMetered()

Return the matching criteria for metered networks.

int getMinEntryDownstreamBandwidthKbps()

Returns the minimum entry downstream bandwidth allowed by this template.

int getMinEntryUpstreamBandwidthKbps()

Returns the minimum entry upstream bandwidth allowed by this template.

int getMinExitDownstreamBandwidthKbps()

Returns the minimum exit downstream bandwidth allowed by this template.

int getMinExitUpstreamBandwidthKbps()

Returns the minimum exit upstream bandwidth allowed by this template.

int hashCode()

Returns a hash code value for the object.

Inherited methods

Constants

MATCH_ANY

Added in API level 33
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.

Constant Value: 0 (0x00000000)

MATCH_FORBIDDEN

Added in API level 33
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.

Constant Value: 2 (0x00000002)

MATCH_REQUIRED

Added in API level 33
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.

Constant Value: 1 (0x00000001)

Public methods

equals

Added in API level 33
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.

Parameters
other Object: This value may be null.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getMetered

Added in API level 33
public int getMetered ()

Return the matching criteria for metered networks.

Returns
int

getMinEntryDownstreamBandwidthKbps

Added in API level 33
public int getMinEntryDownstreamBandwidthKbps ()

Returns the minimum entry downstream bandwidth allowed by this template.

Returns
int

getMinEntryUpstreamBandwidthKbps

Added in API level 33
public int getMinEntryUpstreamBandwidthKbps ()

Returns the minimum entry upstream bandwidth allowed by this template.

Returns
int

getMinExitDownstreamBandwidthKbps

Added in API level 33
public int getMinExitDownstreamBandwidthKbps ()

Returns the minimum exit downstream bandwidth allowed by this template.

Returns
int

getMinExitUpstreamBandwidthKbps

Added in API level 33
public int getMinExitUpstreamBandwidthKbps ()

Returns the minimum exit upstream bandwidth allowed by this template.

Returns
int

hashCode

Added in API level 33
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 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 equals 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 equals 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.

Returns
int a hash code value for this object.