com.google.api.services.dns.model

Class DnsKey

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.dns.model.DnsKey

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class DnsKey
extends GenericJson

A DNSSEC key pair.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud DNS API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
DnsKey()

Method Summary

Modifier and Type	Method and Description
DnsKey	clone()
String	getAlgorithm() String mnemonic specifying the DNSSEC algorithm of this key.
String	getCreationTime() The time that this resource was created in the control plane.
String	getDescription() A mutable string of at most 1024 characters associated with this resource for the user's convenience.
List<DnsKeyDigest>	getDigests() Cryptographic hashes of the DNSKEY resource record associated with this DnsKey.
String	getId() Unique identifier for the resource; defined by the server (output only).
Boolean	getIsActive() Active keys are used to sign subsequent changes to the ManagedZone.
Long	getKeyLength() Length of the key in bits.
Integer	getKeyTag() The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey.
String	getKind()
String	getPublicKey() Base64 encoded public half of this key.
String	getType() One of "KEY_SIGNING" or "ZONE_SIGNING".
DnsKey	set(String fieldName, Object value)
DnsKey	setAlgorithm(String algorithm) String mnemonic specifying the DNSSEC algorithm of this key.
DnsKey	setCreationTime(String creationTime) The time that this resource was created in the control plane.
DnsKey	setDescription(String description) A mutable string of at most 1024 characters associated with this resource for the user's convenience.
DnsKey	setDigests(List<DnsKeyDigest> digests) Cryptographic hashes of the DNSKEY resource record associated with this DnsKey.
DnsKey	setId(String id) Unique identifier for the resource; defined by the server (output only).
DnsKey	setIsActive(Boolean isActive) Active keys are used to sign subsequent changes to the ManagedZone.
DnsKey	setKeyLength(Long keyLength) Length of the key in bits.
DnsKey	setKeyTag(Integer keyTag) The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey.
DnsKey	setKind(String kind)
DnsKey	setPublicKey(String publicKey) Base64 encoded public half of this key.
DnsKey	setType(String type) One of "KEY_SIGNING" or "ZONE_SIGNING".

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

DnsKey

public DnsKey()

Method Detail

getAlgorithm

public String getAlgorithm()

String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.

Returns:

value or null for none

setAlgorithm

public DnsKey setAlgorithm(String algorithm)

String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time.

Parameters:

algorithm - algorithm or null for none

getCreationTime

public String getCreationTime()

The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.

Returns:

value or null for none

setCreationTime

public DnsKey setCreationTime(String creationTime)

The time that this resource was created in the control plane. This is in RFC3339 text format. Output only.

Parameters:

creationTime - creationTime or null for none

getDescription

public String getDescription()

A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.

Returns:

value or null for none

setDescription

public DnsKey setDescription(String description)

A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function.

Parameters:

description - description or null for none

getDigests

public List<DnsKeyDigest> getDigests()

Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.

Returns:

value or null for none

setDigests

public DnsKey setDigests(List<DnsKeyDigest> digests)

Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only.

Parameters:

digests - digests or null for none

getId

public String getId()

Unique identifier for the resource; defined by the server (output only).

Returns:

value or null for none

setId

public DnsKey setId(String id)

Unique identifier for the resource; defined by the server (output only).

Parameters:

id - id or null for none

getIsActive

public Boolean getIsActive()

Active keys are used to sign subsequent changes to the ManagedZone. Inactive keys are still present as DNSKEY Resource Records for the use of resolvers validating existing signatures.

Returns:

value or null for none

setIsActive

public DnsKey setIsActive(Boolean isActive)

Active keys are used to sign subsequent changes to the ManagedZone. Inactive keys are still present as DNSKEY Resource Records for the use of resolvers validating existing signatures.

Parameters:

isActive - isActive or null for none

getKeyLength

public Long getKeyLength()

Length of the key in bits. Specified at creation time, and then immutable.

Returns:

value or null for none

setKeyLength

public DnsKey setKeyLength(Long keyLength)

Length of the key in bits. Specified at creation time, and then immutable.

Parameters:

keyLength - keyLength or null for none

getKeyTag

public Integer getKeyTag()

The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.

Returns:

value or null for none

setKeyTag

public DnsKey setKeyTag(Integer keyTag)

The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only.

Parameters:

keyTag - keyTag or null for none

getKind

public String getKind()

Returns:

value or null for none

setKind

public DnsKey setKind(String kind)

Parameters:

kind - kind or null for none

getPublicKey

public String getPublicKey()

Base64 encoded public half of this key. Output only.

Returns:

value or null for none

setPublicKey

public DnsKey setPublicKey(String publicKey)

Base64 encoded public half of this key. Output only.

Parameters:

publicKey - publicKey or null for none

getType

public String getType()

One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, are used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag is cleared, and this key is used to sign only resource record sets of other types. Immutable after creation time.

Returns:

value or null for none

setType

public DnsKey setType(String type)

One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, are used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag is cleared, and this key is used to sign only resource record sets of other types. Immutable after creation time.

Parameters:

type - type or null for none

set

public DnsKey set(String fieldName,
                  Object value)

Overrides:

set in class GenericJson

clone

public DnsKey clone()

Overrides:

clone in class GenericJson