From 2e7fa7586ace62a1732f7e10ccb2ce1abcd6f32b Mon Sep 17 00:00:00 2001 From: Thilo Schwarz Date: Wed, 23 Apr 2025 17:26:26 +0200 Subject: [PATCH] Update README with API version details and method categorization --- docs/apidocs/allclasses-index.html | 2 +- docs/apidocs/allpackages-index.html | 2 +- .../codes/thischwa/cf/CfDnsClient.html | 34 +++++++++---------- docs/apidocs/codes/thischwa/cf/CfRequest.html | 2 +- .../thischwa/cf/CloudflareApiException.html | 2 +- .../cf/CloudflareNotFoundException.html | 2 +- .../thischwa/cf/class-use/CfDnsClient.html | 2 +- .../thischwa/cf/class-use/CfRequest.html | 2 +- .../cf/class-use/CloudflareApiException.html | 6 ++-- .../CloudflareNotFoundException.html | 2 +- .../thischwa/cf/model/AbstractEntity.html | 2 +- .../cf/model/AbstractMultipleResponse.html | 2 +- .../thischwa/cf/model/AbstractResponse.html | 2 +- .../cf/model/AbstractSingleResponse.html | 2 +- .../thischwa/cf/model/PagingRequest.html | 2 +- .../codes/thischwa/cf/model/RecordEntity.html | 2 +- .../cf/model/RecordMultipleResponse.html | 2 +- .../cf/model/RecordSingleResponse.html | 2 +- .../codes/thischwa/cf/model/RecordType.html | 2 +- .../thischwa/cf/model/ResponseEntity.html | 2 +- .../thischwa/cf/model/ResponseResultInfo.html | 2 +- .../codes/thischwa/cf/model/ResultInfo.html | 2 +- .../codes/thischwa/cf/model/ZoneEntity.html | 2 +- .../cf/model/ZoneMultipleResponse.html | 2 +- .../cf/model/class-use/AbstractEntity.html | 2 +- .../class-use/AbstractMultipleResponse.html | 2 +- .../cf/model/class-use/AbstractResponse.html | 2 +- .../class-use/AbstractSingleResponse.html | 2 +- .../cf/model/class-use/PagingRequest.html | 2 +- .../cf/model/class-use/RecordEntity.html | 5 +-- .../class-use/RecordMultipleResponse.html | 2 +- .../model/class-use/RecordSingleResponse.html | 2 +- .../cf/model/class-use/RecordType.html | 5 +-- .../cf/model/class-use/ResponseEntity.html | 2 +- .../model/class-use/ResponseResultInfo.html | 2 +- .../cf/model/class-use/ResultInfo.html | 2 +- .../cf/model/class-use/ZoneEntity.html | 4 +-- .../model/class-use/ZoneMultipleResponse.html | 2 +- .../thischwa/cf/model/package-summary.html | 2 +- .../codes/thischwa/cf/model/package-tree.html | 2 +- .../codes/thischwa/cf/model/package-use.html | 2 +- .../codes/thischwa/cf/package-summary.html | 2 +- .../codes/thischwa/cf/package-tree.html | 2 +- .../codes/thischwa/cf/package-use.html | 2 +- docs/apidocs/help-doc.html | 2 +- docs/apidocs/index-all.html | 4 +-- docs/apidocs/index.html | 2 +- docs/apidocs/overview-summary.html | 2 +- docs/apidocs/overview-tree.html | 2 +- docs/apidocs/search.html | 2 +- docs/apidocs/serialized-form.html | 2 +- .../java/codes/thischwa/cf/CfDnsClient.java | 20 +++++------ 52 files changed, 85 insertions(+), 83 deletions(-) diff --git a/docs/apidocs/allclasses-index.html b/docs/apidocs/allclasses-index.html index 1f6cdb1..95f8509 100644 --- a/docs/apidocs/allclasses-index.html +++ b/docs/apidocs/allclasses-index.html @@ -1,7 +1,7 @@ - + Alle Klassen und Schnittstellen (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/allpackages-index.html b/docs/apidocs/allpackages-index.html index a6402f6..ba3a35e 100644 --- a/docs/apidocs/allpackages-index.html +++ b/docs/apidocs/allpackages-index.html @@ -1,7 +1,7 @@ - + Alle Packages (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/CfDnsClient.html b/docs/apidocs/codes/thischwa/cf/CfDnsClient.html index dd3f6a1..a4b4734 100644 --- a/docs/apidocs/codes/thischwa/cf/CfDnsClient.html +++ b/docs/apidocs/codes/thischwa/cf/CfDnsClient.html @@ -1,7 +1,7 @@ - + CfDnsClient (CloudflareDNS-java 0.2.0-SNAPSHOT API) @@ -96,7 +96,6 @@ loadScripts(document, 'script');
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. -

Example: 


  // Create a new CfDnsClient instance
@@ -187,8 +186,9 @@ loadScripts(document, 'script');
  RecordType type,
  String content)
-
Creates a DNS record in the specified DNS zone with the provided details.
-
+
Creates a new DNS record for a given second-level domain (SLD) within the specified zone. +
+
boolean
@@ -261,7 +261,7 @@ loadScripts(document, 'script');
Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
-
+
List @@ -528,24 +528,24 @@ loadScripts(document, 'script'); title="Klasse oder Schnittstelle in java.lang" class="external-link">String content) throws CloudflareApiException
-
Creates a DNS record in the specified DNS zone with the provided details.
+
Creates a new DNS record for a given second-level domain (SLD) within the specified zone. +
Parameter:
-
zone - the DNS zone in which the record will be created
-
sld - the second-level domain (SLD) used for constructing the fully qualified domain - name (FQDN) +
zone - The ZoneEntity representing the DNS zone where the record is to be created.
+
sld - The second-level domain (SLD) for which the DNS record is being created.
+
ttl - The time-to-live (TTL) value for the DNS record in seconds.
+
type - The RecordType specifying the type of the DNS record (e.g., A, AAAA, CNAME).
+
content - The content of the DNS record (e.g., IP address for A/AAAA records, target + domain for CNAME).
-
ttl - the time-to-live (TTL) value for the DNS record
-
type - the type of the DNS record (e.g., A, AAAA, CNAME)
-
content - the content or value of the DNS record
Gibt zurück:
-
the created DNS record as a RecordEntity - object -
+
The created RecordEntity object containing details of the newly created DNS record.
Löst aus:
CloudflareApiException - if an error occurs - while interacting with the Cloudflare API + title="Klasse in codes.thischwa.cf">CloudflareApiException - If an error occurs + while communicating with the Cloudflare API + or creating the record.
diff --git a/docs/apidocs/codes/thischwa/cf/CfRequest.html b/docs/apidocs/codes/thischwa/cf/CfRequest.html index c07ddd8..5de0989 100644 --- a/docs/apidocs/codes/thischwa/cf/CfRequest.html +++ b/docs/apidocs/codes/thischwa/cf/CfRequest.html @@ -1,7 +1,7 @@ - + CfRequest (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/CloudflareApiException.html b/docs/apidocs/codes/thischwa/cf/CloudflareApiException.html index 86e51c8..2e85548 100644 --- a/docs/apidocs/codes/thischwa/cf/CloudflareApiException.html +++ b/docs/apidocs/codes/thischwa/cf/CloudflareApiException.html @@ -1,7 +1,7 @@ - + CloudflareApiException (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/CloudflareNotFoundException.html b/docs/apidocs/codes/thischwa/cf/CloudflareNotFoundException.html index 7187062..1798973 100644 --- a/docs/apidocs/codes/thischwa/cf/CloudflareNotFoundException.html +++ b/docs/apidocs/codes/thischwa/cf/CloudflareNotFoundException.html @@ -1,7 +1,7 @@ - + CloudflareNotFoundException (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/class-use/CfDnsClient.html b/docs/apidocs/codes/thischwa/cf/class-use/CfDnsClient.html index 9685290..31c53fa 100644 --- a/docs/apidocs/codes/thischwa/cf/class-use/CfDnsClient.html +++ b/docs/apidocs/codes/thischwa/cf/class-use/CfDnsClient.html @@ -1,7 +1,7 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.CfDnsClient (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/class-use/CfRequest.html b/docs/apidocs/codes/thischwa/cf/class-use/CfRequest.html index 567e783..6376e7c 100644 --- a/docs/apidocs/codes/thischwa/cf/class-use/CfRequest.html +++ b/docs/apidocs/codes/thischwa/cf/class-use/CfRequest.html @@ -1,7 +1,7 @@ - + Verwendungsweise von Enum-Klasse codes.thischwa.cf.CfRequest (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/class-use/CloudflareApiException.html b/docs/apidocs/codes/thischwa/cf/class-use/CloudflareApiException.html index 353bf91..7af3232 100644 --- a/docs/apidocs/codes/thischwa/cf/class-use/CloudflareApiException.html +++ b/docs/apidocs/codes/thischwa/cf/class-use/CloudflareApiException.html @@ -1,7 +1,7 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.CloudflareApiException (CloudflareDNS-java 0.2.0-SNAPSHOT API) @@ -114,7 +114,7 @@ loadScripts(document, 'script'); String content)
-
Creates a DNS record in the specified DNS zone with the provided details.
+
Creates a new DNS record for a given second-level domain (SLD) within the specified zone.
boolean
CfDnsClient.
Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
-
+
List diff --git a/docs/apidocs/codes/thischwa/cf/class-use/CloudflareNotFoundException.html b/docs/apidocs/codes/thischwa/cf/class-use/CloudflareNotFoundException.html index 3baf45a..f6c3489 100644 --- a/docs/apidocs/codes/thischwa/cf/class-use/CloudflareNotFoundException.html +++ b/docs/apidocs/codes/thischwa/cf/class-use/CloudflareNotFoundException.html @@ -1,7 +1,7 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.CloudflareNotFoundException (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/model/AbstractEntity.html b/docs/apidocs/codes/thischwa/cf/model/AbstractEntity.html index 1dba14a..fa8bfec 100644 --- a/docs/apidocs/codes/thischwa/cf/model/AbstractEntity.html +++ b/docs/apidocs/codes/thischwa/cf/model/AbstractEntity.html @@ -1,7 +1,7 @@ - + AbstractEntity (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/model/AbstractMultipleResponse.html b/docs/apidocs/codes/thischwa/cf/model/AbstractMultipleResponse.html index c7637fa..fc00d90 100644 --- a/docs/apidocs/codes/thischwa/cf/model/AbstractMultipleResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/AbstractMultipleResponse.html @@ -1,7 +1,7 @@ - + AbstractMultipleResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/model/AbstractResponse.html b/docs/apidocs/codes/thischwa/cf/model/AbstractResponse.html index 8f95c5b..07d525a 100644 --- a/docs/apidocs/codes/thischwa/cf/model/AbstractResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/AbstractResponse.html @@ -1,7 +1,7 @@ - + AbstractResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/model/AbstractSingleResponse.html b/docs/apidocs/codes/thischwa/cf/model/AbstractSingleResponse.html index 0f2bc7d..ea38f17 100644 --- a/docs/apidocs/codes/thischwa/cf/model/AbstractSingleResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/AbstractSingleResponse.html @@ -1,7 +1,7 @@ - + AbstractSingleResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/model/PagingRequest.html b/docs/apidocs/codes/thischwa/cf/model/PagingRequest.html index d0a4390..3f35062 100644 --- a/docs/apidocs/codes/thischwa/cf/model/PagingRequest.html +++ b/docs/apidocs/codes/thischwa/cf/model/PagingRequest.html @@ -1,7 +1,7 @@ - + PagingRequest (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/model/RecordEntity.html b/docs/apidocs/codes/thischwa/cf/model/RecordEntity.html index d67dfa4..5d6fe86 100644 --- a/docs/apidocs/codes/thischwa/cf/model/RecordEntity.html +++ b/docs/apidocs/codes/thischwa/cf/model/RecordEntity.html @@ -1,7 +1,7 @@ - + RecordEntity (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/model/RecordMultipleResponse.html b/docs/apidocs/codes/thischwa/cf/model/RecordMultipleResponse.html index 533bb07..504d4be 100644 --- a/docs/apidocs/codes/thischwa/cf/model/RecordMultipleResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/RecordMultipleResponse.html @@ -1,7 +1,7 @@ - + RecordMultipleResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/model/RecordSingleResponse.html b/docs/apidocs/codes/thischwa/cf/model/RecordSingleResponse.html index 46cd1e0..f4c2ed4 100644 --- a/docs/apidocs/codes/thischwa/cf/model/RecordSingleResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/RecordSingleResponse.html @@ -1,7 +1,7 @@ - + RecordSingleResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/model/RecordType.html b/docs/apidocs/codes/thischwa/cf/model/RecordType.html index 83e1955..63ba479 100644 --- a/docs/apidocs/codes/thischwa/cf/model/RecordType.html +++ b/docs/apidocs/codes/thischwa/cf/model/RecordType.html @@ -1,7 +1,7 @@ - + RecordType (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/model/ResponseEntity.html b/docs/apidocs/codes/thischwa/cf/model/ResponseEntity.html index 24eb572..0551b5e 100644 --- a/docs/apidocs/codes/thischwa/cf/model/ResponseEntity.html +++ b/docs/apidocs/codes/thischwa/cf/model/ResponseEntity.html @@ -1,7 +1,7 @@ - + ResponseEntity (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/model/ResponseResultInfo.html b/docs/apidocs/codes/thischwa/cf/model/ResponseResultInfo.html index 7718cd5..e2ea01c 100644 --- a/docs/apidocs/codes/thischwa/cf/model/ResponseResultInfo.html +++ b/docs/apidocs/codes/thischwa/cf/model/ResponseResultInfo.html @@ -1,7 +1,7 @@ - + ResponseResultInfo (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/model/ResultInfo.html b/docs/apidocs/codes/thischwa/cf/model/ResultInfo.html index 58b41df..4282129 100644 --- a/docs/apidocs/codes/thischwa/cf/model/ResultInfo.html +++ b/docs/apidocs/codes/thischwa/cf/model/ResultInfo.html @@ -1,7 +1,7 @@ - + ResultInfo (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/model/ZoneEntity.html b/docs/apidocs/codes/thischwa/cf/model/ZoneEntity.html index d9db975..f6557fb 100644 --- a/docs/apidocs/codes/thischwa/cf/model/ZoneEntity.html +++ b/docs/apidocs/codes/thischwa/cf/model/ZoneEntity.html @@ -1,7 +1,7 @@ - + ZoneEntity (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/model/ZoneMultipleResponse.html b/docs/apidocs/codes/thischwa/cf/model/ZoneMultipleResponse.html index c2bb2fc..1afdb9e 100644 --- a/docs/apidocs/codes/thischwa/cf/model/ZoneMultipleResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/ZoneMultipleResponse.html @@ -1,7 +1,7 @@ - + ZoneMultipleResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractEntity.html b/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractEntity.html index 80b65b0..09b48cf 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractEntity.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractEntity.html @@ -1,7 +1,7 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.AbstractEntity (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractMultipleResponse.html b/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractMultipleResponse.html index 2a2dea0..ecc5b15 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractMultipleResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractMultipleResponse.html @@ -1,7 +1,7 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.AbstractMultipleResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractResponse.html b/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractResponse.html index 22a234f..603a004 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractResponse.html @@ -1,7 +1,7 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.AbstractResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractSingleResponse.html b/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractSingleResponse.html index 43c9c04..dc175cf 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractSingleResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractSingleResponse.html @@ -1,7 +1,7 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.AbstractSingleResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/PagingRequest.html b/docs/apidocs/codes/thischwa/cf/model/class-use/PagingRequest.html index 8480efc..092cf5b 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/PagingRequest.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/PagingRequest.html @@ -1,7 +1,7 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.PagingRequest (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/RecordEntity.html b/docs/apidocs/codes/thischwa/cf/model/class-use/RecordEntity.html index af0e1ba..5341393 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/RecordEntity.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/RecordEntity.html @@ -1,7 +1,7 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.RecordEntity (CloudflareDNS-java 0.2.0-SNAPSHOT API) @@ -104,7 +104,8 @@ loadScripts(document, 'script'); String content)
-
Creates a DNS record in the specified DNS zone with the provided details.
+
Creates a new DNS record for a given second-level domain (SLD) within the specified zone. +
RecordEntity
diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/RecordMultipleResponse.html b/docs/apidocs/codes/thischwa/cf/model/class-use/RecordMultipleResponse.html index e318761..721a77a 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/RecordMultipleResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/RecordMultipleResponse.html @@ -1,7 +1,7 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.RecordMultipleResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/RecordSingleResponse.html b/docs/apidocs/codes/thischwa/cf/model/class-use/RecordSingleResponse.html index 1a21358..fab460a 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/RecordSingleResponse.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/RecordSingleResponse.html @@ -1,7 +1,7 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.RecordSingleResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/RecordType.html b/docs/apidocs/codes/thischwa/cf/model/class-use/RecordType.html index cdb1757..0a6c918 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/RecordType.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/RecordType.html @@ -1,7 +1,7 @@ - + Verwendungsweise von Enum-Klasse codes.thischwa.cf.model.RecordType (CloudflareDNS-java 0.2.0-SNAPSHOT API) @@ -98,7 +98,8 @@ loadScripts(document, 'script'); RecordType type, String content)
-
Creates a DNS record in the specified DNS zone with the provided details.
+
Creates a new DNS record for a given second-level domain (SLD) within the specified zone. +
void
CfDnsClient. - + Verwendungsweise von Schnittstelle codes.thischwa.cf.model.ResponseEntity (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/ResponseResultInfo.html b/docs/apidocs/codes/thischwa/cf/model/class-use/ResponseResultInfo.html index a484911..bae88cc 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/ResponseResultInfo.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/ResponseResultInfo.html @@ -1,7 +1,7 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.ResponseResultInfo (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/ResultInfo.html b/docs/apidocs/codes/thischwa/cf/model/class-use/ResultInfo.html index 0beeaba..57bcfb6 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/ResultInfo.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/ResultInfo.html @@ -1,7 +1,7 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.ResultInfo (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/ZoneEntity.html b/docs/apidocs/codes/thischwa/cf/model/class-use/ZoneEntity.html index 2cd7ac6..67388ea 100644 --- a/docs/apidocs/codes/thischwa/cf/model/class-use/ZoneEntity.html +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/ZoneEntity.html @@ -1,7 +1,7 @@ - + Verwendungsweise von Klasse codes.thischwa.cf.model.ZoneEntity (CloudflareDNS-java 0.2.0-SNAPSHOT API) @@ -129,7 +129,7 @@ loadScripts(document, 'script'); String content)
-
Creates a DNS record in the specified DNS zone with the provided details.
+
Creates a new DNS record for a given second-level domain (SLD) within the specified zone.
boolean
CfDnsClient. - + Verwendungsweise von Klasse codes.thischwa.cf.model.ZoneMultipleResponse (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/model/package-summary.html b/docs/apidocs/codes/thischwa/cf/model/package-summary.html index 83f054f..534ecf3 100644 --- a/docs/apidocs/codes/thischwa/cf/model/package-summary.html +++ b/docs/apidocs/codes/thischwa/cf/model/package-summary.html @@ -1,7 +1,7 @@ - + codes.thischwa.cf.model (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/model/package-tree.html b/docs/apidocs/codes/thischwa/cf/model/package-tree.html index 1ea37a8..e715213 100644 --- a/docs/apidocs/codes/thischwa/cf/model/package-tree.html +++ b/docs/apidocs/codes/thischwa/cf/model/package-tree.html @@ -1,7 +1,7 @@ - + codes.thischwa.cf.model Klassenhierarchie (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/model/package-use.html b/docs/apidocs/codes/thischwa/cf/model/package-use.html index 1b70834..f9c2b86 100644 --- a/docs/apidocs/codes/thischwa/cf/model/package-use.html +++ b/docs/apidocs/codes/thischwa/cf/model/package-use.html @@ -1,7 +1,7 @@ - + Verwendungsweise von Package codes.thischwa.cf.model (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/package-summary.html b/docs/apidocs/codes/thischwa/cf/package-summary.html index 02b32f7..1f4ab1d 100644 --- a/docs/apidocs/codes/thischwa/cf/package-summary.html +++ b/docs/apidocs/codes/thischwa/cf/package-summary.html @@ -1,7 +1,7 @@ - + codes.thischwa.cf (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/package-tree.html b/docs/apidocs/codes/thischwa/cf/package-tree.html index 84c3380..4bb95be 100644 --- a/docs/apidocs/codes/thischwa/cf/package-tree.html +++ b/docs/apidocs/codes/thischwa/cf/package-tree.html @@ -1,7 +1,7 @@ - + codes.thischwa.cf Klassenhierarchie (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/codes/thischwa/cf/package-use.html b/docs/apidocs/codes/thischwa/cf/package-use.html index d767f6e..4acc472 100644 --- a/docs/apidocs/codes/thischwa/cf/package-use.html +++ b/docs/apidocs/codes/thischwa/cf/package-use.html @@ -1,7 +1,7 @@ - + Verwendungsweise von Package codes.thischwa.cf (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/help-doc.html b/docs/apidocs/help-doc.html index 532dc58..ab5d5a1 100644 --- a/docs/apidocs/help-doc.html +++ b/docs/apidocs/help-doc.html @@ -1,7 +1,7 @@ - + API-Hilfe (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/index-all.html b/docs/apidocs/index-all.html index 7042e8e..416d270 100644 --- a/docs/apidocs/index-all.html +++ b/docs/apidocs/index-all.html @@ -1,7 +1,7 @@ - + Index (CloudflareDNS-java 0.2.0-SNAPSHOT API) @@ -296,7 +296,7 @@ loadScripts(document, 'script'); codes.thischwa.cf.CfDnsClient
-
Creates a DNS record in the specified DNS zone with the provided details.
+
Creates a new DNS record for a given second-level domain (SLD) within the specified zone.
recordDelete(ZoneEntity, RecordEntity) - Methode in Klasse codes.thischwa.cf.CfDnsClient
diff --git a/docs/apidocs/index.html b/docs/apidocs/index.html index 485a505..43404bd 100644 --- a/docs/apidocs/index.html +++ b/docs/apidocs/index.html @@ -1,7 +1,7 @@ - + Überblick (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/overview-summary.html b/docs/apidocs/overview-summary.html index f9977f2..248d41c 100644 --- a/docs/apidocs/overview-summary.html +++ b/docs/apidocs/overview-summary.html @@ -1,7 +1,7 @@ - + CloudflareDNS-java 0.2.0-SNAPSHOT API diff --git a/docs/apidocs/overview-tree.html b/docs/apidocs/overview-tree.html index dc0ff8a..031f7ad 100644 --- a/docs/apidocs/overview-tree.html +++ b/docs/apidocs/overview-tree.html @@ -1,7 +1,7 @@ - + Klassenhierarchie (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/search.html b/docs/apidocs/search.html index 81bb8cf..c8a9d70 100644 --- a/docs/apidocs/search.html +++ b/docs/apidocs/search.html @@ -1,7 +1,7 @@ - + Suchen (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/docs/apidocs/serialized-form.html b/docs/apidocs/serialized-form.html index 97d4355..b6565cc 100644 --- a/docs/apidocs/serialized-form.html +++ b/docs/apidocs/serialized-form.html @@ -1,7 +1,7 @@ - + Serialisierte Form (CloudflareDNS-java 0.2.0-SNAPSHOT API) diff --git a/src/main/java/codes/thischwa/cf/CfDnsClient.java b/src/main/java/codes/thischwa/cf/CfDnsClient.java index 35543ba..71e168e 100644 --- a/src/main/java/codes/thischwa/cf/CfDnsClient.java +++ b/src/main/java/codes/thischwa/cf/CfDnsClient.java @@ -18,7 +18,6 @@ import lombok.extern.slf4j.Slf4j; * 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. - * *

Example: * 


  * // Create a new CfDnsClient instance
@@ -184,16 +183,17 @@ public class CfDnsClient extends CfBasicHttpClient {
   }
 
   /**
-   * Creates a DNS record in the specified DNS zone with the provided details.
+   * Creates a new DNS record for a given second-level domain (SLD) within the specified zone.
    *
-   * @param zone    the DNS zone in which the record will be created
-   * @param sld     the second-level domain (SLD) used for constructing the fully qualified domain
-   *                name (FQDN)
-   * @param ttl     the time-to-live (TTL) value for the DNS record
-   * @param type    the type of the DNS record (e.g., A, AAAA, CNAME)
-   * @param content the content or value of the DNS record
-   * @return the created DNS record as a {@link RecordEntity} object
-   * @throws CloudflareApiException if an error occurs while interacting with the Cloudflare API
+   * @param zone    The ZoneEntity representing the DNS zone where the record is to be created.
+   * @param sld     The second-level domain (SLD) for which the DNS record is being created.
+   * @param ttl     The time-to-live (TTL) value for the DNS record in seconds.
+   * @param type    The RecordType specifying the type of the DNS record (e.g., A, AAAA, CNAME).
+   * @param content The content of the DNS record (e.g., IP address for A/AAAA records, target
+   *                domain for CNAME).
+   * @return The created RecordEntity object containing details of the newly created DNS record.
+   * @throws CloudflareApiException If an error occurs while communicating with the Cloudflare API
+   *                                or creating the record.
    */
   public RecordEntity recordCreateSld(ZoneEntity zone, String sld, int ttl, RecordType type,
       String content) throws CloudflareApiException {