VirtualCircuit.Builder (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.vnmonitoring.model.VirtualCircuit.Builder

Enclosing class:: VirtualCircuit

public static class VirtualCircuit.Builder
extends Object

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`VirtualCircuit.Builder`	`bandwidthShapeName(String bandwidthShapeName)` The provisioned data rate of the connection.
`VirtualCircuit.Builder`	`bgpAdminState(VirtualCircuit.BgpAdminState bgpAdminState)` Set to `ENABLED` (the default) to activate the BGP session of the virtual circuit, set to `DISABLED` to deactivate the virtual circuit.
`VirtualCircuit.Builder`	`bgpIpv6SessionState(VirtualCircuit.BgpIpv6SessionState bgpIpv6SessionState)` The state of the Ipv6 BGP session associated with the virtual circuit.
`VirtualCircuit.Builder`	`bgpManagement(VirtualCircuit.BgpManagement bgpManagement)` Deprecated.
`VirtualCircuit.Builder`	`bgpSessionState(VirtualCircuit.BgpSessionState bgpSessionState)` The state of the Ipv4 BGP session associated with the virtual circuit.
`VirtualCircuit`	`build()`
`VirtualCircuit.Builder`	`compartmentId(String compartmentId)` The OCID of the compartment containing the virtual circuit.
`VirtualCircuit.Builder`	`copy(VirtualCircuit model)`
`VirtualCircuit.Builder`	`crossConnectMappings(List<CrossConnectMapping> crossConnectMappings)` An array of mappings, each containing properties for a cross-connect or cross-connect group that is associated with this virtual circuit.
`VirtualCircuit.Builder`	`customerAsn(Long customerAsn)` The BGP ASN of the network at the other end of the BGP session from Oracle.
`VirtualCircuit.Builder`	`customerBgpAsn(Integer customerBgpAsn)` Deprecated.
`VirtualCircuit.Builder`	`definedTags(Map<String,Map<String,Object>> definedTags)` Defined tags for this resource.
`VirtualCircuit.Builder`	`displayName(String displayName)` A user-friendly name.
`VirtualCircuit.Builder`	`freeformTags(Map<String,String> freeformTags)` Simple key-value pair that is applied without any predefined name, type or scope.
`VirtualCircuit.Builder`	`gatewayId(String gatewayId)` The OCID of the customer’s `Drg` that this virtual circuit uses.
`VirtualCircuit.Builder`	`id(String id)` The virtual circuit’s Oracle ID (OCID).
`VirtualCircuit.Builder`	`ipMtu(VirtualCircuitIpMtu ipMtu)` The layer 3 IP MTU to use on this virtual circuit.
`VirtualCircuit.Builder`	`isBfdEnabled(Boolean isBfdEnabled)` Set to `true` to enable BFD for IPv4 BGP peering, or set to `false` to disable BFD.
`VirtualCircuit.Builder`	`isTransportMode(Boolean isTransportMode)` Set to `true` for the virtual circuit to carry only encrypted traffic, or set to `false` for the virtual circuit to carry unencrypted traffic.
`VirtualCircuit.Builder`	`lifecycleState(VirtualCircuit.LifecycleState lifecycleState)` The virtual circuit’s current state.
`VirtualCircuit.Builder`	`oracleBgpAsn(Integer oracleBgpAsn)` The Oracle BGP ASN.
`VirtualCircuit.Builder`	`providerName(String providerName)` Deprecated.
`VirtualCircuit.Builder`	`providerServiceId(String providerServiceId)` The OCID of the service offered by the provider (if the customer is connecting via a provider).
`VirtualCircuit.Builder`	`providerServiceKeyName(String providerServiceKeyName)` The service key name offered by the provider (if the customer is connecting via a provider).
`VirtualCircuit.Builder`	`providerServiceName(String providerServiceName)` Deprecated.
`VirtualCircuit.Builder`	`providerState(VirtualCircuit.ProviderState providerState)` The provider’s state in relation to this virtual circuit (if the customer is connecting via a provider).
`VirtualCircuit.Builder`	`publicPrefixes(List<String> publicPrefixes)` For a public virtual circuit.
`VirtualCircuit.Builder`	`referenceComment(String referenceComment)` Provider-supplied reference information about this virtual circuit (if the customer is connecting via a provider).
`VirtualCircuit.Builder`	`region(String region)` The Oracle Cloud Infrastructure region where this virtual circuit is located.
`VirtualCircuit.Builder`	`routingPolicy(List<VirtualCircuit.RoutingPolicy> routingPolicy)` The routing policy sets how routing information about the Oracle cloud is shared over a public virtual circuit.
`VirtualCircuit.Builder`	`serviceType(VirtualCircuit.ServiceType serviceType)` Provider service type.
`VirtualCircuit.Builder`	`timeCreated(Date timeCreated)` The date and time the virtual circuit was created, in the format defined by RFC3339.
`VirtualCircuit.Builder`	`type(VirtualCircuit.Type type)` Whether the virtual circuit supports private or public peering.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - bandwidthShapeName
```
public VirtualCircuit.Builder bandwidthShapeName(String bandwidthShapeName)
```
    The provisioned data rate of the connection. To get a list of the available bandwidth levels (that is, shapes), see listFastConnectProviderVirtualCircuitBandwidthShapes.
    
    Example: 10 Gbps
    
    Parameters:
    
    bandwidthShapeName - the value to set
    
    Returns:
    
    this builder
  - bgpManagement
```
public VirtualCircuit.Builder bgpManagement(VirtualCircuit.BgpManagement bgpManagement)
```
    Deprecated. Instead use the information in FastConnectProviderService.
    
    Parameters:
    
    bgpManagement - the value to set
    
    Returns:
    
    this builder
  - bgpSessionState
```
public VirtualCircuit.Builder bgpSessionState(VirtualCircuit.BgpSessionState bgpSessionState)
```
    The state of the Ipv4 BGP session associated with the virtual circuit.
    
    Parameters:
    
    bgpSessionState - the value to set
    
    Returns:
    
    this builder
  - bgpIpv6SessionState
```
public VirtualCircuit.Builder bgpIpv6SessionState(VirtualCircuit.BgpIpv6SessionState bgpIpv6SessionState)
```
    The state of the Ipv6 BGP session associated with the virtual circuit.
    
    Parameters:
    
    bgpIpv6SessionState - the value to set
    
    Returns:
    
    this builder
  - compartmentId
```
public VirtualCircuit.Builder compartmentId(String compartmentId)
```
    The OCID of the compartment containing the virtual circuit.
    
    Parameters:
    
    compartmentId - the value to set
    
    Returns:
    
    this builder
  - crossConnectMappings
```
public VirtualCircuit.Builder crossConnectMappings(List<CrossConnectMapping> crossConnectMappings)
```
    An array of mappings, each containing properties for a cross-connect or cross-connect group that is associated with this virtual circuit.
    
    Parameters:
    
    crossConnectMappings - the value to set
    
    Returns:
    
    this builder
  - routingPolicy
```
public VirtualCircuit.Builder routingPolicy(List<VirtualCircuit.RoutingPolicy> routingPolicy)
```
    The routing policy sets how routing information about the Oracle cloud is shared over a public virtual circuit. Policies available are: ORACLE_SERVICE_NETWORK, REGIONAL, MARKET_LEVEL, and GLOBAL. See Route Filtering for details. By default, routing information is shared for all routes in the same market.
    
    Parameters:
    
    routingPolicy - the value to set
    
    Returns:
    
    this builder
  - bgpAdminState
```
public VirtualCircuit.Builder bgpAdminState(VirtualCircuit.BgpAdminState bgpAdminState)
```
    Set to ENABLED (the default) to activate the BGP session of the virtual circuit, set to DISABLED to deactivate the virtual circuit.
    
    Parameters:
    
    bgpAdminState - the value to set
    
    Returns:
    
    this builder
  - isBfdEnabled
```
public VirtualCircuit.Builder isBfdEnabled(Boolean isBfdEnabled)
```
    Set to true to enable BFD for IPv4 BGP peering, or set to false to disable BFD. If this is not set, the default is false.
    
    Parameters:
    
    isBfdEnabled - the value to set
    
    Returns:
    
    this builder
  - isTransportMode
```
public VirtualCircuit.Builder isTransportMode(Boolean isTransportMode)
```
    Set to true for the virtual circuit to carry only encrypted traffic, or set to false for the virtual circuit to carry unencrypted traffic. If this is not set, the default is false.
    
    Parameters:
    
    isTransportMode - the value to set
    
    Returns:
    
    this builder
  - customerBgpAsn
```
public VirtualCircuit.Builder customerBgpAsn(Integer customerBgpAsn)
```
    Deprecated. Instead use customerAsn. If you specify values for both, the request will be rejected.
    
    Parameters:
    
    customerBgpAsn - the value to set
    
    Returns:
    
    this builder
  - customerAsn
```
public VirtualCircuit.Builder customerAsn(Long customerAsn)
```
    The BGP ASN of the network at the other end of the BGP session from Oracle. If the session is between the customer’s edge router and Oracle, the value is the customer’s ASN. If the BGP session is between the provider’s edge router and Oracle, the value is the provider’s ASN. Can be a 2-byte or 4-byte ASN. Uses “asplain” format.
    
    Parameters:
    
    customerAsn - the value to set
    
    Returns:
    
    this builder
  - definedTags
```
public VirtualCircuit.Builder definedTags(Map<String,Map<String,Object>> definedTags)
```
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}
    
    Parameters:
    
    definedTags - the value to set
    
    Returns:
    
    this builder
  - displayName
```
public VirtualCircuit.Builder displayName(String displayName)
```
    A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
    
    Parameters:
    
    displayName - the value to set
    
    Returns:
    
    this builder
  - freeformTags
```
public VirtualCircuit.Builder freeformTags(Map<String,String> freeformTags)
```
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    
    Parameters:
    
    freeformTags - the value to set
    
    Returns:
    
    this builder
  - gatewayId
```
public VirtualCircuit.Builder gatewayId(String gatewayId)
```
    The OCID of the customer’s Drg that this virtual circuit uses. Applicable only to private virtual circuits.
    
    Parameters:
    
    gatewayId - the value to set
    
    Returns:
    
    this builder
  - id
```
public VirtualCircuit.Builder id(String id)
```
    The virtual circuit’s Oracle ID (OCID).
    
    Parameters:
    
    id - the value to set
    
    Returns:
    
    this builder
  - lifecycleState
```
public VirtualCircuit.Builder lifecycleState(VirtualCircuit.LifecycleState lifecycleState)
```
    The virtual circuit’s current state. For information about the different states, see FastConnect Overview.
    
    Parameters:
    
    lifecycleState - the value to set
    
    Returns:
    
    this builder
  - oracleBgpAsn
```
public VirtualCircuit.Builder oracleBgpAsn(Integer oracleBgpAsn)
```
    The Oracle BGP ASN.
    
    Parameters:
    
    oracleBgpAsn - the value to set
    
    Returns:
    
    this builder
  - providerName
```
public VirtualCircuit.Builder providerName(String providerName)
```
    Deprecated. Instead use providerServiceId.
    
    Parameters:
    
    providerName - the value to set
    
    Returns:
    
    this builder
  - providerServiceId
```
public VirtualCircuit.Builder providerServiceId(String providerServiceId)
```
    The OCID of the service offered by the provider (if the customer is connecting via a provider).
    
    Parameters:
    
    providerServiceId - the value to set
    
    Returns:
    
    this builder
  - providerServiceKeyName
```
public VirtualCircuit.Builder providerServiceKeyName(String providerServiceKeyName)
```
    The service key name offered by the provider (if the customer is connecting via a provider).
    
    Parameters:
    
    providerServiceKeyName - the value to set
    
    Returns:
    
    this builder
  - providerServiceName
```
public VirtualCircuit.Builder providerServiceName(String providerServiceName)
```
    Deprecated. Instead use providerServiceId.
    
    Parameters:
    
    providerServiceName - the value to set
    
    Returns:
    
    this builder
  - providerState
```
public VirtualCircuit.Builder providerState(VirtualCircuit.ProviderState providerState)
```
    The provider’s state in relation to this virtual circuit (if the customer is connecting via a provider). ACTIVE means the provider has provisioned the virtual circuit from their end. INACTIVE means the provider has not yet provisioned the virtual circuit, or has de-provisioned it.
    
    Parameters:
    
    providerState - the value to set
    
    Returns:
    
    this builder
  - publicPrefixes
```
public VirtualCircuit.Builder publicPrefixes(List<String> publicPrefixes)
```
    For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to advertise across the connection. All prefix sizes are allowed.
    
    Parameters:
    
    publicPrefixes - the value to set
    
    Returns:
    
    this builder
  - referenceComment
```
public VirtualCircuit.Builder referenceComment(String referenceComment)
```
    Provider-supplied reference information about this virtual circuit (if the customer is connecting via a provider).
    
    Parameters:
    
    referenceComment - the value to set
    
    Returns:
    
    this builder
  - region
```
public VirtualCircuit.Builder region(String region)
```
    The Oracle Cloud Infrastructure region where this virtual circuit is located.
    
    Parameters:
    
    region - the value to set
    
    Returns:
    
    this builder
  - serviceType
```
public VirtualCircuit.Builder serviceType(VirtualCircuit.ServiceType serviceType)
```
    Provider service type.
    
    Parameters:
    
    serviceType - the value to set
    
    Returns:
    
    this builder
  - timeCreated
```
public VirtualCircuit.Builder timeCreated(Date timeCreated)
```
    The date and time the virtual circuit was created, in the format defined by RFC3339.
    
    Example: 2016-08-25T21:10:29.600Z
    
    Parameters:
    
    timeCreated - the value to set
    
    Returns:
    
    this builder
  - type
```
public VirtualCircuit.Builder type(VirtualCircuit.Type type)
```
    Whether the virtual circuit supports private or public peering. For more information, see FastConnect Overview.
    
    Parameters:
    
    type - the value to set
    
    Returns:
    
    this builder
  - ipMtu
```
public VirtualCircuit.Builder ipMtu(VirtualCircuitIpMtu ipMtu)
```
    The layer 3 IP MTU to use on this virtual circuit.
    
    Parameters:
    
    ipMtu - the value to set
    
    Returns:
    
    this builder
  - build
```
public VirtualCircuit build()
```
  - copy
```
public VirtualCircuit.Builder copy(VirtualCircuit model)
```

Class VirtualCircuit.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

bandwidthShapeName

bgpManagement

bgpSessionState

bgpIpv6SessionState

compartmentId

crossConnectMappings

routingPolicy

bgpAdminState

isBfdEnabled

isTransportMode

customerBgpAsn

customerAsn

definedTags

displayName

freeformTags

gatewayId

id

lifecycleState

oracleBgpAsn

providerName

providerServiceId

providerServiceKeyName

providerServiceName

providerState

publicPrefixes

referenceComment

region

serviceType

timeCreated

type

ipMtu

build

copy