Class DhcpOptions


  • @Generated(value="OracleSDKGenerator",
               comments="API Version: 20160918")
    public final class DhcpOptions
    extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A set of DHCP options.

    Used by the VCN to automatically provide configuration information to the instances when they boot up. There are two options you can set:

    - DhcpDnsOption: Lets you specify how DNS (hostname resolution) is handled in the subnets in your VCN.

    - DhcpSearchDomainOption: Lets you specify a search domain name to use for DNS queries.

    For more information, see [DNS in Your Virtual Cloud Network](https://docs.oracle.com/iaas/Content/Network/Concepts/dns.htm) and [DHCP Options](https://docs.oracle.com/iaas/Content/Network/Tasks/managingDHCP.htm).

    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.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
    Note: Objects should always be created or deserialized using the DhcpOptions.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 DhcpOptions.Builder, which maintain a set of all explicitly set fields called DhcpOptions.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

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment containing the set of DHCP options.
        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()
        Oracle ID (OCID) for the set of DHCP options.
        Returns:
        the value
      • getLifecycleState

        public DhcpOptions.LifecycleState getLifecycleState()
        The current state of the set of DHCP options.
        Returns:
        the value
      • getOptions

        public List<DhcpOption> getOptions()
        The collection of individual DHCP options.
        Returns:
        the value
      • getTimeCreated

        public Date getTimeCreated()
        Date and time the set of DHCP options 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 set of DHCP options belongs to.
        Returns:
        the value
      • getDomainNameType

        public DhcpOptions.DomainNameType getDomainNameType()
        The search domain name type of DHCP options
        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