Vcn (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.http.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.vnmonitoring.model.Vcn

```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class Vcn
extends ExplicitlySetBmcModel
```
A virtual cloud network (VCN). For more information, see Overview of the Networking Service.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
Note: Objects should always be created or deserialized using the Vcn.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the Vcn.Builder, which maintain a set of all explicitly set fields called ExplicitlySetBmcModel.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take ExplicitlySetBmcModel.__explicitlySet__ into account. The constructor, on the other hand, does not set ExplicitlySetBmcModel.__explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Vcn.Builder

static class Vcn.LifecycleState
The VCN’s current state.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Vcn.Builder`
`static class`	`Vcn.LifecycleState` The VCN’s current state.

Constructor Summary

Constructors
Constructor and Description
`Vcn(String cidrBlock, String compartmentId, String defaultDhcpOptionsId, String defaultRouteTableId, String defaultSecurityListId, Map<String,Map<String,Object>> definedTags, String displayName, String dnsLabel, Map<String,String> freeformTags, String id, String ipv6CidrBlock, String ipv6PublicCidrBlock, Vcn.LifecycleState lifecycleState, Date timeCreated, String vcnDomainName)` Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Vcn.Builder`	`builder()` Create a new builder.
`boolean`	`equals(Object o)`
`String`	`getCidrBlock()` The CIDR block IP address of the VCN.
`String`	`getCompartmentId()` The OCID of the compartment containing the VCN.
`String`	`getDefaultDhcpOptionsId()` The OCID for the VCN’s default set of DHCP options.
`String`	`getDefaultRouteTableId()` The OCID for the VCN’s default route table.
`String`	`getDefaultSecurityListId()` The OCID for the VCN’s default security list.
`Map<String,Map<String,Object>>`	`getDefinedTags()` Defined tags for this resource.
`String`	`getDisplayName()` A user-friendly name.
`String`	`getDnsLabel()` A DNS label for the VCN, used in conjunction with the VNIC’s hostname and subnet’s DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (for example, `bminstance-1.subnet123.vcn1.oraclevcn.com`).
`Map<String,String>`	`getFreeformTags()` Simple key-value pair that is applied without any predefined name, type or scope.
`String`	`getId()` The VCN’s Oracle ID (OCID).
`String`	`getIpv6CidrBlock()` For an IPv6-enabled VCN, this is the IPv6 CIDR block for the VCN’s private IP address space.
`String`	`getIpv6PublicCidrBlock()` For an IPv6-enabled VCN, this is the IPv6 CIDR block for the VCN’s public IP address space.
`Vcn.LifecycleState`	`getLifecycleState()` The VCN’s current state.
`Date`	`getTimeCreated()` The date and time the VCN was created, in the format defined by RFC3339.
`String`	`getVcnDomainName()` The VCN’s domain name, which consists of the VCN’s DNS label, and the `oraclevcn.com` domain.
`int`	`hashCode()`
`Vcn.Builder`	`toBuilder()`
`String`	`toString()`
`String`	`toString(boolean includeByteArrayContents)` Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.internal.ExplicitlySetBmcModel
markPropertyAsExplicitlySet, wasPropertyExplicitlySet

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

Constructor Detail

Vcn

@Deprecated
 @ConstructorProperties(value={"cidrBlock","compartmentId","defaultDhcpOptionsId","defaultRouteTableId","defaultSecurityListId","definedTags","displayName","dnsLabel","freeformTags","id","ipv6CidrBlock","ipv6PublicCidrBlock","lifecycleState","timeCreated","vcnDomainName"})
public Vcn(String cidrBlock,
                                                                                                                                                                                                                                                                                                         String compartmentId,
                                                                                                                                                                                                                                                                                                         String defaultDhcpOptionsId,
                                                                                                                                                                                                                                                                                                         String defaultRouteTableId,
                                                                                                                                                                                                                                                                                                         String defaultSecurityListId,
                                                                                                                                                                                                                                                                                                         Map<String,Map<String,Object>> definedTags,
                                                                                                                                                                                                                                                                                                         String displayName,
                                                                                                                                                                                                                                                                                                         String dnsLabel,
                                                                                                                                                                                                                                                                                                         Map<String,String> freeformTags,
                                                                                                                                                                                                                                                                                                         String id,
                                                                                                                                                                                                                                                                                                         String ipv6CidrBlock,
                                                                                                                                                                                                                                                                                                         String ipv6PublicCidrBlock,
                                                                                                                                                                                                                                                                                                         Vcn.LifecycleState lifecycleState,
                                                                                                                                                                                                                                                                                                         Date timeCreated,
                                                                                                                                                                                                                                                                                                         String vcnDomainName)

Deprecated.

Method Detail
- builder
```
public static Vcn.Builder builder()
```
  Create a new builder.
- toBuilder
```
public Vcn.Builder toBuilder()
```
- getCidrBlock
```
public String getCidrBlock()
```
  The CIDR block IP address of the VCN.
  
  Example: 172.16.0.0/16
  
  Returns:
  
  the value
- getCompartmentId
```
public String getCompartmentId()
```
  The OCID of the compartment containing the VCN.
  
  Returns:
  
  the value
- getDefaultDhcpOptionsId
```
public String getDefaultDhcpOptionsId()
```
  The OCID for the VCN’s default set of DHCP options.
  
  Returns:
  
  the value
- getDefaultRouteTableId
```
public String getDefaultRouteTableId()
```
  The OCID for the VCN’s default route table.
  
  Returns:
  
  the value
- getDefaultSecurityListId
```
public String getDefaultSecurityListId()
```
  The OCID for the VCN’s default security list.
  
  Returns:
  
  the value
- getDefinedTags
```
public Map<String,Map<String,Object>> getDefinedTags()
```
  Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}
  
  Returns:
  
  the value
- getDisplayName
```
public String getDisplayName()
```
  A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
  
  Returns:
  
  the value
- getDnsLabel
```
public String getDnsLabel()
```
  A DNS label for the VCN, used in conjunction with the VNIC’s hostname and subnet’s DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (for example, bminstance-1.subnet123.vcn1.oraclevcn.com). Must be an alphanumeric string that begins with a letter. The value cannot be changed.
  
  The absence of this parameter means the Internet and VCN Resolver will not work for this VCN.
  For more information, see [DNS in Your Virtual Cloud Network](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).
  Example: vcn1
  
  Returns:
  
  the value
- getFreeformTags
```
public Map<String,String> getFreeformTags()
```
  Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
  
  Returns:
  
  the value
- getId
```
public String getId()
```
  The VCN’s Oracle ID (OCID).
  
  Returns:
  
  the value
- getIpv6CidrBlock
```
public String getIpv6CidrBlock()
```
  For an IPv6-enabled VCN, this is the IPv6 CIDR block for the VCN’s private IP address space. The VCN size is always /56. Oracle provides the IPv6 CIDR block to use as the same CIDR for the ipv6PublicCidrBlock. When creating a subnet, specify the last 8 bits, 00 to FF. See IPv6 Addresses. Example: 2001:0db8:0123::/56
  
  Returns:
  
  the value
- getIpv6PublicCidrBlock
```
public String getIpv6PublicCidrBlock()
```
  For an IPv6-enabled VCN, this is the IPv6 CIDR block for the VCN’s public IP address space. The VCN size is always /56. This CIDR is always provided by Oracle. If you don’t provide a custom CIDR for the ipv6CidrBlock when creating the VCN, Oracle assigns that value and also uses it for ipv6PublicCidrBlock. Oracle uses addresses from this block for the publicIpAddress attribute of an Ipv6 that has internet access allowed.
  
  Example: 2001:0db8:0123::/48
  
  Returns:
  
  the value
- getLifecycleState
```
public Vcn.LifecycleState getLifecycleState()
```
  The VCN’s current state.
  
  Returns:
  
  the value
- getTimeCreated
```
public Date getTimeCreated()
```
  The date and time the VCN was created, in the format defined by RFC3339.
  
  Example: 2016-08-25T21:10:29.600Z
  
  Returns:
  
  the value
- getVcnDomainName
```
public String getVcnDomainName()
```
  The VCN’s domain name, which consists of the VCN’s DNS label, and the oraclevcn.com domain.
  
  For more information, see [DNS in Your Virtual Cloud Network](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).
  Example: vcn1.oraclevcn.com
  
  Returns:
  
  the value
- toString
```
public String toString()
```
  Overrides:
  
  toString in class ExplicitlySetBmcModel
- toString
```
public String toString(boolean includeByteArrayContents)
```
  Return a string representation of the object.
  
  Parameters:
  
  includeByteArrayContents - true to include the full contents of byte arrays
  
  Returns:
  
  string representation
- equals
```
public boolean equals(Object o)
```
  Overrides:
  
  equals in class ExplicitlySetBmcModel
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class ExplicitlySetBmcModel

Class Vcn

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.http.internal.ExplicitlySetBmcModel

Methods inherited from class java.lang.Object

Constructor Detail

Vcn

Method Detail

builder

toBuilder

getCidrBlock

getCompartmentId

getDefaultDhcpOptionsId

getDefaultRouteTableId

getDefaultSecurityListId

getDefinedTags

getDisplayName

getDnsLabel

getFreeformTags

getId

getIpv6CidrBlock

getIpv6PublicCidrBlock

getLifecycleState

getTimeCreated

getVcnDomainName

toString

toString

equals

hashCode