Builder

Builder

Builder()

Construct a Builder object.

build

fun build(): VcnCellUnderlyingNetworkTemplate

Build the VcnCellUnderlyingNetworkTemplate.

setCbs

fun setCbs(matchCriteria: Int): VcnCellUnderlyingNetworkTemplate.Builder

Sets the matching criteria for CBS networks.

A template where setCbs(MATCH_REQUIRED) is called will only match CBS networks (ones with NET_CAPABILITY_CBS). A template where setCbs(MATCH_FORBIDDEN) is called will only match networks that do not support CBS (ones without NET_CAPABILITY_CBS).

setDun

fun setDun(matchCriteria: Int): VcnCellUnderlyingNetworkTemplate.Builder

Sets the matching criteria for DUN networks.

A template where setDun(MATCH_REQUIRED) is called will only match DUN networks (ones with NET_CAPABILITY_DUN). A template where setDun(MATCH_FORBIDDEN) is called will only match networks that do not support DUN (ones without NET_CAPABILITY_DUN).

setIms

fun setIms(matchCriteria: Int): VcnCellUnderlyingNetworkTemplate.Builder

Sets the matching criteria for IMS networks.

A template where setIms(MATCH_REQUIRED) is called will only match IMS networks (ones with NET_CAPABILITY_IMS). A template where setIms(MATCH_FORBIDDEN) is called will only match networks that do not support IMS (ones without NET_CAPABILITY_IMS).

setInternet

fun setInternet(matchCriteria: Int): VcnCellUnderlyingNetworkTemplate.Builder

Sets the matching criteria for INTERNET networks.

A template where setInternet(MATCH_REQUIRED) is called will only match INTERNET networks (ones with NET_CAPABILITY_INTERNET). A template where setInternet(MATCH_FORBIDDEN) is called will only match networks that do not support INTERNET (ones without NET_CAPABILITY_INTERNET).

setMetered

fun setMetered(matchCriteria: Int): VcnCellUnderlyingNetworkTemplate.Builder

Set the matching criteria for metered networks.

A template where setMetered(MATCH_REQUIRED) will only match metered networks (one without NET_CAPABILITY_NOT_METERED). A template where setMetered(MATCH_FORBIDDEN) will only match a network that is not metered (one with NET_CAPABILITY_NOT_METERED).

setMinDownstreamBandwidthKbps

fun setMinDownstreamBandwidthKbps(
    minEntryDownstreamBandwidthKbps: Int, 
    minExitDownstreamBandwidthKbps: Int
): VcnCellUnderlyingNetworkTemplate.Builder

Set the minimum upstream bandwidths that this template will match.

This template will not match a network that does not provide at least the bandwidth passed as the entry bandwidth, except in the case that the network is selected as the VCN Gateway Connection's underlying network, where it will continue to match until the bandwidth drops under the exit bandwidth.

The entry criteria MUST be greater than, or equal to the exit criteria to avoid the invalid case where a network fulfills the entry criteria, but at the same time fails the exit criteria.

Estimated bandwidth of a network is provided by the transport layer, and reported in NetworkCapabilities. The provided estimates will be used without modification.

setMinUpstreamBandwidthKbps

fun setMinUpstreamBandwidthKbps(
    minEntryUpstreamBandwidthKbps: Int, 
    minExitUpstreamBandwidthKbps: Int
): VcnCellUnderlyingNetworkTemplate.Builder

Set the minimum upstream bandwidths that this template will match.

This template will not match a network that does not provide at least the bandwidth passed as the entry bandwidth, except in the case that the network is selected as the VCN Gateway Connection's underlying network, where it will continue to match until the bandwidth drops under the exit bandwidth.

The entry criteria MUST be greater than, or equal to the exit criteria to avoid the invalid case where a network fulfills the entry criteria, but at the same time fails the exit criteria.

Estimated bandwidth of a network is provided by the transport layer, and reported in NetworkCapabilities. The provided estimates will be used without modification.

setMms

fun setMms(matchCriteria: Int): VcnCellUnderlyingNetworkTemplate.Builder

Sets the matching criteria for MMS networks.

A template where setMms(MATCH_REQUIRED) is called will only match MMS networks (ones with NET_CAPABILITY_MMS). A template where setMms(MATCH_FORBIDDEN) is called will only match networks that do not support MMS (ones without NET_CAPABILITY_MMS).

setOperatorPlmnIds

fun setOperatorPlmnIds(operatorPlmnIds: MutableSet<String!>): VcnCellUnderlyingNetworkTemplate.Builder

Set operator PLMN IDs with which a network can match this template.

This is used to distinguish cases where roaming agreements may dictate a different priority from a partner's networks.

setOpportunistic

fun setOpportunistic(matchCriteria: Int): VcnCellUnderlyingNetworkTemplate.Builder

Set the matching criteria for opportunistic cellular subscriptions.

setRcs

fun setRcs(matchCriteria: Int): VcnCellUnderlyingNetworkTemplate.Builder

Sets the matching criteria for RCS networks.

A template where setRcs(MATCH_REQUIRED) is called will only match RCS networks (ones with NET_CAPABILITY_RCS). A template where setRcs(MATCH_FORBIDDEN) is called will only match networks that do not support RCS (ones without NET_CAPABILITY_RCS).

setRoaming

fun setRoaming(matchCriteria: Int): VcnCellUnderlyingNetworkTemplate.Builder

Set the matching criteria for roaming networks.

A template where setRoaming(MATCH_REQUIRED) will only match roaming networks (one without NET_CAPABILITY_NOT_ROAMING). A template where setRoaming(MATCH_FORBIDDEN) will only match a network that is not roaming (one with NET_CAPABILITY_NOT_ROAMING).

setSimSpecificCarrierIds

fun setSimSpecificCarrierIds(simSpecificCarrierIds: MutableSet<Int!>): VcnCellUnderlyingNetworkTemplate.Builder

Set sim specific carrier IDs with which a network can match this template.