VcnConfig.Builder

Kotlin |Java

public static final class VcnConfig.Builder
extends Object

java.lang.Object
↳	android.net.vcn.VcnConfig.Builder

This class is used to incrementally build VcnConfig objects.

Summary

Public constructors
`Builder(Context context)`

Public methods
`VcnConfig.Builder`	`addGatewayConnectionConfig(VcnGatewayConnectionConfig gatewayConnectionConfig)` Adds a configuration for an individual gateway connection.
`VcnConfig`	`build()` Builds and validates the VcnConfig.
`VcnConfig.Builder`	`setRestrictedUnderlyingNetworkTransports(Set<Integer> transports)` Sets transports that will be restricted by the VCN.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(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`	`wait(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`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

Builder

Added in API level 31

public Builder (Context context)

Parameters
`context`	`Context`: This value cannot be `null`.

Public methods

addGatewayConnectionConfig

Added in API level 31

public VcnConfig.Builder addGatewayConnectionConfig (VcnGatewayConnectionConfig gatewayConnectionConfig)

Adds a configuration for an individual gateway connection.

Parameters
`gatewayConnectionConfig`	`VcnGatewayConnectionConfig`: the configuration for an individual gateway connection. This value cannot be `null`.

Returns
`VcnConfig.Builder`	this `Builder` instance, for chaining. This value cannot be `null`.

Throws
`IllegalArgumentException`	if a VcnGatewayConnectionConfig has already been set for this `VcnConfig` with the same GatewayConnection name (as returned via `VcnGatewayConnectionConfig.getGatewayConnectionName()`).

build

Added in API level 31

public VcnConfig build ()

Builds and validates the VcnConfig.

Returns
`VcnConfig`	an immutable VcnConfig instance. This value cannot be `null`.

setRestrictedUnderlyingNetworkTransports

Added in API level 34

public VcnConfig.Builder setRestrictedUnderlyingNetworkTransports (Set<Integer> transports)

Sets transports that will be restricted by the VCN.

In general, apps will not be able to bind to, or use a restricted network. In other words, unless the network type is marked restricted, any app can opt to use underlying networks, instead of through the VCN.

Parameters
`transports`	`Set`: transports that will be restricted by VCN. Networks that include any of the transports will be marked as restricted. `NetworkCapabilities.TRANSPORT_WIFI` is marked restricted by default. This value cannot be `null`.

Returns
`VcnConfig.Builder`	this `Builder` instance, for chaining. This value cannot be `null`.

Throws
`IllegalArgumentException`	if the input contains unsupported transport types.

See also:

NetworkCapabilities.NET_CAPABILITY_NOT_RESTRICTED