com.oracle.bmc.core.model

Class DhcpOptions

java.lang.Object

com.oracle.bmc.core.model.DhcpOptions

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class DhcpOptions
extends Object

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.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm) and [DHCP Options](https://docs.cloud.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.cloud.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 __explicitlySet__. The hashCode() and equals(Object) methods are implemented to take __explicitlySet__ into account. The constructor, on the other hand, does not set __explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DhcpOptions.Builder
static class	DhcpOptions.DomainNameType The search domain name type of DHCP options
static class	DhcpOptions.LifecycleState The current state of the set of DHCP options.

Constructor Summary

Constructors

Constructor and Description
DhcpOptions(String compartmentId, Map<String,Map<String,Object>> definedTags, String displayName, Map<String,String> freeformTags, String id, DhcpOptions.LifecycleState lifecycleState, List<DhcpOption> options, Date timeCreated, String vcnId, DhcpOptions.DomainNameType domainNameType) Deprecated.

Method Summary

Modifier and Type	Method and Description
static DhcpOptions.Builder	builder() Create a new builder.
boolean	equals(Object o)
Set<String>	get__explicitlySet__()
String	getCompartmentId() The OCID of the compartment containing the set of DHCP options.
Map<String,Map<String,Object>>	getDefinedTags() Defined tags for this resource.
String	getDisplayName() A user-friendly name.
DhcpOptions.DomainNameType	getDomainNameType() The search domain name type of DHCP options
Map<String,String>	getFreeformTags() Free-form tags for this resource.
String	getId() Oracle ID (OCID) for the set of DHCP options.
DhcpOptions.LifecycleState	getLifecycleState() The current state of the set of DHCP options.
List<DhcpOption>	getOptions() The collection of individual DHCP options.
Date	getTimeCreated() Date and time the set of DHCP options was created, in the format defined by RFC3339.
String	getVcnId() The OCID of the VCN the set of DHCP options belongs to.
int	hashCode()
DhcpOptions.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DhcpOptions

@ConstructorProperties(value={"compartmentId","definedTags","displayName","freeformTags","id","lifecycleState","options","timeCreated","vcnId","domainNameType"})
 @Deprecated
public DhcpOptions(String compartmentId,
                                                                                                                                                                                                  Map<String,Map<String,Object>> definedTags,
                                                                                                                                                                                                  String displayName,
                                                                                                                                                                                                  Map<String,String> freeformTags,
                                                                                                                                                                                                  String id,
                                                                                                                                                                                                  DhcpOptions.LifecycleState lifecycleState,
                                                                                                                                                                                                  List<DhcpOption> options,
                                                                                                                                                                                                  Date timeCreated,
                                                                                                                                                                                                  String vcnId,
                                                                                                                                                                                                  DhcpOptions.DomainNameType domainNameType)

Deprecated.

Method Detail

builder

public static DhcpOptions.Builder builder()

Create a new builder.

toBuilder

public DhcpOptions.Builder toBuilder()

getCompartmentId

public String getCompartmentId()

The OCID of the compartment containing the set of DHCP options.

getDefinedTags

public Map<String,Map<String,Object>> getDefinedTags()

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {"Operations": {"CostCenter": "42"}}

getDisplayName

public String getDisplayName()

A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

getFreeformTags

public Map<String,String> getFreeformTags()

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {"Department": "Finance"}

getId

public String getId()

Oracle ID (OCID) for the set of DHCP options.

getLifecycleState

public DhcpOptions.LifecycleState getLifecycleState()

The current state of the set of DHCP options.

getOptions

public List<DhcpOption> getOptions()

The collection of individual DHCP options.

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

getVcnId

public String getVcnId()

The OCID of the VCN the set of DHCP options belongs to.

getDomainNameType

public DhcpOptions.DomainNameType getDomainNameType()

The search domain name type of DHCP options

get__explicitlySet__

public Set<String> get__explicitlySet__()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object