thischwa/CloudflareDNS-java
1
0
Fork 0
Code Issues Pull Requests Actions Packages Releases 1 Activity
Files
e415dc1106a00b204045f9105cdc2f8aca37001a
CloudflareDNS-java/docs/apidocs/index-all.html
T
thischwa e415dc1106 Refactor HTTP request methods and update Javadoc language. 
Refactored HTTP request methods by removing explicit `responseType` parameters where possible and adjusting to specific response mapping needs. Additionally, updated Javadoc documentation language from German to English for consistency, improving clarity and accessibility.
2025-03-23 18:39:36 +01:00

472 lines
38 KiB
HTML
Raw Blame History

<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) on Sun Mar 23 18:37:33 CET 2025 -->
<title>Index (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="index">
<meta name="generator" content="javadoc/IndexWriter">
<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">
<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.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="index-page">
<script type="text/javascript">var pathtoroot = "./";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</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">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="index.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li class="nav-bar-cell1-rev">Index</li>
<li><a href="help-doc.html#index">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</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>Index</h1>
</div>
<a href="#I:A">A</a>&nbsp;<a href="#I:B">B</a>&nbsp;<a href="#I:C">C</a>&nbsp;<a href="#I:D">D</a>&nbsp;<a href="#I:G">G</a>&nbsp;<a href="#I:H">H</a>&nbsp;<a href="#I:L">L</a>&nbsp;<a href="#I:M">M</a>&nbsp;<a href="#I:N">N</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:P">P</a>&nbsp;<a href="#I:R">R</a>&nbsp;<a href="#I:S">S</a>&nbsp;<a href="#I:T">T</a>&nbsp;<a href="#I:U">U</a>&nbsp;<a href="#I:V">V</a>&nbsp;<a href="#I:Z">Z</a>&nbsp;<br><a href="allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="serialized-form.html">Serialized&nbsp;Form</a>
<h2 class="title" id="I:A">A</h2>
<dl class="index">
<dt><a href="codes/thischwa/cf/model/RecordType.html#A" class="member-name-link">A</a> - Enum constant in enum class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/RecordType.html" title="enum class in codes.thischwa.cf.model">RecordType</a></dt>
<dd>
<div class="block">Represents the DNS A record type.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/RecordType.html#AAAA" class="member-name-link">AAAA</a> - Enum constant in enum class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/RecordType.html" title="enum class in codes.thischwa.cf.model">RecordType</a></dt>
<dd>
<div class="block">Represents the DNS AAAA record type.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/AbstractEntity.html" class="type-name-link" title="class in codes.thischwa.cf.model">AbstractEntity</a> - Class in <a href="codes/thischwa/cf/model/package-summary.html">codes.thischwa.cf.model</a></dt>
<dd>
<div class="block">Represents a base abstract entity class for modeling domain objects with a unique identifier.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/AbstractEntity.html#%3Cinit%3E()" class="member-name-link">AbstractEntity()</a> - Constructor for class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/AbstractEntity.html" title="class in codes.thischwa.cf.model">AbstractEntity</a></dt>
<dd>&nbsp;</dd>
<dt><a href="codes/thischwa/cf/model/AbstractMultipleResponse.html" class="type-name-link" title="class in codes.thischwa.cf.model">AbstractMultipleResponse</a>&lt;<a href="codes/thischwa/cf/model/AbstractMultipleResponse.html" title="type parameter in AbstractMultipleResponse">T</a> extends <a href="codes/thischwa/cf/model/ResponseEntity.html" title="interface in codes.thischwa.cf.model">ResponseEntity</a>&gt; - Class in <a href="codes/thischwa/cf/model/package-summary.html">codes.thischwa.cf.model</a></dt>
<dd>
<div class="block">Abstract base class for response models that contain multiple result entries.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/AbstractMultipleResponse.html#%3Cinit%3E()" class="member-name-link">AbstractMultipleResponse()</a> - Constructor for class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/AbstractMultipleResponse.html" title="class in codes.thischwa.cf.model">AbstractMultipleResponse</a></dt>
<dd>
<div class="block">Default constructor for the <code>AbstractMultipleResponse</code> class.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/AbstractResponse.html" class="type-name-link" title="class in codes.thischwa.cf.model">AbstractResponse</a> - Class in <a href="codes/thischwa/cf/model/package-summary.html">codes.thischwa.cf.model</a></dt>
<dd>
<div class="block">Abstract base class for API response models.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/AbstractResponse.html#%3Cinit%3E()" class="member-name-link">AbstractResponse()</a> - Constructor for class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/AbstractResponse.html" title="class in codes.thischwa.cf.model">AbstractResponse</a></dt>
<dd>&nbsp;</dd>
<dt><a href="codes/thischwa/cf/model/AbstractSingleResponse.html" class="type-name-link" title="class in codes.thischwa.cf.model">AbstractSingleResponse</a>&lt;<a href="codes/thischwa/cf/model/AbstractSingleResponse.html" title="type parameter in AbstractSingleResponse">T</a> extends <a href="codes/thischwa/cf/model/ResponseEntity.html" title="interface in codes.thischwa.cf.model">ResponseEntity</a>&gt; - Class in <a href="codes/thischwa/cf/model/package-summary.html">codes.thischwa.cf.model</a></dt>
<dd>
<div class="block">Represents a base abstract response model for handling single response entities within an API
response.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/AbstractSingleResponse.html#%3Cinit%3E()" class="member-name-link">AbstractSingleResponse()</a> - Constructor for class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/AbstractSingleResponse.html" title="class in codes.thischwa.cf.model">AbstractSingleResponse</a></dt>
<dd>&nbsp;</dd>
<dt><a href="codes/thischwa/cf/model/PagingRequest.html#addQueryString(java.lang.String)" class="member-name-link">addQueryString(String)</a> - Method in class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/PagingRequest.html" title="class in codes.thischwa.cf.model">PagingRequest</a></dt>
<dd>
<div class="block">Appends a query string with pagination parameters (page and perPage) to the provided endpoint.</div>
</dd>
</dl>
<h2 class="title" id="I:B">B</h2>
<dl class="index">
<dt><a href="codes/thischwa/cf/model/RecordEntity.html#build(java.lang.String,codes.thischwa.cf.model.RecordType,java.lang.Integer,java.lang.String)" class="member-name-link">build(String, RecordType, Integer, String)</a> - Static method in class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/RecordEntity.html" title="class in codes.thischwa.cf.model">RecordEntity</a></dt>
<dd>
<div class="block">Builds and returns a <a href="codes/thischwa/cf/model/RecordEntity.html" title="class in codes.thischwa.cf.model"><code>RecordEntity</code></a> instance with the specified attributes.</div>
</dd>
</dl>
<h2 class="title" id="I:C">C</h2>
<dl class="index">
<dt><a href="codes/thischwa/cf/model/RecordType.html#CAA" class="member-name-link">CAA</a> - Enum constant in enum class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/RecordType.html" title="enum class in codes.thischwa.cf.model">RecordType</a></dt>
<dd>
<div class="block">Represents the DNS CAA (Certificate Authority Authorization) record type.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/RecordType.html#CERT" class="member-name-link">CERT</a> - Enum constant in enum class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/RecordType.html" title="enum class in codes.thischwa.cf.model">RecordType</a></dt>
<dd>
<div class="block">Represents the DNS CERT record type.</div>
</dd>
<dt><a href="codes/thischwa/cf/CfDnsClient.html" class="type-name-link" title="class in codes.thischwa.cf">CfDnsClient</a> - Class in <a href="codes/thischwa/cf/package-summary.html">codes.thischwa.cf</a></dt>
<dd>
<div class="block">CfDnsClient is a client interface to interact with Cloudflare DNS service.</div>
</dd>
<dt><a href="codes/thischwa/cf/CfDnsClient.html#%3Cinit%3E(boolean,java.lang.String,java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">CfDnsClient(boolean, String, String, String, String)</a> - Constructor for class codes.thischwa.cf.<a href="codes/thischwa/cf/CfDnsClient.html" title="class in codes.thischwa.cf">CfDnsClient</a></dt>
<dd>
<div class="block">Constructs a new instance of <code>CfDnsClient</code>, which facilitates interactions with the
Cloudflare DNS API.</div>
</dd>
<dt><a href="codes/thischwa/cf/CfDnsClient.html#%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">CfDnsClient(String, String, String)</a> - Constructor for class codes.thischwa.cf.<a href="codes/thischwa/cf/CfDnsClient.html" title="class in codes.thischwa.cf">CfDnsClient</a></dt>
<dd>
<div class="block">Constructs a CfDnsClient instance for interacting with the Cloudflare DNS API.</div>
</dd>
<dt><a href="codes/thischwa/cf/CfDnsClient.html#%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">CfDnsClient(String, String, String, String)</a> - Constructor for class codes.thischwa.cf.<a href="codes/thischwa/cf/CfDnsClient.html" title="class in codes.thischwa.cf">CfDnsClient</a></dt>
<dd>
<div class="block">Constructs a CfDnsClient instance for interacting with the Cloudflare DNS API.</div>
</dd>
<dt><a href="codes/thischwa/cf/CfRequest.html" class="type-name-link" title="enum class in codes.thischwa.cf">CfRequest</a> - Enum Class in <a href="codes/thischwa/cf/package-summary.html">codes.thischwa.cf</a></dt>
<dd>
<div class="block">Enum CfRequest encapsulates various API endpoint paths for managing DNS zones and records in a
cohesive and reusable manner.</div>
</dd>
<dt><a href="codes/thischwa/cf/CloudflareApiException.html" class="type-name-link" title="class in codes.thischwa.cf">CloudflareApiException</a> - Exception in <a href="codes/thischwa/cf/package-summary.html">codes.thischwa.cf</a></dt>
<dd>
<div class="block">Represents a custom exception for errors encountered while interacting with the Cloudflare API.</div>
</dd>
<dt><a href="codes/thischwa/cf/CloudflareApiException.html#%3Cinit%3E(java.lang.String)" class="member-name-link">CloudflareApiException(String)</a> - Constructor for exception codes.thischwa.cf.<a href="codes/thischwa/cf/CloudflareApiException.html" title="class in codes.thischwa.cf">CloudflareApiException</a></dt>
<dd>
<div class="block">Constructs a new CloudflareApiException with the specified detail message.</div>
</dd>
<dt><a href="codes/thischwa/cf/CloudflareApiException.html#%3Cinit%3E(java.lang.String,java.lang.Throwable)" class="member-name-link">CloudflareApiException(String, Throwable)</a> - Constructor for exception codes.thischwa.cf.<a href="codes/thischwa/cf/CloudflareApiException.html" title="class in codes.thischwa.cf">CloudflareApiException</a></dt>
<dd>
<div class="block">Constructs a new CloudflareApiException with the specified detail message and cause.</div>
</dd>
<dt><a href="codes/thischwa/cf/CloudflareApiException.html#%3Cinit%3E(java.lang.Throwable)" class="member-name-link">CloudflareApiException(Throwable)</a> - Constructor for exception codes.thischwa.cf.<a href="codes/thischwa/cf/CloudflareApiException.html" title="class in codes.thischwa.cf">CloudflareApiException</a></dt>
<dd>
<div class="block">Constructs a new CloudflareApiException with the specified cause.</div>
</dd>
<dt><a href="codes/thischwa/cf/CloudflareNotFoundException.html" class="type-name-link" title="class in codes.thischwa.cf">CloudflareNotFoundException</a> - Exception in <a href="codes/thischwa/cf/package-summary.html">codes.thischwa.cf</a></dt>
<dd>
<div class="block">This exception is thrown to indicate that a requested resource was not found during interaction
with the Cloudflare API.</div>
</dd>
<dt><a href="codes/thischwa/cf/CloudflareNotFoundException.html#%3Cinit%3E(java.lang.String)" class="member-name-link">CloudflareNotFoundException(String)</a> - Constructor for exception codes.thischwa.cf.<a href="codes/thischwa/cf/CloudflareNotFoundException.html" title="class in codes.thischwa.cf">CloudflareNotFoundException</a></dt>
<dd>
<div class="block">Constructs a new CloudflareNotFoundException with the specified detail message.</div>
</dd>
<dt><a href="codes/thischwa/cf/CloudflareNotFoundException.html#%3Cinit%3E(java.lang.String,java.lang.Throwable)" class="member-name-link">CloudflareNotFoundException(String, Throwable)</a> - Constructor for exception codes.thischwa.cf.<a href="codes/thischwa/cf/CloudflareNotFoundException.html" title="class in codes.thischwa.cf">CloudflareNotFoundException</a></dt>
<dd>
<div class="block">Constructs a new CloudflareNotFoundException with the specified detail message and cause.</div>
</dd>
<dt><a href="codes/thischwa/cf/CloudflareNotFoundException.html#%3Cinit%3E(java.lang.Throwable)" class="member-name-link">CloudflareNotFoundException(Throwable)</a> - Constructor for exception codes.thischwa.cf.<a href="codes/thischwa/cf/CloudflareNotFoundException.html" title="class in codes.thischwa.cf">CloudflareNotFoundException</a></dt>
<dd>
<div class="block">Constructs a new CloudflareNotFoundException with the specified cause.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/RecordType.html#CNAME" class="member-name-link">CNAME</a> - Enum constant in enum class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/RecordType.html" title="enum class in codes.thischwa.cf.model">RecordType</a></dt>
<dd>
<div class="block">Represents the DNS CNAME (Canonical Name) record type.</div>
</dd>
<dt><a href="codes/thischwa/cf/package-summary.html">codes.thischwa.cf</a> - package codes.thischwa.cf</dt>
<dd>
<div class="block">The base package of CloudflareDNS-java.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/package-summary.html">codes.thischwa.cf.model</a> - package codes.thischwa.cf.model</dt>
<dd>
<div class="block">The model of CloudflareDNS-java.</div>
</dd>
</dl>
<h2 class="title" id="I:D">D</h2>
<dl class="index">
<dt><a href="codes/thischwa/cf/model/PagingRequest.html#defaultPaging()" class="member-name-link">defaultPaging()</a> - Static method in class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/PagingRequest.html" title="class in codes.thischwa.cf.model">PagingRequest</a></dt>
<dd>
<div class="block">Creates a default <code>PagingRequest</code> instance with a page number set to 1 and a high number
of items per page (5,000,000) to accommodate large dataset requests.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/RecordType.html#DNSKEY" class="member-name-link">DNSKEY</a> - Enum constant in enum class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/RecordType.html" title="enum class in codes.thischwa.cf.model">RecordType</a></dt>
<dd>
<div class="block">Represents the DNSKEY record type.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/RecordType.html#DS" class="member-name-link">DS</a> - Enum constant in enum class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/RecordType.html" title="enum class in codes.thischwa.cf.model">RecordType</a></dt>
<dd>
<div class="block">Represents the DNS DS (Delegation Signer) record type.</div>
</dd>
</dl>
<h2 class="title" id="I:G">G</h2>
<dl class="index">
<dt><a href="codes/thischwa/cf/model/ResponseEntity.html#getId()" class="member-name-link">getId()</a> - Method in interface codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/ResponseEntity.html" title="interface in codes.thischwa.cf.model">ResponseEntity</a></dt>
<dd>
<div class="block">Retrieves the unique identifier of the entity.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/PagingRequest.html#getPagingParams()" class="member-name-link">getPagingParams()</a> - Method in class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/PagingRequest.html" title="class in codes.thischwa.cf.model">PagingRequest</a></dt>
<dd>
<div class="block">Retrieves the pagination parameters in a key-value map format.</div>
</dd>
</dl>
<h2 class="title" id="I:H">H</h2>
<dl class="index">
<dt><a href="codes/thischwa/cf/model/RecordType.html#HTTPS" class="member-name-link">HTTPS</a> - Enum constant in enum class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/RecordType.html" title="enum class in codes.thischwa.cf.model">RecordType</a></dt>
<dd>
<div class="block">Represents the DNS HTTPS (HTTP Service) record type.</div>
</dd>
</dl>
<h2 class="title" id="I:L">L</h2>
<dl class="index">
<dt><a href="codes/thischwa/cf/model/RecordType.html#LOC" class="member-name-link">LOC</a> - Enum constant in enum class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/RecordType.html" title="enum class in codes.thischwa.cf.model">RecordType</a></dt>
<dd>
<div class="block">Represents the DNS LOC (Location) record type.</div>
</dd>
</dl>
<h2 class="title" id="I:M">M</h2>
<dl class="index">
<dt><a href="codes/thischwa/cf/model/RecordType.html#MX" class="member-name-link">MX</a> - Enum constant in enum class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/RecordType.html" title="enum class in codes.thischwa.cf.model">RecordType</a></dt>
<dd>
<div class="block">Represents the DNS MX (Mail Exchange) record type.</div>
</dd>
</dl>
<h2 class="title" id="I:N">N</h2>
<dl class="index">
<dt><a href="codes/thischwa/cf/model/RecordType.html#NAPTR" class="member-name-link">NAPTR</a> - Enum constant in enum class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/RecordType.html" title="enum class in codes.thischwa.cf.model">RecordType</a></dt>
<dd>
<div class="block">Represents the NAPTR record type for DNS configurations.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/RecordType.html#NS" class="member-name-link">NS</a> - Enum constant in enum class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/RecordType.html" title="enum class in codes.thischwa.cf.model">RecordType</a></dt>
<dd>
<div class="block">Represents the namespace or identifier `"NS"` within the domain model.</div>
</dd>
</dl>
<h2 class="title" id="I:O">O</h2>
<dl class="index">
<dt><a href="codes/thischwa/cf/model/PagingRequest.html#of(int,int)" class="member-name-link">of(int, int)</a> - Static method in class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/PagingRequest.html" title="class in codes.thischwa.cf.model">PagingRequest</a></dt>
<dd>
<div class="block">Creates a new <code>PagingRequest</code> instance with the specified page number and items per page.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/RecordType.html#OPENPGPKEY" class="member-name-link">OPENPGPKEY</a> - Enum constant in enum class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/RecordType.html" title="enum class in codes.thischwa.cf.model">RecordType</a></dt>
<dd>
<div class="block">Represents the "OPENPGPKEY" DNS record type.</div>
</dd>
</dl>
<h2 class="title" id="I:P">P</h2>
<dl class="index">
<dt><a href="codes/thischwa/cf/model/PagingRequest.html" class="type-name-link" title="class in codes.thischwa.cf.model">PagingRequest</a> - Class in <a href="codes/thischwa/cf/model/package-summary.html">codes.thischwa.cf.model</a></dt>
<dd>
<div class="block">Represents a request model for paginated data.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/RecordType.html#PTR" class="member-name-link">PTR</a> - Enum constant in enum class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/RecordType.html" title="enum class in codes.thischwa.cf.model">RecordType</a></dt>
<dd>
<div class="block">Represents a DNS record type.</div>
</dd>
</dl>
<h2 class="title" id="I:R">R</h2>
<dl class="index">
<dt><a href="codes/thischwa/cf/CfRequest.html#RECORD_CREATE" class="member-name-link">RECORD_CREATE</a> - Enum constant in enum class codes.thischwa.cf.<a href="codes/thischwa/cf/CfRequest.html" title="enum class in codes.thischwa.cf">CfRequest</a></dt>
<dd>
<div class="block">Represents the API endpoint path for creating a new DNS record within a specific DNS zone.</div>
</dd>
<dt><a href="codes/thischwa/cf/CfRequest.html#RECORD_DELETE" class="member-name-link">RECORD_DELETE</a> - Enum constant in enum class codes.thischwa.cf.<a href="codes/thischwa/cf/CfRequest.html" title="enum class in codes.thischwa.cf">CfRequest</a></dt>
<dd>
<div class="block">Represents the API endpoint path for deleting an existing DNS record within a specific DNS zone.</div>
</dd>
<dt><a href="codes/thischwa/cf/CfRequest.html#RECORD_INFO_NAME" class="member-name-link">RECORD_INFO_NAME</a> - Enum constant in enum class codes.thischwa.cf.<a href="codes/thischwa/cf/CfRequest.html" title="enum class in codes.thischwa.cf">CfRequest</a></dt>
<dd>
<div class="block">Represents the API endpoint path for retrieving information about a DNS record within a specific
DNS zone by its name.</div>
</dd>
<dt><a href="codes/thischwa/cf/CfRequest.html#RECORD_INFO_NAME_TYPE" class="member-name-link">RECORD_INFO_NAME_TYPE</a> - Enum constant in enum class codes.thischwa.cf.<a href="codes/thischwa/cf/CfRequest.html" title="enum class in codes.thischwa.cf">CfRequest</a></dt>
<dd>
<div class="block">Represents the API endpoint path for retrieving information about a DNS record within a specific
DNS zone by its name and type.</div>
</dd>
<dt><a href="codes/thischwa/cf/CfRequest.html#RECORD_UPDATE" class="member-name-link">RECORD_UPDATE</a> - Enum constant in enum class codes.thischwa.cf.<a href="codes/thischwa/cf/CfRequest.html" title="enum class in codes.thischwa.cf">CfRequest</a></dt>
<dd>
<div class="block">Represents the API endpoint path for updating an existing DNS record within a specific DNS zone.</div>
</dd>
<dt><a href="codes/thischwa/cf/CfDnsClient.html#recordCreate(codes.thischwa.cf.model.ZoneEntity,codes.thischwa.cf.model.RecordEntity)" class="member-name-link">recordCreate(ZoneEntity, RecordEntity)</a> - Method in class codes.thischwa.cf.<a href="codes/thischwa/cf/CfDnsClient.html" title="class in codes.thischwa.cf">CfDnsClient</a></dt>
<dd>
<div class="block">Creates a new DNS record in the specified zone using the Cloudflare API.</div>
</dd>
<dt><a href="codes/thischwa/cf/CfDnsClient.html#recordDelete(codes.thischwa.cf.model.ZoneEntity,codes.thischwa.cf.model.RecordEntity)" class="member-name-link">recordDelete(ZoneEntity, RecordEntity)</a> - Method in class codes.thischwa.cf.<a href="codes/thischwa/cf/CfDnsClient.html" title="class in codes.thischwa.cf">CfDnsClient</a></dt>
<dd>
<div class="block">Deletes a DNS record of the specified type within a given zone on the Cloudflare API.</div>
</dd>
<dt><a href="codes/thischwa/cf/CfDnsClient.html#recordDelete(codes.thischwa.cf.model.ZoneEntity,java.lang.String)" class="member-name-link">recordDelete(ZoneEntity, String)</a> - Method in class codes.thischwa.cf.<a href="codes/thischwa/cf/CfDnsClient.html" title="class in codes.thischwa.cf">CfDnsClient</a></dt>
<dd>
<div class="block">Deletes a DNS record of the specified type within a given zone on the Cloudflare API.</div>
</dd>
<dt><a href="codes/thischwa/cf/CfDnsClient.html#recordDeleteTypeIfExists(codes.thischwa.cf.model.ZoneEntity,java.lang.String,codes.thischwa.cf.model.RecordType)" class="member-name-link">recordDeleteTypeIfExists(ZoneEntity, String, RecordType)</a> - Method in class codes.thischwa.cf.<a href="codes/thischwa/cf/CfDnsClient.html" title="class in codes.thischwa.cf">CfDnsClient</a></dt>
<dd>
<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>
</dd>
<dt><a href="codes/thischwa/cf/model/RecordEntity.html" class="type-name-link" title="class in codes.thischwa.cf.model">RecordEntity</a> - Class in <a href="codes/thischwa/cf/model/package-summary.html">codes.thischwa.cf.model</a></dt>
<dd>
<div class="block">Represents a DNS record entity within a specific zone.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/RecordEntity.html#%3Cinit%3E()" class="member-name-link">RecordEntity()</a> - Constructor for class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/RecordEntity.html" title="class in codes.thischwa.cf.model">RecordEntity</a></dt>
<dd>
<div class="block">Initializes a new instance of the RecordEntity class and invokes the parent constructor
from the AbstractEntity class.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/RecordMultipleResponse.html" class="type-name-link" title="class in codes.thischwa.cf.model">RecordMultipleResponse</a> - Class in <a href="codes/thischwa/cf/model/package-summary.html">codes.thischwa.cf.model</a></dt>
<dd>
<div class="block">Represents the API response of the Cloudflare API containing multiple DNS record entities.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/RecordMultipleResponse.html#%3Cinit%3E()" class="member-name-link">RecordMultipleResponse()</a> - Constructor for class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/RecordMultipleResponse.html" title="class in codes.thischwa.cf.model">RecordMultipleResponse</a></dt>
<dd>
<div class="block">Constructs an instance of RecordMultipleResponse.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/RecordSingleResponse.html" class="type-name-link" title="class in codes.thischwa.cf.model">RecordSingleResponse</a> - Class in <a href="codes/thischwa/cf/model/package-summary.html">codes.thischwa.cf.model</a></dt>
<dd>
<div class="block">Represents the API response of the Cloudflare API containing a single DNS record entity.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/RecordSingleResponse.html#%3Cinit%3E()" class="member-name-link">RecordSingleResponse()</a> - Constructor for class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/RecordSingleResponse.html" title="class in codes.thischwa.cf.model">RecordSingleResponse</a></dt>
<dd>
<div class="block">Constructs a new instance of the RecordSingleResponse class.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/RecordType.html" class="type-name-link" title="enum class in codes.thischwa.cf.model">RecordType</a> - Enum Class in <a href="codes/thischwa/cf/model/package-summary.html">codes.thischwa.cf.model</a></dt>
<dd>
<div class="block">Enum representing various DNS record types.</div>
</dd>
<dt><a href="codes/thischwa/cf/CfDnsClient.html#recordUpdate(codes.thischwa.cf.model.ZoneEntity,codes.thischwa.cf.model.RecordEntity)" class="member-name-link">recordUpdate(ZoneEntity, RecordEntity)</a> - Method in class codes.thischwa.cf.<a href="codes/thischwa/cf/CfDnsClient.html" title="class in codes.thischwa.cf">CfDnsClient</a></dt>
<dd>
<div class="block">Updates an existing DNS record in a specified Cloudflare zone.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/ResponseEntity.html" class="type-name-link" title="interface in codes.thischwa.cf.model">ResponseEntity</a> - Interface in <a href="codes/thischwa/cf/model/package-summary.html">codes.thischwa.cf.model</a></dt>
<dd>
<div class="block">Represents a contract for entities that have a unique identifier.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/ResultInfo.html" class="type-name-link" title="class in codes.thischwa.cf.model">ResultInfo</a> - Class in <a href="codes/thischwa/cf/model/package-summary.html">codes.thischwa.cf.model</a></dt>
<dd>
<div class="block">Represents metadata for paginated results.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/ResultInfo.html#%3Cinit%3E()" class="member-name-link">ResultInfo()</a> - Constructor for class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/ResultInfo.html" title="class in codes.thischwa.cf.model">ResultInfo</a></dt>
<dd>&nbsp;</dd>
</dl>
<h2 class="title" id="I:S">S</h2>
<dl class="index">
<dt><a href="codes/thischwa/cf/CfDnsClient.html#sldInfo(codes.thischwa.cf.model.ZoneEntity,java.lang.String,codes.thischwa.cf.model.RecordType)" class="member-name-link">sldInfo(ZoneEntity, String, RecordType)</a> - Method in class codes.thischwa.cf.<a href="codes/thischwa/cf/CfDnsClient.html" title="class in codes.thischwa.cf">CfDnsClient</a></dt>
<dd>
<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>
</dd>
<dt><a href="codes/thischwa/cf/CfDnsClient.html#sldListAll(codes.thischwa.cf.model.ZoneEntity,java.lang.String)" class="member-name-link">sldListAll(ZoneEntity, String)</a> - Method in class codes.thischwa.cf.<a href="codes/thischwa/cf/CfDnsClient.html" title="class in codes.thischwa.cf">CfDnsClient</a></dt>
<dd>
<div class="block">Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.</div>
</dd>
<dt><a href="codes/thischwa/cf/CfDnsClient.html#sldListAll(codes.thischwa.cf.model.ZoneEntity,java.lang.String,codes.thischwa.cf.model.PagingRequest)" class="member-name-link">sldListAll(ZoneEntity, String, PagingRequest)</a> - Method in class codes.thischwa.cf.<a href="codes/thischwa/cf/CfDnsClient.html" title="class in codes.thischwa.cf">CfDnsClient</a></dt>
<dd>
<div class="block">Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/RecordType.html#SMIMEA" class="member-name-link">SMIMEA</a> - Enum constant in enum class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/RecordType.html" title="enum class in codes.thischwa.cf.model">RecordType</a></dt>
<dd>
<div class="block">Represents the SMIMEA DNS record type.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/RecordType.html#SRV" class="member-name-link">SRV</a> - Enum constant in enum class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/RecordType.html" title="enum class in codes.thischwa.cf.model">RecordType</a></dt>
<dd>
<div class="block">Represents a service record (SRV) type in the DNS configuration model.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/RecordType.html#SSHFP" class="member-name-link">SSHFP</a> - Enum constant in enum class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/RecordType.html" title="enum class in codes.thischwa.cf.model">RecordType</a></dt>
<dd>
<div class="block">Represents the DNS record type "SSHFP" (SSH Fingerprint), used in DNS to store cryptographic
fingerprints associated with SSH host keys.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/RecordType.html#SVCB" class="member-name-link">SVCB</a> - Enum constant in enum class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/RecordType.html" title="enum class in codes.thischwa.cf.model">RecordType</a></dt>
<dd>
<div class="block">Represents the Service Binding (SVCB) DNS record type.</div>
</dd>
</dl>
<h2 class="title" id="I:T">T</h2>
<dl class="index">
<dt><a href="codes/thischwa/cf/model/RecordType.html#TLSA" class="member-name-link">TLSA</a> - Enum constant in enum class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/RecordType.html" title="enum class in codes.thischwa.cf.model">RecordType</a></dt>
<dd>
<div class="block">Represents a constant for the DNS-based Authentication of Named Entities (DANE) TLSA record
type.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/RecordType.html#toString()" class="member-name-link">toString()</a> - Method in enum class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/RecordType.html" title="enum class in codes.thischwa.cf.model">RecordType</a></dt>
<dd>&nbsp;</dd>
<dt><a href="codes/thischwa/cf/model/RecordType.html#TXT" class="member-name-link">TXT</a> - Enum constant in enum class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/RecordType.html" title="enum class in codes.thischwa.cf.model">RecordType</a></dt>
<dd>
<div class="block">Represents the TXT DNS record type.</div>
</dd>
</dl>
<h2 class="title" id="I:U">U</h2>
<dl class="index">
<dt><a href="codes/thischwa/cf/model/RecordType.html#URI" class="member-name-link">URI</a> - Enum constant in enum class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/RecordType.html" title="enum class in codes.thischwa.cf.model">RecordType</a></dt>
<dd>
<div class="block">Represents a Uniform Resource Identifier (URI).</div>
</dd>
</dl>
<h2 class="title" id="I:V">V</h2>
<dl class="index">
<dt><a href="codes/thischwa/cf/CfRequest.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum class codes.thischwa.cf.<a href="codes/thischwa/cf/CfRequest.html" title="enum class in codes.thischwa.cf">CfRequest</a></dt>
<dd>
<div class="block">Returns the enum constant of this class with the specified name.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/RecordType.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - Static method in enum class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/RecordType.html" title="enum class in codes.thischwa.cf.model">RecordType</a></dt>
<dd>
<div class="block">Returns the enum constant of this class with the specified name.</div>
</dd>
<dt><a href="codes/thischwa/cf/CfRequest.html#values()" class="member-name-link">values()</a> - Static method in enum class codes.thischwa.cf.<a href="codes/thischwa/cf/CfRequest.html" title="enum class in codes.thischwa.cf">CfRequest</a></dt>
<dd>
<div class="block">Returns an array containing the constants of this enum class, in
the order they are declared.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/RecordType.html#values()" class="member-name-link">values()</a> - Static method in enum class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/RecordType.html" title="enum class in codes.thischwa.cf.model">RecordType</a></dt>
<dd>
<div class="block">Returns an array containing the constants of this enum class, in
the order they are declared.</div>
</dd>
</dl>
<h2 class="title" id="I:Z">Z</h2>
<dl class="index">
<dt><a href="codes/thischwa/cf/CfRequest.html#ZONE_INFO" class="member-name-link">ZONE_INFO</a> - Enum constant in enum class codes.thischwa.cf.<a href="codes/thischwa/cf/CfRequest.html" title="enum class in codes.thischwa.cf">CfRequest</a></dt>
<dd>
<div class="block">Represents the API endpoint path for retrieving information about a specific DNS zone
by its name.</div>
</dd>
<dt><a href="codes/thischwa/cf/CfRequest.html#ZONE_LIST" class="member-name-link">ZONE_LIST</a> - Enum constant in enum class codes.thischwa.cf.<a href="codes/thischwa/cf/CfRequest.html" title="enum class in codes.thischwa.cf">CfRequest</a></dt>
<dd>
<div class="block">Represents the API endpoint path for retrieving the list of DNS zones.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/ZoneEntity.html" class="type-name-link" title="class in codes.thischwa.cf.model">ZoneEntity</a> - Class in <a href="codes/thischwa/cf/model/package-summary.html">codes.thischwa.cf.model</a></dt>
<dd>
<div class="block">Represents a DNS zone entity in the Cloudflare DNS system.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/ZoneEntity.html#%3Cinit%3E()" class="member-name-link">ZoneEntity()</a> - Constructor for class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/ZoneEntity.html" title="class in codes.thischwa.cf.model">ZoneEntity</a></dt>
<dd>
<div class="block">Default no-argument constructor for the ZoneEntity class.</div>
</dd>
<dt><a href="codes/thischwa/cf/CfDnsClient.html#zoneInfo(java.lang.String)" class="member-name-link">zoneInfo(String)</a> - Method in class codes.thischwa.cf.<a href="codes/thischwa/cf/CfDnsClient.html" title="class in codes.thischwa.cf">CfDnsClient</a></dt>
<dd>
<div class="block">Retrieves detailed information about a specific zone by its name.</div>
</dd>
<dt><a href="codes/thischwa/cf/CfDnsClient.html#zoneListAll()" class="member-name-link">zoneListAll()</a> - Method in class codes.thischwa.cf.<a href="codes/thischwa/cf/CfDnsClient.html" title="class in codes.thischwa.cf">CfDnsClient</a></dt>
<dd>
<div class="block">Retrieves a list of all zones from the Cloudflare API.</div>
</dd>
<dt><a href="codes/thischwa/cf/CfDnsClient.html#zoneListAll(codes.thischwa.cf.model.PagingRequest)" class="member-name-link">zoneListAll(PagingRequest)</a> - Method in class codes.thischwa.cf.<a href="codes/thischwa/cf/CfDnsClient.html" title="class in codes.thischwa.cf">CfDnsClient</a></dt>
<dd>
<div class="block">Retrieves a list of all DNS zones using the provided paging request parameters.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/ZoneMultipleResponse.html" class="type-name-link" title="class in codes.thischwa.cf.model">ZoneMultipleResponse</a> - Class in <a href="codes/thischwa/cf/model/package-summary.html">codes.thischwa.cf.model</a></dt>
<dd>
<div class="block">Represents a response model that contains multiple <a href="codes/thischwa/cf/model/ZoneEntity.html" title="class in codes.thischwa.cf.model"><code>ZoneEntity</code></a> instances.</div>
</dd>
<dt><a href="codes/thischwa/cf/model/ZoneMultipleResponse.html#%3Cinit%3E()" class="member-name-link">ZoneMultipleResponse()</a> - Constructor for class codes.thischwa.cf.model.<a href="codes/thischwa/cf/model/ZoneMultipleResponse.html" title="class in codes.thischwa.cf.model">ZoneMultipleResponse</a></dt>
<dd>
<div class="block">Constructs a new ZoneMultipleResponse object.</div>
</dd>
</dl>
<a href="#I:A">A</a>&nbsp;<a href="#I:B">B</a>&nbsp;<a href="#I:C">C</a>&nbsp;<a href="#I:D">D</a>&nbsp;<a href="#I:G">G</a>&nbsp;<a href="#I:H">H</a>&nbsp;<a href="#I:L">L</a>&nbsp;<a href="#I:M">M</a>&nbsp;<a href="#I:N">N</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:P">P</a>&nbsp;<a href="#I:R">R</a>&nbsp;<a href="#I:S">S</a>&nbsp;<a href="#I:T">T</a>&nbsp;<a href="#I:U">U</a>&nbsp;<a href="#I:V">V</a>&nbsp;<a href="#I:Z">Z</a>&nbsp;<br><a href="allclasses-index.html">All&nbsp;Classes&nbsp;and&nbsp;Interfaces</a><span class="vertical-separator">|</span><a href="allpackages-index.html">All&nbsp;Packages</a><span class="vertical-separator">|</span><a href="serialized-form.html">Serialized&nbsp;Form</a></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