Class Vlan


  • @Generated(value="OracleSDKGenerator",
               comments="API Version: 20160918")
    public final class Vlan
    extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A resource to be used only with the Oracle Cloud VMware Solution.

    Conceptually, a virtual LAN (VLAN) is a broadcast domain that is created by partitioning and isolating a network at the data link layer (a *layer 2 network*). VLANs work by using IEEE 802.1Q VLAN tags. Layer 2 traffic is forwarded within the VLAN based on MAC learning.

    In the Networking service, a VLAN is an object within a VCN. You use VLANs to partition the VCN at the data link layer (layer 2). A VLAN is analagous to a subnet, which is an object for partitioning the VCN at the IP layer (layer 3).
    Note: Objects should always be created or deserialized using the Vlan.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 Vlan.Builder, which maintain a set of all explicitly set fields called Vlan.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • builder

        public static Vlan.Builder builder()
        Create a new builder.
      • getAvailabilityDomain

        public String getAvailabilityDomain()
        The VLAN’s availability domain.

        This attribute will be null if this is a regional VLAN rather than an AD-specific VLAN.

        Example: Uocm:PHX-AD-1

        Returns:
        the value
      • getCidrBlock

        public String getCidrBlock()
        The range of IPv4 addresses that will be used for layer 3 communication with hosts outside the VLAN.

        Example: 192.168.1.0/24

        Returns:
        the value
      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment containing the VLAN.
        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
      • 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 VLAN’s Oracle ID (OCID).
        Returns:
        the value
      • getLifecycleState

        public Vlan.LifecycleState getLifecycleState()
        The VLAN’s current state.
        Returns:
        the value
      • getNsgIds

        public List<String> getNsgIds()
        A list of the OCIDs of the network security groups (NSGs) to use with this VLAN.

        All VNICs in the VLAN belong to these NSGs. For more information about NSGs, see NetworkSecurityGroup.

        Returns:
        the value
      • getVlanTag

        public Integer getVlanTag()
        The IEEE 802.1Q VLAN tag of this VLAN.

        Example: 100

        Returns:
        the value
      • getRouteTableId

        public String getRouteTableId()
        The OCID of the route table that the VLAN uses.
        Returns:
        the value
      • getTimeCreated

        public Date getTimeCreated()
        The date and time the VLAN was created, in the format defined by RFC3339.

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value
      • getVcnId

        public String getVcnId()
        The OCID of the VCN the VLAN is in.
        Returns:
        the value
      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.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 com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel