af4e09f938
Updated JavaDocs for consistency and clarity, modified styling with CSS variables for better maintainability, and enhanced script functionality for interactivity. Minor localization changes and accessibility improvements made to the generated documentation.
560 lines
47 KiB
HTML
560 lines
47 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (21) on Sat Apr 19 11:31:09 CEST 2025 -->
|
|
<title>CfDnsClient (CloudflareDNS-java 0.1.0-SNAPSHOT API)</title>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
<meta name="dc.created" content="2025-04-19">
|
|
<meta name="description" content="declaration: package: codes.thischwa.cf, class: CfDnsClient">
|
|
<meta name="generator" content="javadoc/ClassWriterImpl">
|
|
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
|
|
<link rel="stylesheet" type="text/css" href="../../../script-dir/jquery-ui.min.css" title="Style">
|
|
<script type="text/javascript" src="../../../script.js"></script>
|
|
<script type="text/javascript" src="../../../script-dir/jquery-3.6.1.min.js"></script>
|
|
<script type="text/javascript" src="../../../script-dir/jquery-ui.min.js"></script>
|
|
</head>
|
|
<body class="class-declaration-page">
|
|
<script type="text/javascript">var pathtoroot = "../../../";
|
|
loadScripts(document, 'script');</script>
|
|
<noscript>
|
|
<div>JavaScript ist im Browser deaktiviert.</div>
|
|
</noscript>
|
|
<div class="flex-box">
|
|
<header role="banner" class="flex-header">
|
|
<nav role="navigation">
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Navigationslinks umschalten"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button>
|
|
<div class="skip-nav"><a href="#skip-navbar-top" title="Navigations-Links überspringen">Navigations-Links überspringen</a></div>
|
|
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
|
|
<li><a href="../../../index.html">Überblick</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="nav-bar-cell1-rev">Klasse</li>
|
|
<li><a href="class-use/CfDnsClient.html">Verwendung</a></li>
|
|
<li><a href="package-tree.html">Baum</a></li>
|
|
<li><a href="../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../help-doc.html#class">Hilfe</a></li>
|
|
</ul>
|
|
<ul class="sub-nav-list-small">
|
|
<li>
|
|
<p>Übersicht:</p>
|
|
<ul>
|
|
<li>Verschachtelt</li>
|
|
<li>Feld</li>
|
|
<li><a href="#constructor-summary">Konstruktor</a></li>
|
|
<li><a href="#method-summary">Methode</a></li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p>Details:</p>
|
|
<ul>
|
|
<li>Feld</li>
|
|
<li><a href="#constructor-detail">Konstruktor</a></li>
|
|
<li><a href="#method-detail">Methode</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="sub-nav">
|
|
<div id="navbar-sub-list">
|
|
<ul class="sub-nav-list">
|
|
<li>Übersicht: </li>
|
|
<li>Verschachtelt | </li>
|
|
<li>Feld | </li>
|
|
<li><a href="#constructor-summary">Konstruktor</a> | </li>
|
|
<li><a href="#method-summary">Methode</a></li>
|
|
</ul>
|
|
<ul class="sub-nav-list">
|
|
<li>Details: </li>
|
|
<li>Feld | </li>
|
|
<li><a href="#constructor-detail">Konstruktor</a> | </li>
|
|
<li><a href="#method-detail">Methode</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="nav-list-search"><a href="../../../search.html">SEARCH</a>
|
|
<input type="text" id="search-input" disabled placeholder="Suchen">
|
|
<input type="reset" id="reset-button" disabled value="reset">
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<span class="skip-nav" id="skip-navbar-top"></span></nav>
|
|
</header>
|
|
<div class="flex-content">
|
|
<main role="main">
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">codes.thischwa.cf</a></div>
|
|
<h1 title="Klasse CfDnsClient" class="title">Klasse CfDnsClient</h1>
|
|
</div>
|
|
<div class="inheritance" title="Vererbungsbaum"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">java.lang.Object</a>
|
|
<div class="inheritance">codes.thischwa.cf.CfDnsClient</div>
|
|
</div>
|
|
<section class="class-description" id="class-description">
|
|
<hr>
|
|
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">CfDnsClient</span>
|
|
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">Object</a></span></div>
|
|
<div class="block">CfDnsClient is a client interface to interact with Cloudflare DNS service. It allows managing DNS
|
|
records and zones within the Cloudflare system, including creating, updating, retrieving, and
|
|
deleting DNS records.
|
|
|
|
<p>Example:
|
|
|
|
<pre><code>
|
|
// Create a new CfDnsClient instance
|
|
CfDnsClient cfDnsClient = new CfDnsClient(
|
|
"email@example.com",
|
|
"yourApiKey"
|
|
);
|
|
|
|
// Retrieve a zone
|
|
ZoneEntity zone = cfDnsClient.zoneInfo("example.com");
|
|
System.out.println("Zone ID: " + zone.getId());
|
|
|
|
// Retrieve records of a zone
|
|
List<<a href="model/RecordEntity.html" title="Klasse in codes.thischwa.cf.model"><code>RecordEntity</code></a>> records = cfDnsClient.sldListAll(zone, "sld");
|
|
records.forEach(record ->
|
|
System.out.println("Record Type: " + record.getType() + ", Value: " + record.getContent())
|
|
);
|
|
</code></pre></div>
|
|
</section>
|
|
<section class="summary">
|
|
<ul class="summary-list">
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<li>
|
|
<section class="constructor-summary" id="constructor-summary">
|
|
<h2>Konstruktorübersicht</h2>
|
|
<div class="caption"><span>Konstruktoren</span></div>
|
|
<div class="summary-table two-column-summary">
|
|
<div class="table-header col-first">Konstruktor</div>
|
|
<div class="table-header col-last">Beschreibung</div>
|
|
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(boolean,java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">CfDnsClient</a><wbr>(boolean emptyResultThrowsException,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> baseUrl,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> authEmail,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> authKey)</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Constructs a new instance of <code>CfDnsClient</code>, which facilitates interactions with the
|
|
Cloudflare DNS API.</div>
|
|
</div>
|
|
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.lang.String)" class="member-name-link">CfDnsClient</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> authEmail,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> authKey)</code></div>
|
|
<div class="col-last odd-row-color">
|
|
<div class="block">Constructs a CfDnsClient instance for interacting with the Cloudflare DNS API.</div>
|
|
</div>
|
|
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">CfDnsClient</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> baseUrl,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> authEmail,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> authKey)</code></div>
|
|
<div class="col-last even-row-color">
|
|
<div class="block">Constructs a CfDnsClient instance for interacting with the Cloudflare DNS API.</div>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</li>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<li>
|
|
<section class="method-summary" id="method-summary">
|
|
<h2>Methodenübersicht</h2>
|
|
<div id="method-summary-table">
|
|
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">Alle Methoden</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instanzmethoden</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Konkrete Methoden</button></div>
|
|
<div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0">
|
|
<div class="summary-table three-column-summary">
|
|
<div class="table-header col-first">Modifizierer und Typ</div>
|
|
<div class="table-header col-second">Methode</div>
|
|
<div class="table-header col-last">Beschreibung</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="model/RecordEntity.html" title="Klasse in codes.thischwa.cf.model">RecordEntity</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#recordCreate(codes.thischwa.cf.model.ZoneEntity,codes.thischwa.cf.model.RecordEntity)" class="member-name-link">recordCreate</a><wbr>(<a href="model/ZoneEntity.html" title="Klasse in codes.thischwa.cf.model">ZoneEntity</a> zone,
|
|
<a href="model/RecordEntity.html" title="Klasse in codes.thischwa.cf.model">RecordEntity</a> rec)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Creates a new DNS record in the specified zone using the Cloudflare API.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="model/RecordEntity.html" title="Klasse in codes.thischwa.cf.model">RecordEntity</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#recordCreate(codes.thischwa.cf.model.ZoneEntity,java.lang.String,int,codes.thischwa.cf.model.RecordType,java.lang.String)" class="member-name-link">recordCreate</a><wbr>(<a href="model/ZoneEntity.html" title="Klasse in codes.thischwa.cf.model">ZoneEntity</a> zone,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> sld,
|
|
int ttl,
|
|
<a href="model/RecordType.html" title="Enum-Klasse in codes.thischwa.cf.model">RecordType</a> type,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> content)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Creates a DNS record in the specified DNS zone with the provided details.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#recordDelete(codes.thischwa.cf.model.ZoneEntity,codes.thischwa.cf.model.RecordEntity)" class="member-name-link">recordDelete</a><wbr>(<a href="model/ZoneEntity.html" title="Klasse in codes.thischwa.cf.model">ZoneEntity</a> zone,
|
|
<a href="model/RecordEntity.html" title="Klasse in codes.thischwa.cf.model">RecordEntity</a> rec)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Deletes a DNS record of the specified type within a given zone on the Cloudflare API.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#recordDelete(codes.thischwa.cf.model.ZoneEntity,java.lang.String)" class="member-name-link">recordDelete</a><wbr>(<a href="model/ZoneEntity.html" title="Klasse in codes.thischwa.cf.model">ZoneEntity</a> zone,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> id)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Deletes a DNS record of the specified type within a given zone on the Cloudflare API.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#recordDeleteTypeIfExists(codes.thischwa.cf.model.ZoneEntity,java.lang.String,codes.thischwa.cf.model.RecordType...)" class="member-name-link">recordDeleteTypeIfExists</a><wbr>(<a href="model/ZoneEntity.html" title="Klasse in codes.thischwa.cf.model">ZoneEntity</a> zone,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> sld,
|
|
<a href="model/RecordType.html" title="Enum-Klasse in codes.thischwa.cf.model">RecordType</a>... recordTypes)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Deletes DNS records of a specific type within a given zone if they exist.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="model/RecordEntity.html" title="Klasse in codes.thischwa.cf.model">RecordEntity</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#recordUpdate(codes.thischwa.cf.model.ZoneEntity,codes.thischwa.cf.model.RecordEntity)" class="member-name-link">recordUpdate</a><wbr>(<a href="model/ZoneEntity.html" title="Klasse in codes.thischwa.cf.model">ZoneEntity</a> zone,
|
|
<a href="model/RecordEntity.html" title="Klasse in codes.thischwa.cf.model">RecordEntity</a> rec)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Updates an existing DNS record in a specified Cloudflare zone.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="model/RecordEntity.html" title="Klasse in codes.thischwa.cf.model">RecordEntity</a></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sldInfo(codes.thischwa.cf.model.ZoneEntity,java.lang.String,codes.thischwa.cf.model.RecordType)" class="member-name-link">sldInfo</a><wbr>(<a href="model/ZoneEntity.html" title="Klasse in codes.thischwa.cf.model">ZoneEntity</a> zone,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> sld,
|
|
<a href="model/RecordType.html" title="Enum-Klasse in codes.thischwa.cf.model">RecordType</a> type)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Retrieves detailed information about a specific second-level domain (SLD) record for a given
|
|
zone and record type from the Cloudflare API.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="Klasse oder Schnittstelle in java.util" class="external-link">List</a><wbr><<a href="model/RecordEntity.html" title="Klasse in codes.thischwa.cf.model">RecordEntity</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sldListAll(codes.thischwa.cf.model.ZoneEntity,java.lang.String)" class="member-name-link">sldListAll</a><wbr>(<a href="model/ZoneEntity.html" title="Klasse in codes.thischwa.cf.model">ZoneEntity</a> zone,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> sld)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="Klasse oder Schnittstelle in java.util" class="external-link">List</a><wbr><<a href="model/RecordEntity.html" title="Klasse in codes.thischwa.cf.model">RecordEntity</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#sldListAll(codes.thischwa.cf.model.ZoneEntity,java.lang.String,codes.thischwa.cf.model.PagingRequest)" class="member-name-link">sldListAll</a><wbr>(<a href="model/ZoneEntity.html" title="Klasse in codes.thischwa.cf.model">ZoneEntity</a> zone,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> sld,
|
|
<a href="model/PagingRequest.html" title="Klasse in codes.thischwa.cf.model">PagingRequest</a> pagingRequest)</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="model/ZoneEntity.html" title="Klasse in codes.thischwa.cf.model">ZoneEntity</a></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#zoneInfo(java.lang.String)" class="member-name-link">zoneInfo</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> name)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Retrieves detailed information about a specific zone by its name.</div>
|
|
</div>
|
|
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="Klasse oder Schnittstelle in java.util" class="external-link">List</a><wbr><<a href="model/ZoneEntity.html" title="Klasse in codes.thischwa.cf.model">ZoneEntity</a>></code></div>
|
|
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#zoneListAll()" class="member-name-link">zoneListAll</a>()</code></div>
|
|
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Retrieves a list of all zones from the Cloudflare API.</div>
|
|
</div>
|
|
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="Klasse oder Schnittstelle in java.util" class="external-link">List</a><wbr><<a href="model/ZoneEntity.html" title="Klasse in codes.thischwa.cf.model">ZoneEntity</a>></code></div>
|
|
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#zoneListAll(codes.thischwa.cf.model.PagingRequest)" class="member-name-link">zoneListAll</a><wbr>(<a href="model/PagingRequest.html" title="Klasse in codes.thischwa.cf.model">PagingRequest</a> pagingRequest)</code></div>
|
|
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
|
|
<div class="block">Retrieves a list of all DNS zones using the provided paging request parameters.</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="inherited-list">
|
|
<h3 id="methods-inherited-from-class-java.lang.Object">Von Klasse geerbte Methoden java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">Object</a></h3>
|
|
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="Klasse oder Schnittstelle in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="Klasse oder Schnittstelle in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="Klasse oder Schnittstelle in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="Klasse oder Schnittstelle in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="Klasse oder Schnittstelle in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="Klasse oder Schnittstelle in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="Klasse oder Schnittstelle in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="Klasse oder Schnittstelle in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="Klasse oder Schnittstelle in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="Klasse oder Schnittstelle in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="Klasse oder Schnittstelle in java.lang" class="external-link">wait</a></code></div>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="details">
|
|
<ul class="details-list">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<li>
|
|
<section class="constructor-details" id="constructor-detail">
|
|
<h2>Konstruktordetails</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="<init>(java.lang.String,java.lang.String)">
|
|
<h3>CfDnsClient</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">CfDnsClient</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> authEmail,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> authKey)</span></div>
|
|
<div class="block">Constructs a CfDnsClient instance for interacting with the Cloudflare DNS API.</div>
|
|
<dl class="notes">
|
|
<dt>Parameter:</dt>
|
|
<dd><code>authEmail</code> - The email address associated with the Cloudflare account, used for
|
|
authentication.</dd>
|
|
<dd><code>authKey</code> - The API key of the Cloudflare account, used as part of the authentication
|
|
process.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="<init>(java.lang.String,java.lang.String,java.lang.String)">
|
|
<h3>CfDnsClient</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">CfDnsClient</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> baseUrl,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> authEmail,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> authKey)</span></div>
|
|
<div class="block">Constructs a CfDnsClient instance for interacting with the Cloudflare DNS API.</div>
|
|
<dl class="notes">
|
|
<dt>Parameter:</dt>
|
|
<dd><code>baseUrl</code> - The base URL of the Cloudflare API to be used for requests.</dd>
|
|
<dd><code>authEmail</code> - The email address associated with the Cloudflare account, used for
|
|
authentication.</dd>
|
|
<dd><code>authKey</code> - The API key of the Cloudflare account, used as part of the authentication
|
|
process.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="<init>(boolean,java.lang.String,java.lang.String,java.lang.String)">
|
|
<h3>CfDnsClient</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="element-name">CfDnsClient</span><wbr><span class="parameters">(boolean emptyResultThrowsException,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> baseUrl,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> authEmail,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> authKey)</span></div>
|
|
<div class="block">Constructs a new instance of <code>CfDnsClient</code>, which facilitates interactions with the
|
|
Cloudflare DNS API.</div>
|
|
<dl class="notes">
|
|
<dt>Parameter:</dt>
|
|
<dd><code>emptyResultThrowsException</code> - Specifies if an exception should be thrown when the API
|
|
response is empty. Default is true.</dd>
|
|
<dd><code>baseUrl</code> - The base URL for the Cloudflare API endpoint.</dd>
|
|
<dd><code>authEmail</code> - The email associated with the Cloudflare account for authentication.</dd>
|
|
<dd><code>authKey</code> - The API key for authenticating the client with Cloudflare services.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<li>
|
|
<section class="method-details" id="method-detail">
|
|
<h2>Methodendetails</h2>
|
|
<ul class="member-list">
|
|
<li>
|
|
<section class="detail" id="zoneListAll()">
|
|
<h3>zoneListAll</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="Klasse oder Schnittstelle in java.util" class="external-link">List</a><<a href="model/ZoneEntity.html" title="Klasse in codes.thischwa.cf.model">ZoneEntity</a>></span> <span class="element-name">zoneListAll</span>()
|
|
throws <span class="exceptions"><a href="CloudflareApiException.html" title="Klasse in codes.thischwa.cf">CloudflareApiException</a></span></div>
|
|
<div class="block">Retrieves a list of all zones from the Cloudflare API.</div>
|
|
<dl class="notes">
|
|
<dt>Gibt zurück:</dt>
|
|
<dd>A list of ZoneEntity objects representing the zones retrieved from the Cloudflare API.</dd>
|
|
<dt>Löst aus:</dt>
|
|
<dd><code><a href="CloudflareApiException.html" title="Klasse in codes.thischwa.cf">CloudflareApiException</a></code> - If an error occurs during the API request or response handling.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="zoneListAll(codes.thischwa.cf.model.PagingRequest)">
|
|
<h3>zoneListAll</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="Klasse oder Schnittstelle in java.util" class="external-link">List</a><<a href="model/ZoneEntity.html" title="Klasse in codes.thischwa.cf.model">ZoneEntity</a>></span> <span class="element-name">zoneListAll</span><wbr><span class="parameters">(<a href="model/PagingRequest.html" title="Klasse in codes.thischwa.cf.model">PagingRequest</a> pagingRequest)</span>
|
|
throws <span class="exceptions"><a href="CloudflareApiException.html" title="Klasse in codes.thischwa.cf">CloudflareApiException</a></span></div>
|
|
<div class="block">Retrieves a list of all DNS zones using the provided paging request parameters.</div>
|
|
<dl class="notes">
|
|
<dt>Parameter:</dt>
|
|
<dd><code>pagingRequest</code> - the pagination request object containing parameters for paging and
|
|
filtering zone data</dd>
|
|
<dt>Gibt zurück:</dt>
|
|
<dd>a list of <code>ZoneEntity</code> objects representing the DNS zones retrieved from the API</dd>
|
|
<dt>Löst aus:</dt>
|
|
<dd><code><a href="CloudflareApiException.html" title="Klasse in codes.thischwa.cf">CloudflareApiException</a></code> - if there is an error during the API request or response
|
|
processing</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="zoneInfo(java.lang.String)">
|
|
<h3>zoneInfo</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="model/ZoneEntity.html" title="Klasse in codes.thischwa.cf.model">ZoneEntity</a></span> <span class="element-name">zoneInfo</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> name)</span>
|
|
throws <span class="exceptions"><a href="CloudflareApiException.html" title="Klasse in codes.thischwa.cf">CloudflareApiException</a></span></div>
|
|
<div class="block">Retrieves detailed information about a specific zone by its name.</div>
|
|
<dl class="notes">
|
|
<dt>Parameter:</dt>
|
|
<dd><code>name</code> - The name of the zone to retrieve information for.</dd>
|
|
<dt>Gibt zurück:</dt>
|
|
<dd>A <a href="model/ZoneEntity.html" title="Klasse in codes.thischwa.cf.model"><code>ZoneEntity</code></a> object that contains details of the specified zone.</dd>
|
|
<dt>Löst aus:</dt>
|
|
<dd><code><a href="CloudflareApiException.html" title="Klasse in codes.thischwa.cf">CloudflareApiException</a></code> - If an error occurs while making the API request or processing
|
|
the response.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="sldListAll(codes.thischwa.cf.model.ZoneEntity,java.lang.String)">
|
|
<h3>sldListAll</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="Klasse oder Schnittstelle in java.util" class="external-link">List</a><<a href="model/RecordEntity.html" title="Klasse in codes.thischwa.cf.model">RecordEntity</a>></span> <span class="element-name">sldListAll</span><wbr><span class="parameters">(<a href="model/ZoneEntity.html" title="Klasse in codes.thischwa.cf.model">ZoneEntity</a> zone,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> sld)</span>
|
|
throws <span class="exceptions"><a href="CloudflareApiException.html" title="Klasse in codes.thischwa.cf">CloudflareApiException</a></span></div>
|
|
<div class="block">Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.</div>
|
|
<dl class="notes">
|
|
<dt>Parameter:</dt>
|
|
<dd><code>zone</code> - The DNS zone entity for which the SLD records are to be fetched.</dd>
|
|
<dd><code>sld</code> - The second-level domain name for which the records are retrieved.</dd>
|
|
<dt>Gibt zurück:</dt>
|
|
<dd>A list of <code>RecordEntity</code> objects representing the DNS records associated with the
|
|
provided SLD.</dd>
|
|
<dt>Löst aus:</dt>
|
|
<dd><code><a href="CloudflareApiException.html" title="Klasse in codes.thischwa.cf">CloudflareApiException</a></code> - If an error occurs while interacting with the Cloudflare API.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="sldListAll(codes.thischwa.cf.model.ZoneEntity,java.lang.String,codes.thischwa.cf.model.PagingRequest)">
|
|
<h3>sldListAll</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="Klasse oder Schnittstelle in java.util" class="external-link">List</a><<a href="model/RecordEntity.html" title="Klasse in codes.thischwa.cf.model">RecordEntity</a>></span> <span class="element-name">sldListAll</span><wbr><span class="parameters">(<a href="model/ZoneEntity.html" title="Klasse in codes.thischwa.cf.model">ZoneEntity</a> zone,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> sld,
|
|
<a href="model/PagingRequest.html" title="Klasse in codes.thischwa.cf.model">PagingRequest</a> pagingRequest)</span>
|
|
throws <span class="exceptions"><a href="CloudflareApiException.html" title="Klasse in codes.thischwa.cf">CloudflareApiException</a></span></div>
|
|
<div class="block">Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.</div>
|
|
<dl class="notes">
|
|
<dt>Parameter:</dt>
|
|
<dd><code>zone</code> - The DNS zone entity for which the SLD records are to be fetched.</dd>
|
|
<dd><code>sld</code> - The second-level domain name for which the records are retrieved.</dd>
|
|
<dd><code>pagingRequest</code> - The paging request.</dd>
|
|
<dt>Gibt zurück:</dt>
|
|
<dd>A list of <code>RecordEntity</code> objects representing the DNS records associated with the
|
|
provided SLD.</dd>
|
|
<dt>Löst aus:</dt>
|
|
<dd><code><a href="CloudflareApiException.html" title="Klasse in codes.thischwa.cf">CloudflareApiException</a></code> - If an error occurs while interacting with the Cloudflare API.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="sldInfo(codes.thischwa.cf.model.ZoneEntity,java.lang.String,codes.thischwa.cf.model.RecordType)">
|
|
<h3>sldInfo</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="model/RecordEntity.html" title="Klasse in codes.thischwa.cf.model">RecordEntity</a></span> <span class="element-name">sldInfo</span><wbr><span class="parameters">(<a href="model/ZoneEntity.html" title="Klasse in codes.thischwa.cf.model">ZoneEntity</a> zone,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> sld,
|
|
<a href="model/RecordType.html" title="Enum-Klasse in codes.thischwa.cf.model">RecordType</a> type)</span>
|
|
throws <span class="exceptions"><a href="CloudflareApiException.html" title="Klasse in codes.thischwa.cf">CloudflareApiException</a></span></div>
|
|
<div class="block">Retrieves detailed information about a specific second-level domain (SLD) record for a given
|
|
zone and record type from the Cloudflare API.</div>
|
|
<dl class="notes">
|
|
<dt>Parameter:</dt>
|
|
<dd><code>zone</code> - the zone entity that contains information about the DNS zone</dd>
|
|
<dd><code>sld</code> - the second-level domain (SLD) for which the record information is requested</dd>
|
|
<dd><code>type</code> - the type of DNS record (e.g., A, AAAA, CNAME) being queried</dd>
|
|
<dt>Gibt zurück:</dt>
|
|
<dd>the record entity containing detailed information about the requested SLD and record
|
|
type</dd>
|
|
<dt>Löst aus:</dt>
|
|
<dd><code><a href="CloudflareApiException.html" title="Klasse in codes.thischwa.cf">CloudflareApiException</a></code> - if an error occurs during interaction with the Cloudflare API</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="recordCreate(codes.thischwa.cf.model.ZoneEntity,java.lang.String,int,codes.thischwa.cf.model.RecordType,java.lang.String)">
|
|
<h3>recordCreate</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="model/RecordEntity.html" title="Klasse in codes.thischwa.cf.model">RecordEntity</a></span> <span class="element-name">recordCreate</span><wbr><span class="parameters">(<a href="model/ZoneEntity.html" title="Klasse in codes.thischwa.cf.model">ZoneEntity</a> zone,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> sld,
|
|
int ttl,
|
|
<a href="model/RecordType.html" title="Enum-Klasse in codes.thischwa.cf.model">RecordType</a> type,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> content)</span>
|
|
throws <span class="exceptions"><a href="CloudflareApiException.html" title="Klasse in codes.thischwa.cf">CloudflareApiException</a></span></div>
|
|
<div class="block">Creates a DNS record in the specified DNS zone with the provided details.</div>
|
|
<dl class="notes">
|
|
<dt>Parameter:</dt>
|
|
<dd><code>zone</code> - the DNS zone in which the record will be created</dd>
|
|
<dd><code>sld</code> - the second-level domain (SLD) used for constructing the fully qualified domain name (FQDN)</dd>
|
|
<dd><code>ttl</code> - the time-to-live (TTL) value for the DNS record</dd>
|
|
<dd><code>type</code> - the type of the DNS record (e.g., A, AAAA, CNAME)</dd>
|
|
<dd><code>content</code> - the content or value of the DNS record</dd>
|
|
<dt>Gibt zurück:</dt>
|
|
<dd>the created DNS record as a <a href="model/RecordEntity.html" title="Klasse in codes.thischwa.cf.model"><code>RecordEntity</code></a> object</dd>
|
|
<dt>Löst aus:</dt>
|
|
<dd><code><a href="CloudflareApiException.html" title="Klasse in codes.thischwa.cf">CloudflareApiException</a></code> - if an error occurs while interacting with the Cloudflare API</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="recordCreate(codes.thischwa.cf.model.ZoneEntity,codes.thischwa.cf.model.RecordEntity)">
|
|
<h3>recordCreate</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="model/RecordEntity.html" title="Klasse in codes.thischwa.cf.model">RecordEntity</a></span> <span class="element-name">recordCreate</span><wbr><span class="parameters">(<a href="model/ZoneEntity.html" title="Klasse in codes.thischwa.cf.model">ZoneEntity</a> zone,
|
|
<a href="model/RecordEntity.html" title="Klasse in codes.thischwa.cf.model">RecordEntity</a> rec)</span>
|
|
throws <span class="exceptions"><a href="CloudflareApiException.html" title="Klasse in codes.thischwa.cf">CloudflareApiException</a></span></div>
|
|
<div class="block">Creates a new DNS record in the specified zone using the Cloudflare API.</div>
|
|
<dl class="notes">
|
|
<dt>Parameter:</dt>
|
|
<dd><code>zone</code> - The zone entity where the record will be created. Contains details such as zone ID.</dd>
|
|
<dd><code>rec</code> - The record entity representing the DNS record to be created, including its
|
|
attributes.</dd>
|
|
<dt>Gibt zurück:</dt>
|
|
<dd>The created record entity as returned by the Cloudflare API.</dd>
|
|
<dt>Löst aus:</dt>
|
|
<dd><code><a href="CloudflareApiException.html" title="Klasse in codes.thischwa.cf">CloudflareApiException</a></code> - If an error occurs while interacting with the Cloudflare API.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="recordDelete(codes.thischwa.cf.model.ZoneEntity,codes.thischwa.cf.model.RecordEntity)">
|
|
<h3>recordDelete</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">recordDelete</span><wbr><span class="parameters">(<a href="model/ZoneEntity.html" title="Klasse in codes.thischwa.cf.model">ZoneEntity</a> zone,
|
|
<a href="model/RecordEntity.html" title="Klasse in codes.thischwa.cf.model">RecordEntity</a> rec)</span>
|
|
throws <span class="exceptions"><a href="CloudflareApiException.html" title="Klasse in codes.thischwa.cf">CloudflareApiException</a></span></div>
|
|
<div class="block">Deletes a DNS record of the specified type within a given zone on the Cloudflare API.</div>
|
|
<dl class="notes">
|
|
<dt>Parameter:</dt>
|
|
<dd><code>zone</code> - The zone entity that specifies the zone in which the record exists.</dd>
|
|
<dd><code>rec</code> - The record entity that represents the DNS record to be deleted.</dd>
|
|
<dt>Gibt zurück:</dt>
|
|
<dd><code>true</code> if the DNS record was successfully deleted; <code>false</code> otherwise.</dd>
|
|
<dt>Löst aus:</dt>
|
|
<dd><code><a href="CloudflareApiException.html" title="Klasse in codes.thischwa.cf">CloudflareApiException</a></code> - if there is an issue during the API communication or the request
|
|
fails for any reason.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="recordDelete(codes.thischwa.cf.model.ZoneEntity,java.lang.String)">
|
|
<h3>recordDelete</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">recordDelete</span><wbr><span class="parameters">(<a href="model/ZoneEntity.html" title="Klasse in codes.thischwa.cf.model">ZoneEntity</a> zone,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> id)</span>
|
|
throws <span class="exceptions"><a href="CloudflareApiException.html" title="Klasse in codes.thischwa.cf">CloudflareApiException</a></span></div>
|
|
<div class="block">Deletes a DNS record of the specified type within a given zone on the Cloudflare API.</div>
|
|
<dl class="notes">
|
|
<dt>Parameter:</dt>
|
|
<dd><code>zone</code> - The zone entity that specifies the zone in which the record exists.</dd>
|
|
<dd><code>id</code> - The record entity that represents the DNS record to be deleted.</dd>
|
|
<dt>Gibt zurück:</dt>
|
|
<dd><code>true</code> if the DNS record was successfully deleted; <code>false</code> otherwise.</dd>
|
|
<dt>Löst aus:</dt>
|
|
<dd><code><a href="CloudflareApiException.html" title="Klasse in codes.thischwa.cf">CloudflareApiException</a></code> - if there is an issue during the API communication or the request
|
|
fails for any reason.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="recordUpdate(codes.thischwa.cf.model.ZoneEntity,codes.thischwa.cf.model.RecordEntity)">
|
|
<h3>recordUpdate</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="model/RecordEntity.html" title="Klasse in codes.thischwa.cf.model">RecordEntity</a></span> <span class="element-name">recordUpdate</span><wbr><span class="parameters">(<a href="model/ZoneEntity.html" title="Klasse in codes.thischwa.cf.model">ZoneEntity</a> zone,
|
|
<a href="model/RecordEntity.html" title="Klasse in codes.thischwa.cf.model">RecordEntity</a> rec)</span>
|
|
throws <span class="exceptions"><a href="CloudflareApiException.html" title="Klasse in codes.thischwa.cf">CloudflareApiException</a></span></div>
|
|
<div class="block">Updates an existing DNS record in a specified Cloudflare zone.</div>
|
|
<dl class="notes">
|
|
<dt>Parameter:</dt>
|
|
<dd><code>zone</code> - the zone entity containing the ID of the target zone</dd>
|
|
<dd><code>rec</code> - the record entity containing the ID of the DNS record to be updated and its updated
|
|
data</dd>
|
|
<dt>Gibt zurück:</dt>
|
|
<dd>the updated record entity as returned by the Cloudflare API</dd>
|
|
<dt>Löst aus:</dt>
|
|
<dd><code><a href="CloudflareApiException.html" title="Klasse in codes.thischwa.cf">CloudflareApiException</a></code> - if an error occurs while interacting with the Cloudflare API</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
<li>
|
|
<section class="detail" id="recordDeleteTypeIfExists(codes.thischwa.cf.model.ZoneEntity,java.lang.String,codes.thischwa.cf.model.RecordType...)">
|
|
<h3>recordDeleteTypeIfExists</h3>
|
|
<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">recordDeleteTypeIfExists</span><wbr><span class="parameters">(<a href="model/ZoneEntity.html" title="Klasse in codes.thischwa.cf.model">ZoneEntity</a> zone,
|
|
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="Klasse oder Schnittstelle in java.lang" class="external-link">String</a> sld,
|
|
<a href="model/RecordType.html" title="Enum-Klasse in codes.thischwa.cf.model">RecordType</a>... recordTypes)</span>
|
|
throws <span class="exceptions"><a href="CloudflareApiException.html" title="Klasse in codes.thischwa.cf">CloudflareApiException</a></span></div>
|
|
<div class="block">Deletes DNS records of a specific type within a given zone if they exist.
|
|
If no record of the specified type exists, it logs this occurrence without throwing an exception.</div>
|
|
<dl class="notes">
|
|
<dt>Parameter:</dt>
|
|
<dd><code>zone</code> - The DNS zone entity in which the record exists.</dd>
|
|
<dd><code>sld</code> - The second-level domain for which the record is being checked.</dd>
|
|
<dd><code>recordTypes</code> - The types of DNS records that should be deleted, if they exist.</dd>
|
|
<dt>Löst aus:</dt>
|
|
<dd><code><a href="CloudflareApiException.html" title="Klasse in codes.thischwa.cf">CloudflareApiException</a></code> - If an error occurs during API communication.</dd>
|
|
</dl>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
</main>
|
|
<footer role="contentinfo">
|
|
<hr>
|
|
<p class="legal-copy"><small>Copyright © 2025. All rights reserved.</small></p>
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|