thischwa/CloudflareDNS-java
1
0
Fork 0
Code Issues Pull Requests Actions Packages Releases 1 Activity
Files
042678a6d78bb579bb311dc1fc8903f9150ab04a
CloudflareDNS-java/docs/apidocs/codes/thischwa/cf/class-use/CloudflareApiException.html
T
thischwa 042678a6d7 Add usage examples for CfDnsClient in API documentation 
Expanded the API documentation by including practical examples for the `CfDnsClient` class. Updated Javadoc metadata and modified the index.html title for better context.
2025-03-23 13:11:27 +01:00

167 lines
14 KiB
HTML
Raw Blame History

<!DOCTYPE HTML>
<html lang="de">
<head>
<!-- Generated by javadoc (21) on Sun Mar 23 12:39:27 CET 2025 -->
<title>Verwendungsweise von Klasse codes.thischwa.cf.CloudflareApiException (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-03-23">
<meta name="description" content="use: package: codes.thischwa.cf, class: CloudflareApiException">
<meta name="generator" content="javadoc/ClassUseWriter">
<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-use-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">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</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><a href="../CloudflareApiException.html" title="Klasse in codes.thischwa.cf">Klasse</a></li>
<li class="nav-bar-cell1-rev">Verwendung</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#use">Hilfe</a></li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list"></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">
<div class="header">
<h1 title="Verwendungen von Klasse codes.thischwa.cf.CloudflareApiException" class="title">Verwendungen von Klasse<br>codes.thischwa.cf.CloudflareApiException</h1>
</div>
<div class="caption"><span>Packages, die <a href="../CloudflareApiException.html" title="Klasse in codes.thischwa.cf">CloudflareApiException</a> verwenden</span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Beschreibung</div>
<div class="col-first even-row-color"><a href="#codes.thischwa.cf">codes.thischwa.cf</a></div>
<div class="col-last even-row-color">
<div class="block">The base package of CloudflareDNS-java.</div>
</div>
</div>
<section class="class-uses">
<ul class="block-list">
<li>
<section class="detail" id="codes.thischwa.cf">
<h2>Verwendungen von <a href="../CloudflareApiException.html" title="Klasse in codes.thischwa.cf">CloudflareApiException</a> in <a href="../package-summary.html">codes.thischwa.cf</a></h2>
<div class="caption"><span>Unterklassen von <a href="../CloudflareApiException.html" title="Klasse in codes.thischwa.cf">CloudflareApiException</a> in <a href="../package-summary.html">codes.thischwa.cf</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifizierer und Typ</div>
<div class="table-header col-second">Klasse</div>
<div class="table-header col-last">Beschreibung</div>
<div class="col-first even-row-color"><code>class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../CloudflareNotFoundException.html" class="type-name-link" title="Klasse in codes.thischwa.cf">CloudflareNotFoundException</a></code></div>
<div class="col-last even-row-color">
<div class="block">This exception is thrown to indicate that a requested resource was not found during interaction
with the Cloudflare API.</div>
</div>
</div>
<div class="caption"><span>Methoden in <a href="../package-summary.html">codes.thischwa.cf</a>, die <a href="../CloudflareApiException.html" title="Klasse in codes.thischwa.cf">CloudflareApiException</a> auslösen</span></div>
<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"><code><a href="../model/RecordEntity.html" title="Klasse in codes.thischwa.cf.model">RecordEntity</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">CfDnsClient.</span><code><a href="../CfDnsClient.html#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>&nbsp;zone,
<a href="../model/RecordEntity.html" title="Klasse in codes.thischwa.cf.model">RecordEntity</a>&nbsp;rec)</code></div>
<div class="col-last even-row-color">
<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"><code>boolean</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">CfDnsClient.</span><code><a href="../CfDnsClient.html#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>&nbsp;zone,
<a href="../model/RecordEntity.html" title="Klasse in codes.thischwa.cf.model">RecordEntity</a>&nbsp;rec)</code></div>
<div class="col-last odd-row-color">
<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"><code>boolean</code></div>
<div class="col-second even-row-color"><span class="type-name-label">CfDnsClient.</span><code><a href="../CfDnsClient.html#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>&nbsp;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>&nbsp;id)</code></div>
<div class="col-last even-row-color">
<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"><code>void</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">CfDnsClient.</span><code><a href="../CfDnsClient.html#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>&nbsp;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>&nbsp;sld,
<a href="../model/RecordType.html" title="Enum-Klasse in codes.thischwa.cf.model">RecordType</a>&nbsp;type)</code></div>
<div class="col-last odd-row-color">
<div class="block">Attempts to delete a DNS record of a specific type for a given zone and second-level domain
(SLD), if it exists.</div>
</div>
<div class="col-first even-row-color"><code><a href="../model/RecordEntity.html" title="Klasse in codes.thischwa.cf.model">RecordEntity</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">CfDnsClient.</span><code><a href="../CfDnsClient.html#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>&nbsp;zone,
<a href="../model/RecordEntity.html" title="Klasse in codes.thischwa.cf.model">RecordEntity</a>&nbsp;rec)</code></div>
<div class="col-last even-row-color">
<div class="block">Updates an existing DNS record in a specified Cloudflare zone.</div>
</div>
<div class="col-first odd-row-color"><code><a href="../model/RecordEntity.html" title="Klasse in codes.thischwa.cf.model">RecordEntity</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">CfDnsClient.</span><code><a href="../CfDnsClient.html#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>&nbsp;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>&nbsp;sld,
<a href="../model/RecordType.html" title="Enum-Klasse in codes.thischwa.cf.model">RecordType</a>&nbsp;type)</code></div>
<div class="col-last odd-row-color">
<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 even-row-color"><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>&lt;<a href="../model/RecordEntity.html" title="Klasse in codes.thischwa.cf.model">RecordEntity</a>&gt;</code></div>
<div class="col-second even-row-color"><span class="type-name-label">CfDnsClient.</span><code><a href="../CfDnsClient.html#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>&nbsp;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>&nbsp;sld)</code></div>
<div class="col-last even-row-color">
<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"><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>&lt;<a href="../model/RecordEntity.html" title="Klasse in codes.thischwa.cf.model">RecordEntity</a>&gt;</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">CfDnsClient.</span><code><a href="../CfDnsClient.html#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>&nbsp;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>&nbsp;sld,
<a href="../model/PagingRequest.html" title="Klasse in codes.thischwa.cf.model">PagingRequest</a>&nbsp;pagingRequest)</code></div>
<div class="col-last odd-row-color">
<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"><code><a href="../model/ZoneEntity.html" title="Klasse in codes.thischwa.cf.model">ZoneEntity</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">CfDnsClient.</span><code><a href="../CfDnsClient.html#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>&nbsp;name)</code></div>
<div class="col-last even-row-color">
<div class="block">Retrieves detailed information about a specific zone by its name.</div>
</div>
<div class="col-first odd-row-color"><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>&lt;<a href="../model/ZoneEntity.html" title="Klasse in codes.thischwa.cf.model">ZoneEntity</a>&gt;</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">CfDnsClient.</span><code><a href="../CfDnsClient.html#zoneListAll()" class="member-name-link">zoneListAll</a>()</code></div>
<div class="col-last odd-row-color">
<div class="block">Retrieves a list of all zones from the Cloudflare API.</div>
</div>
<div class="col-first even-row-color"><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>&lt;<a href="../model/ZoneEntity.html" title="Klasse in codes.thischwa.cf.model">ZoneEntity</a>&gt;</code></div>
<div class="col-second even-row-color"><span class="type-name-label">CfDnsClient.</span><code><a href="../CfDnsClient.html#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>&nbsp;pagingRequest)</code></div>
<div class="col-last even-row-color">
<div class="block">Retrieves a list of all zones from the Cloudflare API.</div>
</div>
</div>
</section>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2025. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink