File: //lib/python3.9/site-packages/ansible_collections/community/dns/plugins/module_utils/provider.py
# -*- coding: utf-8 -*-
#
# Copyright (c) 2017-2021 Felix Fontein
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
import abc
from ansible.module_utils import six
from ansible.module_utils.common.validation import (
check_type_str,
check_type_list,
check_type_dict,
check_type_bool,
check_type_int,
check_type_float,
)
def ensure_type(value, type_name):
if type_name == 'str':
return check_type_str(value)
if type_name == 'list':
return check_type_list(value)
if type_name == 'dict':
return check_type_dict(value)
if type_name == 'bool':
return check_type_bool(value)
if type_name == 'int':
return check_type_int(value)
if type_name == 'float':
return check_type_float(value)
return value
@six.add_metaclass(abc.ABCMeta)
class ProviderInformation(object):
@abc.abstractmethod
def get_zone_id_type(self):
"""
Return the (short) type for zone IDs, like ``'int'`` or ``'str'``.
"""
@abc.abstractmethod
def get_record_id_type(self):
"""
Return the (short) type for record IDs, like ``'int'`` or ``'str'``.
"""
@abc.abstractmethod
def get_record_default_ttl(self):
"""
Return the default TTL for records, like 300, 3600 or None.
None means that some other TTL (usually from the zone) will be used.
"""
@abc.abstractmethod
def get_supported_record_types(self):
"""
Return a list of supported record types.
"""
def normalize_prefix(self, prefix):
"""
Given a prefix (string or None), return its normalized form.
The result should always be None for the trivial prefix, and a non-zero length DNS name
for a non-trivial prefix.
If a provider supports other identifiers for the trivial prefix, such as '@', this
function needs to convert them to None as well.
"""
return prefix or None
def supports_bulk_actions(self):
"""
Return whether the API supports some kind of bulk actions.
"""
return False
@abc.abstractmethod
def txt_record_handling(self):
"""
Return how the API handles TXT records.
Returns one of the following strings:
* 'decoded' - the API works with unencoded values
* 'encoded' - the API works with encoded values
* 'encoded-no-char-encoding' - the API works with encoded values, but without character encoding
"""
def txt_character_encoding(self):
"""
Return how the API handles escape sequences in TXT records.
Returns one of the following strings:
* 'octal' - the API works with octal escape sequences
* 'decimal' - the API works with decimal escape sequences
This return value is only used if txt_record_handling returns 'encoded'.
WARNING: the default return value will change to 'decimal' for community.dns 3.0.0!
"""
return 'octal'