dns  v1
Public Member Functions | Static Public Member Functions | List of all members
google_dns_api::DnsKeySpec Class Reference

#include <dns_key_spec.h>

Inheritance diagram for google_dns_api::DnsKeySpec:

Public Member Functions

 DnsKeySpec (const Json::Value &storage)
 
 DnsKeySpec (Json::Value *storage)
 
virtual ~DnsKeySpec ()
 
const StringPiece GetTypeName () const
 
bool has_algorithm () const
 
void clear_algorithm ()
 
const StringPiece get_algorithm () const
 
void set_algorithm (const StringPiece &value)
 
bool has_key_length () const
 
void clear_key_length ()
 
uint32 get_key_length () const
 
void set_key_length (uint32 value)
 
bool has_key_type () const
 
void clear_key_type ()
 
const StringPiece get_key_type () const
 
void set_key_type (const StringPiece &value)
 
bool has_kind () const
 
void clear_kind ()
 
const StringPiece get_kind () const
 
void set_kind (const StringPiece &value)
 

Static Public Member Functions

static DnsKeySpecNew ()
 

Detailed Description

Parameters for DnsKey key generation. Used for generating initial keys for a new ManagedZone and as default when adding a new DnsKey.

Constructor & Destructor Documentation

◆ DnsKeySpec() [1/2]

google_dns_api::DnsKeySpec::DnsKeySpec ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ DnsKeySpec() [2/2]

google_dns_api::DnsKeySpec::DnsKeySpec ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~DnsKeySpec()

google_dns_api::DnsKeySpec::~DnsKeySpec ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_algorithm()

void google_dns_api::DnsKeySpec::clear_algorithm ( )
inline

Clears the 'algorithm' attribute.

◆ clear_key_length()

void google_dns_api::DnsKeySpec::clear_key_length ( )
inline

Clears the 'keyLength' attribute.

◆ clear_key_type()

void google_dns_api::DnsKeySpec::clear_key_type ( )
inline

Clears the 'keyType' attribute.

◆ clear_kind()

void google_dns_api::DnsKeySpec::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ get_algorithm()

const StringPiece google_dns_api::DnsKeySpec::get_algorithm ( ) const
inline

Get the value of the 'algorithm' attribute.

◆ get_key_length()

uint32 google_dns_api::DnsKeySpec::get_key_length ( ) const
inline

Get the value of the 'keyLength' attribute.

◆ get_key_type()

const StringPiece google_dns_api::DnsKeySpec::get_key_type ( ) const
inline

Get the value of the 'keyType' attribute.

◆ get_kind()

const StringPiece google_dns_api::DnsKeySpec::get_kind ( ) const
inline

Get the value of the 'kind' attribute.

◆ GetTypeName()

const StringPiece google_dns_api::DnsKeySpec::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_dns_api::DnsKeySpec

◆ has_algorithm()

bool google_dns_api::DnsKeySpec::has_algorithm ( ) const
inline

Determine if the 'algorithm' attribute was set.

Returns
true if the 'algorithm' attribute was set.

◆ has_key_length()

bool google_dns_api::DnsKeySpec::has_key_length ( ) const
inline

Determine if the 'keyLength' attribute was set.

Returns
true if the 'keyLength' attribute was set.

◆ has_key_type()

bool google_dns_api::DnsKeySpec::has_key_type ( ) const
inline

Determine if the 'keyType' attribute was set.

Returns
true if the 'keyType' attribute was set.

◆ has_kind()

bool google_dns_api::DnsKeySpec::has_kind ( ) const
inline

Determine if the 'kind' attribute was set.

Returns
true if the 'kind' attribute was set.

◆ New()

DnsKeySpec * google_dns_api::DnsKeySpec::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_algorithm()

void google_dns_api::DnsKeySpec::set_algorithm ( const StringPiece &  value)
inline

Change the 'algorithm' attribute.

String mnemonic specifying the DNSSEC algorithm of this key.

Parameters
[in]valueThe new value.

◆ set_key_length()

void google_dns_api::DnsKeySpec::set_key_length ( uint32  value)
inline

Change the 'keyLength' attribute.

Length of the keys in bits.

Parameters
[in]valueThe new value.

◆ set_key_type()

void google_dns_api::DnsKeySpec::set_key_type ( const StringPiece &  value)
inline

Change the 'keyType' attribute.

Specifies whether this is a key signing key (KSK) or a zone signing key (ZSK). Key signing keys have the Secure Entry Point flag set and, when active, will only be used to sign resource record sets of type DNSKEY. Zone signing keys do not have the Secure Entry Point flag set and will be used to sign all other types of resource record sets.

Parameters
[in]valueThe new value.

◆ set_kind()

void google_dns_api::DnsKeySpec::set_kind ( const StringPiece &  value)
inline

Change the 'kind' attribute.

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

Parameters
[in]valueThe new value.

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