@Generated(value="OracleSDKGenerator", comments="API Version: 20180115") public final class ZoneSummary extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
A DNS zone.
*Warning:** Oracle recommends that you avoid using any confidential information when you
supply string values using the API.
Note: Objects should always be created or deserialized using the ZoneSummary.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 ZoneSummary.Builder
, which maintain a
set of all explicitly set fields called ZoneSummary.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
).
Modifier and Type | Class and Description |
---|---|
static class |
ZoneSummary.Builder |
static class |
ZoneSummary.LifecycleState
The current state of the zone resource.
|
static class |
ZoneSummary.ZoneType
The type of the zone.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME
Constructor and Description |
---|
ZoneSummary(String name,
ZoneSummary.ZoneType zoneType,
String compartmentId,
String viewId,
Scope scope,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
ZoneDnssecState dnssecState,
String self,
String id,
Date timeCreated,
String version,
Long serial,
ZoneSummary.LifecycleState lifecycleState,
Boolean isProtected,
DnssecConfig dnssecConfig)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static ZoneSummary.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getCompartmentId()
The OCID of the compartment containing the zone.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
DnssecConfig |
getDnssecConfig() |
ZoneDnssecState |
getDnssecState()
The state of DNSSEC on the zone.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
The OCID of the zone.
|
Boolean |
getIsProtected()
A Boolean flag indicating whether or not parts of the resource are unable to be explicitly
managed.
|
ZoneSummary.LifecycleState |
getLifecycleState()
The current state of the zone resource.
|
String |
getName()
The name of the zone.
|
Scope |
getScope()
The scope of the zone.
|
String |
getSelf()
The canonical absolute URL of the resource.
|
Long |
getSerial()
The current serial of the zone.
|
Date |
getTimeCreated()
The date and time the resource was created in “YYYY-MM-ddThh:mm:ssZ” format with a Z offset,
as defined by RFC 3339.
|
String |
getVersion()
Version is the never-repeating, totally-orderable, version of the zone, from which the serial
field of the zone’s SOA record is derived.
|
String |
getViewId()
The OCID of the private view containing the zone.
|
ZoneSummary.ZoneType |
getZoneType()
The type of the zone.
|
int |
hashCode() |
ZoneSummary.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet
@Deprecated @ConstructorProperties(value={"name","zoneType","compartmentId","viewId","scope","freeformTags","definedTags","dnssecState","self","id","timeCreated","version","serial","lifecycleState","isProtected","dnssecConfig"}) public ZoneSummary(String name, ZoneSummary.ZoneType zoneType, String compartmentId, String viewId, Scope scope, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, ZoneDnssecState dnssecState, String self, String id, Date timeCreated, String version, Long serial, ZoneSummary.LifecycleState lifecycleState, Boolean isProtected, DnssecConfig dnssecConfig)
public static ZoneSummary.Builder builder()
Create a new builder.
public ZoneSummary.Builder toBuilder()
public String getName()
The name of the zone.
public ZoneSummary.ZoneType getZoneType()
The type of the zone. Must be either PRIMARY
or SECONDARY
. SECONDARY
is only supported for GLOBAL zones.
public String getCompartmentId()
The OCID of the compartment containing the zone.
public String getViewId()
The OCID of the private view containing the zone. This value will be null for zones in the global DNS, which are publicly resolvable and not part of a private view.
public Scope getScope()
The scope of the zone.
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"}
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"}}
public ZoneDnssecState getDnssecState()
The state of DNSSEC on the zone.
For DNSSEC to function, every parent zone in the DNS tree up to the top-level domain (or
an independent trust anchor) must also have DNSSEC correctly set up. After enabling DNSSEC,
you must add a DS record to the zone's parent zone containing the KskDnssecKeyVersion
data. You can find the DS data in the dsData
attribute of the KskDnssecKeyVersion
. Then, use the PromoteZoneDnssecKeyVersion
operation to promote
the KskDnssecKeyVersion
.
New KskDnssecKeyVersion
s are generated annually, a week before the existing KskDnssecKeyVersion
's expiration. To rollover a KskDnssecKeyVersion
, you must
replace the parent zone's DS record containing the old KskDnssecKeyVersion
data with
the data from the new KskDnssecKeyVersion
.
To remove the old DS record without causing service disruption, wait until the old DS
record's TTL has expired, and the new DS record has propagated. After the DS replacement has
been completed, then the PromoteZoneDnssecKeyVersion
operation must be called.
Metrics are emitted in the oci_dns
namespace daily for each KskDnssecKeyVersion
indicating how many days are left until expiration. We recommend that
you set up alarms and notifications for KskDnssecKeyVersion expiration so that the necessary
parent zone updates can be made and the PromoteZoneDnssecKeyVersion
operation can be
called.
Enabling DNSSEC results in additional records in DNS responses which increases their size and can cause higher response latency.
For more information, see [DNSSEC](https://docs.cloud.oracle.com/iaas/Content/DNS/Concepts/dnssec.htm).
public String getSelf()
The canonical absolute URL of the resource.
public String getId()
The OCID of the zone.
public Date getTimeCreated()
The date and time the resource was created in “YYYY-MM-ddThh:mm:ssZ” format with a Z offset, as defined by RFC 3339.
*Example:** 2016-07-22T17:23:59:60Z
public String getVersion()
Version is the never-repeating, totally-orderable, version of the zone, from which the serial field of the zone’s SOA record is derived.
public Long getSerial()
The current serial of the zone. As seen in the zone’s SOA record.
public ZoneSummary.LifecycleState getLifecycleState()
The current state of the zone resource.
public Boolean getIsProtected()
A Boolean flag indicating whether or not parts of the resource are unable to be explicitly managed.
public DnssecConfig getDnssecConfig()
public String toString()
toString
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents
- true to include the full contents of byte arrayspublic boolean equals(Object o)
equals
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
public int hashCode()
hashCode
in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Copyright © 2016–2024. All rights reserved.