#include <dns_key.h>

Inheritance diagram for google_dns_api::DnsKey:

Public Member Functions
	DnsKey (const Json::Value &storage)

	DnsKey (Json::Value *storage)

virtual	~DnsKey ()

const StringPiece	GetTypeName () const

bool	has_algorithm () const

void	clear_algorithm ()

const StringPiece	get_algorithm () const

void	set_algorithm (const StringPiece &value)

bool	has_creation_time () const

void	clear_creation_time ()

const StringPiece	get_creation_time () const

void	set_creation_time (const StringPiece &value)

bool	has_description () const

void	clear_description ()

const StringPiece	get_description () const

void	set_description (const StringPiece &value)

bool	has_digests () const

void	clear_digests ()

const client::JsonCppArray< DnsKeyDigest >	get_digests () const

client::JsonCppArray< DnsKeyDigest >	mutable_digests ()

bool	has_id () const

void	clear_id ()

const StringPiece	get_id () const

void	set_id (const StringPiece &value)

bool	has_is_active () const

void	clear_is_active ()

bool	get_is_active () const

void	set_is_active (bool value)

bool	has_key_length () const

void	clear_key_length ()

uint32	get_key_length () const

void	set_key_length (uint32 value)

bool	has_key_tag () const

void	clear_key_tag ()

int32	get_key_tag () const

void	set_key_tag (int32 value)

bool	has_kind () const

void	clear_kind ()

const StringPiece	get_kind () const

void	set_kind (const StringPiece &value)

bool	has_public_key () const

void	clear_public_key ()

const StringPiece	get_public_key () const

void	set_public_key (const StringPiece &value)

bool	has_type () const

void	clear_type ()

const StringPiece	get_type () const

void	set_type (const StringPiece &value)

Static Public Member Functions
static DnsKey *	New ()

Detailed Description

A DNSSEC key pair.

Constructor & Destructor Documentation

◆ DnsKey() [1/2]

google_dns_api::DnsKey::DnsKey ( const Json::Value & storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ DnsKey() [2/2]

google_dns_api::DnsKey::DnsKey ( Json::Value * storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ ~DnsKey()

google_dns_api::DnsKey::~DnsKey ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_algorithm()

void google_dns_api::DnsKey::clear_algorithm ( )

inline

Clears the 'algorithm' attribute.

◆ clear_creation_time()

void google_dns_api::DnsKey::clear_creation_time ( )

inline

Clears the 'creationTime' attribute.

◆ clear_description()

void google_dns_api::DnsKey::clear_description ( )

inline

Clears the 'description' attribute.

◆ clear_digests()

void google_dns_api::DnsKey::clear_digests ( )

inline

Clears the 'digests' attribute.

◆ clear_id()

void google_dns_api::DnsKey::clear_id ( )

inline

Clears the 'id' attribute.

◆ clear_is_active()

void google_dns_api::DnsKey::clear_is_active ( )

inline

Clears the 'isActive' attribute.

◆ clear_key_length()

void google_dns_api::DnsKey::clear_key_length ( )

inline

Clears the 'keyLength' attribute.

◆ clear_key_tag()

void google_dns_api::DnsKey::clear_key_tag ( )

inline

Clears the 'keyTag' attribute.

◆ clear_kind()

void google_dns_api::DnsKey::clear_kind ( )

inline

Clears the 'kind' attribute.

◆ clear_public_key()

void google_dns_api::DnsKey::clear_public_key ( )

inline

Clears the 'publicKey' attribute.

◆ clear_type()

void google_dns_api::DnsKey::clear_type ( )

inline

Clears the 'type' attribute.

◆ get_algorithm()

const StringPiece google_dns_api::DnsKey::get_algorithm ( ) const

inline

Get the value of the 'algorithm' attribute.

◆ get_creation_time()

const StringPiece google_dns_api::DnsKey::get_creation_time ( ) const

inline

Get the value of the 'creationTime' attribute.

◆ get_description()

const StringPiece google_dns_api::DnsKey::get_description ( ) const

inline

Get the value of the 'description' attribute.

◆ get_digests()

const client::JsonCppArray<DnsKeyDigest > google_dns_api::DnsKey::get_digests ( ) const

Get a reference to the value of the 'digests' attribute.

◆ get_id()

const StringPiece google_dns_api::DnsKey::get_id ( ) const

inline

Get the value of the 'id' attribute.

◆ get_is_active()

bool google_dns_api::DnsKey::get_is_active ( ) const

inline

Get the value of the 'isActive' attribute.

◆ get_key_length()

uint32 google_dns_api::DnsKey::get_key_length ( ) const

inline

Get the value of the 'keyLength' attribute.

◆ get_key_tag()

int32 google_dns_api::DnsKey::get_key_tag ( ) const

inline

Get the value of the 'keyTag' attribute.

◆ get_kind()

const StringPiece google_dns_api::DnsKey::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

◆ get_public_key()

const StringPiece google_dns_api::DnsKey::get_public_key ( ) const

inline

Get the value of the 'publicKey' attribute.

◆ get_type()

const StringPiece google_dns_api::DnsKey::get_type ( ) const

inline

Get the value of the 'type' attribute.

◆ GetTypeName()

const StringPiece google_dns_api::DnsKey::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_dns_api::DnsKey

◆ has_algorithm()

bool google_dns_api::DnsKey::has_algorithm ( ) const

inline

Determine if the 'algorithm' attribute was set.

Returns: true if the 'algorithm' attribute was set.

◆ has_creation_time()

bool google_dns_api::DnsKey::has_creation_time ( ) const

inline

Determine if the 'creationTime' attribute was set.

Returns: true if the 'creationTime' attribute was set.

◆ has_description()

bool google_dns_api::DnsKey::has_description ( ) const

inline

Determine if the 'description' attribute was set.

Returns: true if the 'description' attribute was set.

◆ has_digests()

bool google_dns_api::DnsKey::has_digests ( ) const

inline

Determine if the 'digests' attribute was set.

Returns: true if the 'digests' attribute was set.

◆ has_id()

bool google_dns_api::DnsKey::has_id ( ) const

inline

Determine if the 'id' attribute was set.

Returns: true if the 'id' attribute was set.

◆ has_is_active()

bool google_dns_api::DnsKey::has_is_active ( ) const

inline

Determine if the 'isActive' attribute was set.

Returns: true if the 'isActive' attribute was set.

◆ has_key_length()

bool google_dns_api::DnsKey::has_key_length ( ) const

inline

Determine if the 'keyLength' attribute was set.

Returns: true if the 'keyLength' attribute was set.

◆ has_key_tag()

bool google_dns_api::DnsKey::has_key_tag ( ) const

inline

Determine if the 'keyTag' attribute was set.

Returns: true if the 'keyTag' attribute was set.

◆ has_kind()

bool google_dns_api::DnsKey::has_kind ( ) const

inline

Determine if the 'kind' attribute was set.

Returns: true if the 'kind' attribute was set.

◆ has_public_key()

bool google_dns_api::DnsKey::has_public_key ( ) const

inline

Determine if the 'publicKey' attribute was set.

Returns: true if the 'publicKey' attribute was set.

◆ has_type()

bool google_dns_api::DnsKey::has_type ( ) const

inline

Determine if the 'type' attribute was set.

Returns: true if the 'type' attribute was set.

◆ mutable_digests()

client::JsonCppArray<DnsKeyDigest > google_dns_api::DnsKey::mutable_digests ( )

Gets a reference to a mutable value of the 'digests' property.

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: The result can be modified to change the attribute value.

◆ New()

DnsKey * google_dns_api::DnsKey::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_algorithm()

void google_dns_api::DnsKey::set_algorithm ( const StringPiece & value )

inline

Change the 'algorithm' attribute.

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

Parameters

[in] value The new value.

◆ set_creation_time()

void google_dns_api::DnsKey::set_creation_time ( const StringPiece & value )

inline

Change the 'creationTime' attribute.

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

Parameters

[in] value The new value.

◆ set_description()

void google_dns_api::DnsKey::set_description ( const StringPiece & value )

inline

Change the 'description' attribute.

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

[in] value The new value.

◆ set_id()

void google_dns_api::DnsKey::set_id ( const StringPiece & value )

inline

Change the 'id' attribute.

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

Parameters

[in] value The new value.

◆ set_is_active()

void google_dns_api::DnsKey::set_is_active ( bool value )

inline

Change the 'isActive' attribute.

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

Parameters

[in] value The new value.

◆ set_key_length()

void google_dns_api::DnsKey::set_key_length ( uint32 value )

inline

Change the 'keyLength' attribute.

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

Parameters

[in] value The new value.

◆ set_key_tag()

void google_dns_api::DnsKey::set_key_tag ( int32 value )

inline

Change the 'keyTag' attribute.

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

[in] value The new value.

◆ set_kind()

void google_dns_api::DnsKey::set_kind ( const StringPiece & value )

inline

Change the 'kind' attribute.

Identifies what kind of resource this is. Value: the fixed string "dns#dnsKey".

Parameters

[in] value The new value.

◆ set_public_key()

void google_dns_api::DnsKey::set_public_key ( const StringPiece & value )

inline

Change the 'publicKey' attribute.

Base64 encoded public half of this key. Output only.

Parameters

[in] value The new value.

◆ set_type()

void google_dns_api::DnsKey::set_type ( const StringPiece & value )

inline

Change the 'type' attribute.

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

Parameters

[in] value The new value.

The documentation for this class was generated from the following files:

google/dns_api/dns_key.h
google/dns_api/dns_key.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ DnsKey() [1/2]

◆ DnsKey() [2/2]

◆ ~DnsKey()

Member Function Documentation

◆ clear_algorithm()

◆ clear_creation_time()

◆ clear_description()

◆ clear_digests()

◆ clear_id()

◆ clear_is_active()

◆ clear_key_length()

◆ clear_key_tag()

◆ clear_kind()

◆ clear_public_key()

◆ clear_type()

◆ get_algorithm()

◆ get_creation_time()

◆ get_description()

◆ get_digests()

◆ get_id()

◆ get_is_active()

◆ get_key_length()

◆ get_key_tag()

◆ get_kind()

◆ get_public_key()

◆ get_type()

◆ GetTypeName()

◆ has_algorithm()

◆ has_creation_time()

◆ has_description()

◆ has_digests()

◆ has_id()

◆ has_is_active()

◆ has_key_length()

◆ has_key_tag()

◆ has_kind()

◆ has_public_key()

◆ has_type()

◆ mutable_digests()

◆ New()

◆ set_algorithm()

◆ set_creation_time()

◆ set_description()

◆ set_id()

◆ set_is_active()

◆ set_key_length()

◆ set_key_tag()

◆ set_kind()

◆ set_public_key()

◆ set_type()