Alle Klassen und Schnittstellen

The base package of CloudflareDNS-java.

The model of CloudflareDNS-java.

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/CfDnsClient.html b/docs/apidocs/codes/thischwa/cf/CfDnsClient.html new file mode 100644 index 0000000..3fd9d13 --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/CfDnsClient.html @@ -0,0 +1,627 @@ + + + + +CfDnsClient (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

+ + +

codes.thischwa.cf.CfDnsClient

public class CfDnsClient +extends Object

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.

+
+
Konstruktorübersicht
+
Konstruktoren
+
+
Konstruktor
+
Beschreibung
+
CfDnsClient(boolean emptyResultThrowsException, + String baseUrl, + String authEmail, + String authKey, + String authToken)
+
+
Constructs a new instance of CfDnsClient, which facilitates interactions with the + Cloudflare DNS API.
+
+
CfDnsClient(String authEmail, + String authKey, + String authToken)
+
+
Constructs a CfDnsClient instance for interacting with the Cloudflare DNS API.
+
+
CfDnsClient(String baseUrl, + String authEmail, + String authKey, + String authToken)
+
+
Constructs a CfDnsClient instance for interacting with the Cloudflare DNS API.
+
+
+
+
+
+
Methodenübersicht
+
+
+
+
+
Modifizierer und Typ
+
Methode
+
Beschreibung
+
protected <T extends AbstractResponse> T
+
deleteRequest(String endpoint, + Class<T> responseType)
+
+
Sends a DELETE request to the given endpoint and maps the response.
+
+
protected <T extends AbstractResponse> T
+
getRequest(String endpoint, + Class<T> responseType)
+
+
Sends a GET request to the given endpoint and maps the response.
+
+
protected <T extends AbstractResponse, +R extends AbstractEntity> T
+
patchRequest(String endpoint, + R requestPayload, + Class<T> responseType)
+
+
Sends a PATCH request with a payload to the given endpoint and maps the response.
+
+
protected <T extends AbstractResponse, +R extends AbstractEntity> T
+
postRequest(String endpoint, + R requestPayload, + Class<T> responseType)
+
+
Sends a POST request with a payload to the given endpoint and maps the response.
+
+
protected <T extends AbstractResponse, +R extends AbstractEntity> T
+
putRequest(String endpoint, + R requestPayload, + Class<T> responseType)
+
+
Sends a PUT request with a payload to the given endpoint and maps the response.
+
+
RecordEntity
+
recordCreate(ZoneEntity zone, + RecordEntity rec)
+
+
Creates a new DNS record in the specified zone using the Cloudflare API.
+
+
boolean
+
recordDelete(ZoneEntity zone, + RecordEntity rec)
+
+
Deletes a DNS record of the specified type within a given zone on the Cloudflare API.
+
+
boolean
+
recordDelete(ZoneEntity zone, + String id)
+
+
Deletes a DNS record of the specified type within a given zone on the Cloudflare API.
+
+
void
+
recordDeleteTypeIfExists(ZoneEntity zone, + String sld, + RecordType type)
+
+
Attempts to delete a DNS record of a specific type for a given zone and second-level domain + (SLD), if it exists.
+
+
RecordEntity
+
recordUpdate(ZoneEntity zone, + RecordEntity rec)
+
+
Updates an existing DNS record in a specified Cloudflare zone.
+
+
RecordEntity
+
sldInfo(ZoneEntity zone, + String sld, + RecordType type)
+
+
Retrieves detailed information about a specific second-level domain (SLD) record for a given + zone and record type from the Cloudflare API.
+
+
List<RecordEntity>
+
sldListAll(ZoneEntity zone, + String sld)
+
+
Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
+
+
List<RecordEntity>
+
sldListAll(ZoneEntity zone, + String sld, + PagingRequest pagingRequest)
+
+
Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
+
+
ZoneEntity
+
zoneInfo(String name)
+
+
Retrieves detailed information about a specific zone by its name.
+
+
List<ZoneEntity>
+
zoneListAll()
+
+
Retrieves a list of all zones from the Cloudflare API.
+
+
List<ZoneEntity>
+
zoneListAll(PagingRequest pagingRequest)
+
+
Retrieves a list of all zones from the Cloudflare API.
+
+
+
+
+
+
Von Klasse geerbte Methoden java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+

+
+
Konstruktordetails
+
- +
  +
  CfDnsClient
  +
  public CfDnsClient(String authEmail, + String authKey, + String authToken)
  +
  Constructs a CfDnsClient instance for interacting with the Cloudflare DNS API.
  +
  +
  Parameter:
  +
  authEmail - The email address associated with the Cloudflare account, used for + authentication.
  +
  authKey - The API key of the Cloudflare account, used as part of the authentication + process.
  +
  authToken - The API token for accessing specific resources within the Cloudflare account.
  +
  +
  +
- +
  +
  CfDnsClient
  +
  public CfDnsClient(String baseUrl, + String authEmail, + String authKey, + String authToken)
  +
  Constructs a CfDnsClient instance for interacting with the Cloudflare DNS API.
  +
  +
  Parameter:
  +
  baseUrl - The base URL of the Cloudflare API to be used for requests.
  +
  authEmail - The email address associated with the Cloudflare account, used for + authentication.
  +
  authKey - The API key of the Cloudflare account, used as part of the authentication + process.
  +
  authToken - The API token for accessing specific resources within the Cloudflare account.
  +
  +
  +
- +
  +
  CfDnsClient
  +
  public CfDnsClient(boolean emptyResultThrowsException, + String baseUrl, + String authEmail, + String authKey, + String authToken)
  +
  Constructs a new instance of CfDnsClient, which facilitates interactions with the + Cloudflare DNS API.
  +
  +
  Parameter:
  +
  emptyResultThrowsException - Specifies if an exception should be thrown when the API + response is empty. Default is true.
  +
  baseUrl - The base URL for the Cloudflare API endpoint.
  +
  authEmail - The email associated with the Cloudflare account for authentication.
  +
  authKey - The API key for authenticating the client with Cloudflare services.
  +
  authToken - The authentication token used for authorized access to Cloudflare API.
  +
  +
  +
+
+
+
+
Methodendetails
+
- +
  +
  zoneListAll
  +
  public List<ZoneEntity> zoneListAll() + throws CloudflareApiException
  +
  Retrieves a list of all zones from the Cloudflare API.
  + This method sends a GET request to the Cloudflare API endpoint for listing zones, processes the + response, and returns the resulting list of ZoneEntity objects.
  +
  +
  Gibt zurück:
  +
  A list of ZoneEntity objects representing the zones retrieved from the Cloudflare API.
  +
  Löst aus:
  +
  CloudflareApiException - If an error occurs during the API request or response handling.
  +
  +
  +
- +
  +
  zoneListAll
  +
  public List<ZoneEntity> zoneListAll(PagingRequest pagingRequest) + throws CloudflareApiException
  +
  Retrieves a list of all zones from the Cloudflare API.
  + This method sends a GET request to the Cloudflare API endpoint for listing zones, processes the + response, and returns the resulting list of ZoneEntity objects.
  +
  +
  Gibt zurück:
  +
  A list of ZoneEntity objects representing the zones retrieved from the Cloudflare API.
  +
  Löst aus:
  +
  CloudflareApiException - If an error occurs during the API request or response handling.
  +
  +
  +
- +
  +
  zoneInfo
  +
  public ZoneEntity zoneInfo(String name) + throws CloudflareApiException
  +
  Retrieves detailed information about a specific zone by its name.
  +
  +
  Parameter:
  +
  name - The name of the zone to retrieve information for.
  +
  Gibt zurück:
  +
  A ZoneEntity object that contains details of the specified zone.
  +
  Löst aus:
  +
  CloudflareApiException - If an error occurs while making the API request or processing + the response.
  +
  +
  +
- +
  +
  sldListAll
  +
  public List<RecordEntity> sldListAll(ZoneEntity zone, + String sld) + throws CloudflareApiException
  +
  Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
  +
  +
  Parameter:
  +
  zone - The DNS zone entity for which the SLD records are to be fetched.
  +
  sld - The second-level domain name for which the records are retrieved.
  +
  Gibt zurück:
  +
  A list of RecordEntity objects representing the DNS records associated with the + provided SLD.
  +
  Löst aus:
  +
  CloudflareApiException - If an error occurs while interacting with the Cloudflare API.
  +
  +
  +
- +
  +
  sldListAll
  +
  public List<RecordEntity> sldListAll(ZoneEntity zone, + String sld, + PagingRequest pagingRequest) + throws CloudflareApiException
  +
  Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
  +
  +
  Parameter:
  +
  zone - The DNS zone entity for which the SLD records are to be fetched.
  +
  sld - The second-level domain name for which the records are retrieved.
  +
  pagingRequest - The paging request.
  +
  Gibt zurück:
  +
  A list of RecordEntity objects representing the DNS records associated with the + provided SLD.
  +
  Löst aus:
  +
  CloudflareApiException - If an error occurs while interacting with the Cloudflare API.
  +
  +
  +
- +
  +
  sldInfo
  +
  public RecordEntity sldInfo(ZoneEntity zone, + String sld, + RecordType type) + throws CloudflareApiException
  +
  Retrieves detailed information about a specific second-level domain (SLD) record for a given + zone and record type from the Cloudflare API.
  +
  +
  Parameter:
  +
  zone - the zone entity that contains information about the DNS zone
  +
  sld - the second-level domain (SLD) for which the record information is requested
  +
  type - the type of DNS record (e.g., A, AAAA, CNAME) being queried
  +
  Gibt zurück:
  +
  the record entity containing detailed information about the requested SLD and record + type
  +
  Löst aus:
  +
  CloudflareApiException - if an error occurs during interaction with the Cloudflare API
  +
  +
  +
- +
  +
  recordCreate
  +
  public RecordEntity recordCreate(ZoneEntity zone, + RecordEntity rec) + throws CloudflareApiException
  +
  Creates a new DNS record in the specified zone using the Cloudflare API.
  +
  +
  Parameter:
  +
  zone - The zone entity where the record will be created. Contains details such as zone ID.
  +
  rec - The record entity representing the DNS record to be created, including its + attributes.
  +
  Gibt zurück:
  +
  The created record entity as returned by the Cloudflare API.
  +
  Löst aus:
  +
  CloudflareApiException - If an error occurs while interacting with the Cloudflare API.
  +
  +
  +
- +
  +
  recordDelete
  +
  public boolean recordDelete(ZoneEntity zone, + RecordEntity rec) + throws CloudflareApiException
  +
  Deletes a DNS record of the specified type within a given zone on the Cloudflare API.
  +
  +
  Parameter:
  +
  zone - The zone entity that specifies the zone in which the record exists.
  +
  rec - The record entity that represents the DNS record to be deleted.
  +
  Gibt zurück:
  +
  true if the DNS record was successfully deleted; false otherwise.
  +
  Löst aus:
  +
  CloudflareApiException - if there is an issue during the API communication or the request + fails for any reason.
  +
  +
  +
- +
  +
  recordDelete
  +
  public boolean recordDelete(ZoneEntity zone, + String id) + throws CloudflareApiException
  +
  Deletes a DNS record of the specified type within a given zone on the Cloudflare API.
  +
  +
  Parameter:
  +
  zone - The zone entity that specifies the zone in which the record exists.
  +
  id - The record entity that represents the DNS record to be deleted.
  +
  Gibt zurück:
  +
  true if the DNS record was successfully deleted; false otherwise.
  +
  Löst aus:
  +
  CloudflareApiException - if there is an issue during the API communication or the request + fails for any reason.
  +
  +
  +
- +
  +
  recordUpdate
  +
  public RecordEntity recordUpdate(ZoneEntity zone, + RecordEntity rec) + throws CloudflareApiException
  +
  Updates an existing DNS record in a specified Cloudflare zone.
  +
  +
  Parameter:
  +
  zone - the zone entity containing the ID of the target zone
  +
  rec - the record entity containing the ID of the DNS record to be updated and its updated + data
  +
  Gibt zurück:
  +
  the updated record entity as returned by the Cloudflare API
  +
  Löst aus:
  +
  CloudflareApiException - if an error occurs while interacting with the Cloudflare API
  +
  +
  +
- +
  +
  recordDeleteTypeIfExists
  +
  public void recordDeleteTypeIfExists(ZoneEntity zone, + String sld, + RecordType type) + throws CloudflareApiException
  +
  Attempts to delete a DNS record of a specific type for a given zone and second-level domain + (SLD), if it exists.
  +
  +
  Parameter:
  +
  zone - The zone in which the DNS record resides. It provides information about the domain.
  +
  sld - The second-level domain (SLD) of the fully qualified domain name (FQDN) for which + the record is being deleted.
  +
  type - The type of the DNS record to be deleted (e.g., A, CNAME, TXT).
  +
  Löst aus:
  +
  CloudflareApiException - If an error occurs while interacting with the Cloudflare API.
  +
  +
  +
- +
  +
  getRequest
  +
  protected <T extends AbstractResponse> T getRequest(String endpoint, + Class<T> responseType) + throws CloudflareApiException
  +
  Sends a GET request to the given endpoint and maps the response.
  +
  +
  Löst aus:
  +
  CloudflareApiException
  +
  +
  +
- +
  +
  deleteRequest
  +
  protected <T extends AbstractResponse> T deleteRequest(String endpoint, + Class<T> responseType) + throws CloudflareApiException
  +
  Sends a DELETE request to the given endpoint and maps the response.
  +
  +
  Löst aus:
  +
  CloudflareApiException
  +
  +
  +
- +
  +
  postRequest
  +
  protected <T extends AbstractResponse, +R extends AbstractEntity> +T postRequest(String endpoint, + R requestPayload, + Class<T> responseType) + throws CloudflareApiException
  +
  Sends a POST request with a payload to the given endpoint and maps the response.
  +
  +
  Löst aus:
  +
  CloudflareApiException
  +
  +
  +
- +
  +
  putRequest
  +
  protected <T extends AbstractResponse, +R extends AbstractEntity> +T putRequest(String endpoint, + R requestPayload, + Class<T> responseType) + throws CloudflareApiException
  +
  Sends a PUT request with a payload to the given endpoint and maps the response.
  +
  +
  Löst aus:
  +
  CloudflareApiException
  +
  +
  +
- +
  +
  patchRequest
  +
  protected <T extends AbstractResponse, +R extends AbstractEntity> +T patchRequest(String endpoint, + R requestPayload, + Class<T> responseType) + throws CloudflareApiException
  +
  Sends a PATCH request with a payload to the given endpoint and maps the response.
  +
  +
  Löst aus:
  +
  CloudflareApiException
  +
  +
  +
+
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/CfRequest.html b/docs/apidocs/codes/thischwa/cf/CfRequest.html new file mode 100644 index 0000000..dfe0388 --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/CfRequest.html @@ -0,0 +1,278 @@ + + + + +CfRequest (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

+ + +

java.lang.Enum<CfRequest> +

codes.thischwa.cf.CfRequest

Alle implementierten Schnittstellen:: Serializable, Comparable<CfRequest>, Constable

public enum CfRequest +extends Enum<CfRequest>

Enum CfRequest encapsulates various API endpoint paths for managing DNS zones and records in a + cohesive and reusable manner. Each enum constant represents a specific API request path.

+
+
Verschachtelte Klassen - Übersicht
+
+
Von Klasse geerbte verschachtelte Klassen/Schnittstellen java.lang.Enum
+Enum.EnumDesc<E extends Enum<E>>
+
+
+
+
Enum-Konstanten - Übersicht
+
Enum-Konstanten
+
+
Enum-Konstante
+
Beschreibung
+
RECORD_CREATE
+

+
RECORD_DELETE
+

+
RECORD_INFO_NAME
+

+
RECORD_INFO_NAME_TYPE
+

+
RECORD_UPDATE
+

+
ZONE_INFO
+

+
ZONE_LIST
+

+
+
+
+
+
Methodenübersicht
+
+
+
+
+
Modifizierer und Typ
+
Methode
+
Beschreibung
+
static CfRequest
+
valueOf(String name)
+
+
Gibt die Enum-Konstante dieser Klasse mit dem angegebenen Namen zurück.
+
+
static CfRequest[]
+
values()
+
+
Gibt ein Array mit den Konstanten dieser Enum-Klasse in +der Reihenfolge ihrer Deklaration zurück.
+
+
+
+
+
+
Von Klasse geerbte Methoden java.lang.Enum
+clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
+
+
Von Klasse geerbte Methoden java.lang.Object
+getClass, notify, notifyAll, wait, wait, wait
+
+

+
+
Enum-Konstanten - Details
+
- +
  +
  ZONE_LIST
  +
  public static final CfRequest ZONE_LIST
  +
  +
- +
  +
  ZONE_INFO
  +
  public static final CfRequest ZONE_INFO
  +
  +
- +
  +
  RECORD_CREATE
  +
  public static final CfRequest RECORD_CREATE
  +
  +
- +
  +
  RECORD_INFO_NAME
  +
  public static final CfRequest RECORD_INFO_NAME
  +
  +
- +
  +
  RECORD_INFO_NAME_TYPE
  +
  public static final CfRequest RECORD_INFO_NAME_TYPE
  +
  +
- +
  +
  RECORD_UPDATE
  +
  public static final CfRequest RECORD_UPDATE
  +
  +
- +
  +
  RECORD_DELETE
  +
  public static final CfRequest RECORD_DELETE
  +
  +
+
+
+
+
Methodendetails
+
- +
  +
  values
  +
  public static CfRequest[] values()
  +
  Gibt ein Array mit den Konstanten dieser Enum-Klasse in +der Reihenfolge ihrer Deklaration zurück.
  +
  +
  Gibt zurück:
  +
  ein Array mit den Konstanten dieser Enum-Klasse in der Reihenfolge ihrer Deklaration
  +
  +
  +
- +
  +
  valueOf
  +
  public static CfRequest valueOf(String name)
  +
  Gibt die Enum-Konstante dieser Klasse mit dem angegebenen Namen zurück. +Die Zeichenfolge muss exakt mit einer ID übereinstimmen, +mit der eine Enum-Konstante in dieser Klasse deklariert wird. +(Zusätzliche Leerzeichen sind nicht zulässig.)
  +
  +
  Parameter:
  +
  name - Name der zurückzugebenden Enumerationskonstante.
  +
  Gibt zurück:
  +
  Enumerationskonstante mit dem angegebenen Namen
  +
  Löst aus:
  +
  IllegalArgumentException - wenn diese Enum-Klasse keine Konstante mit dem angegebenen Namen enthält
  +
  NullPointerException - wenn das Argument nicht angegeben wird
  +
  +
  +
+
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/CloudflareApiException.html b/docs/apidocs/codes/thischwa/cf/CloudflareApiException.html new file mode 100644 index 0000000..3250ac4 --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/CloudflareApiException.html @@ -0,0 +1,215 @@ + + + + +CloudflareApiException (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

+ + +

java.lang.Throwable +

java.lang.Exception +

codes.thischwa.cf.CloudflareApiException

Alle implementierten Schnittstellen:: Serializable

Bekannte direkte Unterklassen:: CloudflareNotFoundException

public class CloudflareApiException +extends Exception

Represents a custom exception for errors encountered while interacting with the Cloudflare API.

Siehe auch:

+ +

+
+
Konstruktorübersicht
+
Konstruktoren
+
+
Konstruktor
+
Beschreibung
+
CloudflareApiException(String message)
+
+
Constructs a new CloudflareApiException with the specified detail message.
+
+
CloudflareApiException(String message, + Throwable cause)
+
+
Constructs a new CloudflareApiException with the specified detail message and cause.
+
+
CloudflareApiException(Throwable cause)
+
+
Constructs a new CloudflareApiException with the specified cause.
+
+
+
+
+
+
Methodenübersicht
+
+
Von Klasse geerbte Methoden java.lang.Throwable
+addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
+
+
Von Klasse geerbte Methoden java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+
+

+
+
Konstruktordetails
+
- +
  +
  CloudflareApiException
  +
  public CloudflareApiException(String message)
  +
  Constructs a new CloudflareApiException with the specified detail message.
  +
  +
  Parameter:
  +
  message - the detail message, which provides more information about the exception.
  +
  +
  +
- +
  +
  CloudflareApiException
  +
  public CloudflareApiException(String message, + Throwable cause)
  +
  Constructs a new CloudflareApiException with the specified detail message and cause.
  +
  +
  Parameter:
  +
  message - the detail message, which provides additional context or information about the exception.
  +
  cause - the cause of this exception, which is the underlying throwable that triggered this exception.
  +
  +
  +
- +
  +
  CloudflareApiException
  +
  public CloudflareApiException(Throwable cause)
  +
  Constructs a new CloudflareApiException with the specified cause.
  +
  +
  Parameter:
  +
  cause - the cause of this exception, which is the underlying throwable + that triggered this exception.
  +
  +
  +
+
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/CloudflareNotFoundException.html b/docs/apidocs/codes/thischwa/cf/CloudflareNotFoundException.html new file mode 100644 index 0000000..91cf25d --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/CloudflareNotFoundException.html @@ -0,0 +1,219 @@ + + + + +CloudflareNotFoundException (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

+ + +

codes.thischwa.cf.CloudflareApiException +

java.lang.Throwable +

java.lang.Exception +

codes.thischwa.cf.CloudflareNotFoundException

Alle implementierten Schnittstellen:: Serializable

public class CloudflareNotFoundException +extends CloudflareApiException

This exception is thrown to indicate that a requested resource was not found during interaction + with the Cloudflare API. + +

It extends CloudflareApiException to provide specific errors related to situations + where Cloudflare responds with a "not found" operation.

Siehe auch:

+ +

+
+
Konstruktorübersicht
+
Konstruktoren
+
+
Konstruktor
+
Beschreibung
+
CloudflareNotFoundException(String message)
+
+
Constructs a new CloudflareNotFoundException with the specified detail message.
+
+
CloudflareNotFoundException(String message, + Throwable cause)
+
+
Constructs a new CloudflareNotFoundException with the specified detail message and cause.
+
+
CloudflareNotFoundException(Throwable cause)
+
+
Constructs a new CloudflareNotFoundException with the specified cause.
+
+
+
+
+
+
Methodenübersicht
+
+
Von Klasse geerbte Methoden java.lang.Throwable
+addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
+
+
Von Klasse geerbte Methoden java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
+
+

+
+
Konstruktordetails
+
- +
  +
  CloudflareNotFoundException
  +
  public CloudflareNotFoundException(String message)
  +
  Constructs a new CloudflareNotFoundException with the specified detail message.
  +
  +
  Parameter:
  +
  message - the detail message, which provides additional context about the "not found" error + encountered during interaction with the Cloudflare API.
  +
  +
  +
- +
  +
  CloudflareNotFoundException
  +
  public CloudflareNotFoundException(String message, + Throwable cause)
  +
  Constructs a new CloudflareNotFoundException with the specified detail message and cause.
  +
  +
  Parameter:
  +
  message - the detail message, which provides additional context about the "not found" error + encountered during interaction with the Cloudflare API.
  +
  cause - the cause of this exception, which is the underlying throwable that triggered this exception.
  +
  +
  +
- +
  +
  CloudflareNotFoundException
  +
  public CloudflareNotFoundException(Throwable cause)
  +
  Constructs a new CloudflareNotFoundException with the specified cause.
  +
  +
  Parameter:
  +
  cause - the cause of this exception, which is the underlying throwable + that triggered this exception.
  +
  +
  +
+
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/class-use/CfDnsClient.html b/docs/apidocs/codes/thischwa/cf/class-use/CfDnsClient.html new file mode 100644 index 0000000..595f12a --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/class-use/CfDnsClient.html @@ -0,0 +1,62 @@ + + + + +Verwendungsweise von Klasse codes.thischwa.cf.CfDnsClient (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

+ +Keine Verwendung von codes.thischwa.cf.CfDnsClient

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/class-use/CfRequest.html b/docs/apidocs/codes/thischwa/cf/class-use/CfRequest.html new file mode 100644 index 0000000..26fdc3d --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/class-use/CfRequest.html @@ -0,0 +1,97 @@ + + + + +Verwendungsweise von Enum-Klasse codes.thischwa.cf.CfRequest (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

Packages, die CfRequest verwenden

Package

Beschreibung

The base package of CloudflareDNS-java.

+
+
Verwendungen von CfRequest in codes.thischwa.cf
+
Methoden in codes.thischwa.cf, die CfRequest zurückgeben
+
+
Modifizierer und Typ
+
Methode
+
Beschreibung
+
static CfRequest
+
CfRequest.valueOf(String name)
+
+
Gibt die Enum-Konstante dieser Klasse mit dem angegebenen Namen zurück.
+
+
static CfRequest[]
+
CfRequest.values()
+
+
Gibt ein Array mit den Konstanten dieser Enum-Klasse in +der Reihenfolge ihrer Deklaration zurück.
+
+
+
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/class-use/CloudflareApiException.html b/docs/apidocs/codes/thischwa/cf/class-use/CloudflareApiException.html new file mode 100644 index 0000000..f4e2f10 --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/class-use/CloudflareApiException.html @@ -0,0 +1,166 @@ + + + + +Verwendungsweise von Klasse codes.thischwa.cf.CloudflareApiException (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

Packages, die CloudflareApiException verwenden

Package

Beschreibung

The base package of CloudflareDNS-java.

+
+
Verwendungen von CloudflareApiException in codes.thischwa.cf
+
Unterklassen von CloudflareApiException in codes.thischwa.cf
+
+
Modifizierer und Typ
+
Klasse
+
Beschreibung
+
class
+
CloudflareNotFoundException
+
+
This exception is thrown to indicate that a requested resource was not found during interaction + with the Cloudflare API.
+
+
+
Methoden in codes.thischwa.cf, die CloudflareApiException auslösen
+
+
Modifizierer und Typ
+
Methode
+
Beschreibung
+
RecordEntity
+
CfDnsClient.recordCreate(ZoneEntity zone, + RecordEntity rec)
+
+
Creates a new DNS record in the specified zone using the Cloudflare API.
+
+
boolean
+
CfDnsClient.recordDelete(ZoneEntity zone, + RecordEntity rec)
+
+
Deletes a DNS record of the specified type within a given zone on the Cloudflare API.
+
+
boolean
+
CfDnsClient.recordDelete(ZoneEntity zone, + String id)
+
+
Deletes a DNS record of the specified type within a given zone on the Cloudflare API.
+
+
void
+
CfDnsClient.recordDeleteTypeIfExists(ZoneEntity zone, + String sld, + RecordType type)
+
+
Attempts to delete a DNS record of a specific type for a given zone and second-level domain + (SLD), if it exists.
+
+
RecordEntity
+
CfDnsClient.recordUpdate(ZoneEntity zone, + RecordEntity rec)
+
+
Updates an existing DNS record in a specified Cloudflare zone.
+
+
RecordEntity
+
CfDnsClient.sldInfo(ZoneEntity zone, + String sld, + RecordType type)
+
+
Retrieves detailed information about a specific second-level domain (SLD) record for a given + zone and record type from the Cloudflare API.
+
+
List<RecordEntity>
+
CfDnsClient.sldListAll(ZoneEntity zone, + String sld)
+
+
Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
+
+
List<RecordEntity>
+
CfDnsClient.sldListAll(ZoneEntity zone, + String sld, + PagingRequest pagingRequest)
+
+
Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
+
+
ZoneEntity
+
CfDnsClient.zoneInfo(String name)
+
+
Retrieves detailed information about a specific zone by its name.
+
+
List<ZoneEntity>
+
CfDnsClient.zoneListAll()
+
+
Retrieves a list of all zones from the Cloudflare API.
+
+
List<ZoneEntity>
+
CfDnsClient.zoneListAll(PagingRequest pagingRequest)
+
+
Retrieves a list of all zones from the Cloudflare API.
+
+
+
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/class-use/CloudflareNotFoundException.html b/docs/apidocs/codes/thischwa/cf/class-use/CloudflareNotFoundException.html new file mode 100644 index 0000000..3f23d35 --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/class-use/CloudflareNotFoundException.html @@ -0,0 +1,62 @@ + + + + +Verwendungsweise von Klasse codes.thischwa.cf.CloudflareNotFoundException (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

+ +Keine Verwendung von codes.thischwa.cf.CloudflareNotFoundException

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/model/AbstractEntity.html b/docs/apidocs/codes/thischwa/cf/model/AbstractEntity.html new file mode 100644 index 0000000..bee45a0 --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/model/AbstractEntity.html @@ -0,0 +1,169 @@ + + + + +AbstractEntity (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

+ + +

codes.thischwa.cf.model.AbstractEntity

Alle implementierten Schnittstellen:: ResponseEntity

Bekannte direkte Unterklassen:: RecordEntity, ZoneEntity

public class AbstractEntity +extends Object +implements ResponseEntity

Represents a base abstract entity class for modeling domain objects with a unique identifier. + +

This class provides a fundamental contract for entities by implementing the ResponseEntity interface. The primary attribute of this class is the `id` field, which serves as + a unique identifier for all derived entities. + +

Commonly extended by other entity classes to maintain a consistent entity structure across the + domain models. This encourages code reusability and consistency within the system.

+
+
Konstruktorübersicht
+
Konstruktoren
+
+
Konstruktor
+
Beschreibung
+
AbstractEntity()
+

+
+
+
+
+
Methodenübersicht
+
+
Von Klasse geerbte Methoden java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
Von Schnittstelle geerbte Methoden codes.thischwa.cf.model.ResponseEntity
+getId
+
+

+
+
Konstruktordetails
+
- +
  +
  AbstractEntity
  +
  public AbstractEntity()
  +
  +
+
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/model/AbstractMultipleResponse.html b/docs/apidocs/codes/thischwa/cf/model/AbstractMultipleResponse.html new file mode 100644 index 0000000..ab60b16 --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/model/AbstractMultipleResponse.html @@ -0,0 +1,173 @@ + + + + +AbstractMultipleResponse (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

+ + +

codes.thischwa.cf.model.AbstractMultipleResponse<T>

Bekannte direkte Unterklassen:: RecordMultipleResponse, ZoneMultipleResponse

public abstract class AbstractMultipleResponse<T extends ResponseEntity> +extends AbstractResponse

Abstract base class for response models that contain multiple result entries. + +

This class is designed to handle API responses where multiple entities are part of the result + set, such as paginated or batched data. It extends AbstractResponse to include additional + attributes specific to multi-entity responses. + +

Attributes: + +

`resultInfo`: Provides metadata about the result set, such as pagination details like page + number, total count, number of results per page, etc. +
`result`: A list of entities representing the main body of the response. The type of + entities in the result list is determined by the generic parameter T, which must + extend ResponseEntity. +

+ +

Subclasses can be created by specifying the entity type that the response should handle.

+
+
Konstruktorübersicht
+
Konstruktoren
+
+
Konstruktor
+
Beschreibung
+
AbstractMultipleResponse()
+

+
+
+
+
+
Methodenübersicht
+
+
Von Klasse geerbte Methoden java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+

+
+
Konstruktordetails
+
- +
  +
  AbstractMultipleResponse
  +
  public AbstractMultipleResponse()
  +
  +
+
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/model/AbstractResponse.html b/docs/apidocs/codes/thischwa/cf/model/AbstractResponse.html new file mode 100644 index 0000000..d24503e --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/model/AbstractResponse.html @@ -0,0 +1,169 @@ + + + + +AbstractResponse (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

+ + +

codes.thischwa.cf.model.AbstractResponse

Bekannte direkte Unterklassen:: AbstractMultipleResponse, AbstractSingleResponse

public abstract class AbstractResponse +extends Object

Abstract base class for API response models. + +

This class encapsulates common attributes used to represent the result of an API request. It + can be extended to define more specific response structures. + +

Attributes: + +

success: Indicates whether the API request was successful. +
errors: A list of error messages, if any, returned by the API. +
messages: A list of informational or status messages accompanying the response. +

+ +

This structure is designed for consistency and ease of extending response models in + applications that require uniform response structures.

+
+
Konstruktorübersicht
+
Konstruktoren
+
+
Konstruktor
+
Beschreibung
+
AbstractResponse()
+

+
+
+
+
+
Methodenübersicht
+
+
Von Klasse geerbte Methoden java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+

+
+
Konstruktordetails
+
- +
  +
  AbstractResponse
  +
  public AbstractResponse()
  +
  +
+
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/model/AbstractSingleResponse.html b/docs/apidocs/codes/thischwa/cf/model/AbstractSingleResponse.html new file mode 100644 index 0000000..5bbe257 --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/model/AbstractSingleResponse.html @@ -0,0 +1,170 @@ + + + + +AbstractSingleResponse (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

+ + +

codes.thischwa.cf.model.AbstractSingleResponse<T>

Typparameter:: T - The type of the response entity that extends ResponseEntity.

Bekannte direkte Unterklassen:: RecordSingleResponse

public abstract class AbstractSingleResponse<T extends ResponseEntity> +extends AbstractResponse

Represents a base abstract response model for handling single response entities within an API + response. + +

This class extends AbstractResponse, inheriting common response attributes such as + success status, error messages, and informational messages. It introduces a single generic type + parameter <T> which extends ResponseEntity, enforcing type consistency for the + result attribute. + +

Primary Attribute: result: Represents the single entity result of the response. This + is a generic type that ensures flexibility and adaptability for different entity models.

+
+
Konstruktorübersicht
+
Konstruktoren
+
+
Konstruktor
+
Beschreibung
+
AbstractSingleResponse()
+

+
+
+
+
+
Methodenübersicht
+
+
Von Klasse geerbte Methoden java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+

+
+
Konstruktordetails
+
- +
  +
  AbstractSingleResponse
  +
  public AbstractSingleResponse()
  +
  +
+
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/model/PagingRequest.html b/docs/apidocs/codes/thischwa/cf/model/PagingRequest.html new file mode 100644 index 0000000..db5997c --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/model/PagingRequest.html @@ -0,0 +1,229 @@ + + + + +PagingRequest (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

+ + +

codes.thischwa.cf.model.PagingRequest

public class PagingRequest +extends Object

Represents a request model for paginated data. + +

This class encapsulates the page number and the number of items per page for a paginated + request, along with utility methods for constructing and retrieving pagination parameters. + +

Key functionalities: + +

Creating a PagingRequest instance with specific pagination values using the + of method. +
Creating a default PagingRequest with predefined pagination values. +
Retrieving pagination parameters as a key-value map. +
Generating a query string representation for the pagination parameters. +

+
+
Methodenübersicht
+
+
+
+
+
Modifizierer und Typ
+
Methode
+
Beschreibung
+
String
+
addQueryString(String endpoint)
+
+
Appends a query string with pagination parameters (page and perPage) to the provided endpoint.
+
+
static PagingRequest
+
defaultPaging()
+
+
Creates a default PagingRequest instance with a page number set to 1 and a high number + of items per page (5,000,000) to accommodate large dataset requests.
+
+
Map<String,String>
+
getPagingParams()
+
+
Retrieves the pagination parameters in a key-value map format.
+
+
static PagingRequest
+
of(int page, + int perPage)
+
+
Creates a new PagingRequest instance with the specified page number and items per page.
+
+
+
+
+
+
Von Klasse geerbte Methoden java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+

+
+
Methodendetails
+
- +
  +
  of
  +
  public static PagingRequest of(int page, + int perPage)
  +
  Creates a new PagingRequest instance with the specified page number and items per page.
  +
  +
  Parameter:
  +
  page - the page number to be requested
  +
  perPage - the number of items to be included per page
  +
  Gibt zurück:
  +
  a new PagingRequest instance with the provided parameters
  +
  +
  +
- +
  +
  defaultPaging
  +
  public static PagingRequest defaultPaging()
  +
  Creates a default PagingRequest instance with a page number set to 1 and a high number + of items per page (5,000,000) to accommodate large dataset requests.
  +
  +
  Gibt zurück:
  +
  a default PagingRequest instance with predefined pagination parameters
  +
  +
  +
- +
  +
  getPagingParams
  +
  public Map<String,String> getPagingParams()
  +
  Retrieves the pagination parameters in a key-value map format.
  +
  +
  Gibt zurück:
  +
  a map containing the pagination parameters, where the key "page" indicates the current + page number and the key "perPage" indicates the number of items per page.
  +
  +
  +
- +
  +
  addQueryString
  +
  public String addQueryString(String endpoint)
  +
  Appends a query string with pagination parameters (page and perPage) to the provided endpoint.
  +
  +
  Parameter:
  +
  endpoint - the base URL or API endpoint to which the query string will be appended
  +
  Gibt zurück:
  +
  the complete URL with the appended query string for pagination
  +
  +
  +
+
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/model/RecordEntity.html b/docs/apidocs/codes/thischwa/cf/model/RecordEntity.html new file mode 100644 index 0000000..a92936d --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/model/RecordEntity.html @@ -0,0 +1,221 @@ + + + + +RecordEntity (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

+ + +

codes.thischwa.cf.model.AbstractEntity +

codes.thischwa.cf.model.RecordEntity

Alle implementierten Schnittstellen:: ResponseEntity

public class RecordEntity +extends AbstractEntity

Represents a DNS record entity within a specific zone. + +

Attributes defined in this class include: + +

DNS record type such as "A" or "CNAME". +
Name of the DNS record. +
Content of the DNS record, such as an IP address. +
Flags indicating whether the record is proxiable or proxied. +
TTL (Time-To-Live) for the DNS record. +
A locked status to indicate immutability of the record. +
Zone-specific metadata including zone ID and name. +
Timestamps for creation and modification. +

+ +

Provides a static factory method build for creating a DNS record with specific + attributes.

+
+
Konstruktorübersicht
+
Konstruktoren
+
+
Konstruktor
+
Beschreibung
+
RecordEntity()
+

+
+
+
+
+
Methodenübersicht
+
+
+
+
+
Modifizierer und Typ
+
Methode
+
Beschreibung
+
static RecordEntity
+
build(String name, + RecordType type, + Integer ttl, + String ip)
+
+
Builds and returns a RecordEntity instance with the specified attributes.
+
+
+
+
+
+
Von Klasse geerbte Methoden java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
Von Schnittstelle geerbte Methoden codes.thischwa.cf.model.ResponseEntity
+getId
+
+

+
+
Konstruktordetails
+
- +
  +
  RecordEntity
  +
  public RecordEntity()
  +
  +
+
+
+
+
Methodendetails
+
- +
  +
  build
  +
  public static RecordEntity build(String name, + RecordType type, + Integer ttl, + String ip)
  +
  Builds and returns a RecordEntity instance with the specified attributes.
  +
  +
  Parameter:
  +
  name - the name of the DNS record
  +
  type - the RecordType of the DNS record
  +
  ttl - the time-to-live (TTL) value for the DNS record
  +
  ip - the content of the DNS record, typically an IP address
  +
  Gibt zurück:
  +
  a RecordEntity populated with the provided attributes
  +
  +
  +
+
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/model/RecordMultipleResponse.html b/docs/apidocs/codes/thischwa/cf/model/RecordMultipleResponse.html new file mode 100644 index 0000000..44ee4c7 --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/model/RecordMultipleResponse.html @@ -0,0 +1,155 @@ + + + + +RecordMultipleResponse (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

+ + +

codes.thischwa.cf.model.AbstractMultipleResponse<RecordEntity> +

codes.thischwa.cf.model.RecordMultipleResponse

public class RecordMultipleResponse +extends AbstractMultipleResponse<RecordEntity>

Represents the API response of the Cloudflare API containing multiple DNS record entities.

+
+
Konstruktorübersicht
+
Konstruktoren
+
+
Konstruktor
+
Beschreibung
+
RecordMultipleResponse()
+

+
+
+
+
+
Methodenübersicht
+
+
Von Klasse geerbte Methoden java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+

+
+
Konstruktordetails
+
- +
  +
  RecordMultipleResponse
  +
  public RecordMultipleResponse()
  +
  +
+
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/model/RecordSingleResponse.html b/docs/apidocs/codes/thischwa/cf/model/RecordSingleResponse.html new file mode 100644 index 0000000..bb8e47d --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/model/RecordSingleResponse.html @@ -0,0 +1,155 @@ + + + + +RecordSingleResponse (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

+ + +

codes.thischwa.cf.model.AbstractSingleResponse<RecordEntity> +

codes.thischwa.cf.model.RecordSingleResponse

public class RecordSingleResponse +extends AbstractSingleResponse<RecordEntity>

Represents the API response of the Cloudflare API containing a single DNS record entity.

+
+
Konstruktorübersicht
+
Konstruktoren
+
+
Konstruktor
+
Beschreibung
+
RecordSingleResponse()
+

+
+
+
+
+
Methodenübersicht
+
+
Von Klasse geerbte Methoden java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+

+
+
Konstruktordetails
+
- +
  +
  RecordSingleResponse
  +
  public RecordSingleResponse()
  +
  +
+
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/model/RecordType.html b/docs/apidocs/codes/thischwa/cf/model/RecordType.html new file mode 100644 index 0000000..2a482ca --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/model/RecordType.html @@ -0,0 +1,406 @@ + + + + +RecordType (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

+ + +

java.lang.Enum<RecordType> +

codes.thischwa.cf.model.RecordType

Alle implementierten Schnittstellen:: Serializable, Comparable<RecordType>, Constable

public enum RecordType +extends Enum<RecordType>

Enum representing various DNS record types. + +

Each constant in this enum corresponds to a specific DNS record type, such as "A", "AAAA", + "CNAME", or "TXT". This enum provides a means to standardize the representation of these record + types throughout the application while allowing easy retrieval of their string representation.

+
+
Verschachtelte Klassen - Übersicht
+
+
Von Klasse geerbte verschachtelte Klassen/Schnittstellen java.lang.Enum
+Enum.EnumDesc<E extends Enum<E>>
+
+
+
+
Enum-Konstanten - Übersicht
+
Enum-Konstanten
+
+
Enum-Konstante
+
Beschreibung
+
A
+

+
AAAA
+

+
CAA
+

+
CERT
+

+
CNAME
+

+
DNSKEY
+

+
DS
+

+
HTTPS
+

+
LOC
+

+
MX
+

+
NAPTR
+

+
NS
+

+
OPENPGPKEY
+

+
PTR
+

+
SMIMEA
+

+
SRV
+

+
SSHFP
+

+
SVCB
+

+
TLSA
+

+
TXT
+

+
URI
+

+
+
+
+
+
Methodenübersicht
+
+
+
+
+
Modifizierer und Typ
+
Methode
+
Beschreibung
+
String
+
toString()
+

+
static RecordType
+
valueOf(String name)
+
+
Gibt die Enum-Konstante dieser Klasse mit dem angegebenen Namen zurück.
+
+
static RecordType[]
+
values()
+
+
Gibt ein Array mit den Konstanten dieser Enum-Klasse in +der Reihenfolge ihrer Deklaration zurück.
+
+
+
+
+
+
Von Klasse geerbte Methoden java.lang.Enum
+clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
+
+
Von Klasse geerbte Methoden java.lang.Object
+getClass, notify, notifyAll, wait, wait, wait
+
+

+
+
Enum-Konstanten - Details
+
- +
  +
  A
  +
  public static final RecordType A
  +
  +
- +
  +
  AAAA
  +
  public static final RecordType AAAA
  +
  +
- +
  +
  CAA
  +
  public static final RecordType CAA
  +
  +
- +
  +
  CERT
  +
  public static final RecordType CERT
  +
  +
- +
  +
  CNAME
  +
  public static final RecordType CNAME
  +
  +
- +
  +
  DNSKEY
  +
  public static final RecordType DNSKEY
  +
  +
- +
  +
  DS
  +
  public static final RecordType DS
  +
  +
- +
  +
  HTTPS
  +
  public static final RecordType HTTPS
  +
  +
- +
  +
  LOC
  +
  public static final RecordType LOC
  +
  +
- +
  +
  MX
  +
  public static final RecordType MX
  +
  +
- +
  +
  NAPTR
  +
  public static final RecordType NAPTR
  +
  +
- +
  +
  NS
  +
  public static final RecordType NS
  +
  +
- +
  +
  OPENPGPKEY
  +
  public static final RecordType OPENPGPKEY
  +
  +
- +
  +
  PTR
  +
  public static final RecordType PTR
  +
  +
- +
  +
  SMIMEA
  +
  public static final RecordType SMIMEA
  +
  +
- +
  +
  SRV
  +
  public static final RecordType SRV
  +
  +
- +
  +
  SSHFP
  +
  public static final RecordType SSHFP
  +
  +
- +
  +
  SVCB
  +
  public static final RecordType SVCB
  +
  +
- +
  +
  TLSA
  +
  public static final RecordType TLSA
  +
  +
- +
  +
  TXT
  +
  public static final RecordType TXT
  +
  +
- +
  +
  URI
  +
  public static final RecordType URI
  +
  +
+
+
+
+
Methodendetails
+
- +
  +
  values
  +
  public static RecordType[] values()
  +
  Gibt ein Array mit den Konstanten dieser Enum-Klasse in +der Reihenfolge ihrer Deklaration zurück.
  +
  +
  Gibt zurück:
  +
  ein Array mit den Konstanten dieser Enum-Klasse in der Reihenfolge ihrer Deklaration
  +
  +
  +
- +
  +
  valueOf
  +
  public static RecordType valueOf(String name)
  +
  Gibt die Enum-Konstante dieser Klasse mit dem angegebenen Namen zurück. +Die Zeichenfolge muss exakt mit einer ID übereinstimmen, +mit der eine Enum-Konstante in dieser Klasse deklariert wird. +(Zusätzliche Leerzeichen sind nicht zulässig.)
  +
  +
  Parameter:
  +
  name - Name der zurückzugebenden Enumerationskonstante.
  +
  Gibt zurück:
  +
  Enumerationskonstante mit dem angegebenen Namen
  +
  Löst aus:
  +
  IllegalArgumentException - wenn diese Enum-Klasse keine Konstante mit dem angegebenen Namen enthält
  +
  NullPointerException - wenn das Argument nicht angegeben wird
  +
  +
  +
- +
  +
  toString
  +
  public String toString()
  +
  +
  Setzt außer Kraft:
  +
  toString in Klasse Enum<RecordType>
  +
  +
  +
+
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/model/ResponseEntity.html b/docs/apidocs/codes/thischwa/cf/model/ResponseEntity.html new file mode 100644 index 0000000..c8fbf5f --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/model/ResponseEntity.html @@ -0,0 +1,158 @@ + + + + +ResponseEntity (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

+ + +

Alle bekannten Implementierungsklassen:: AbstractEntity, RecordEntity, ZoneEntity

public interface ResponseEntity

Represents a contract for entities that have a unique identifier. + +

This interface is primarily used as a common abstraction for domain objects that require a + unique identifier, enabling type consistency and code reusability.

+
+
Methodenübersicht
+
+
+
+
+
Modifizierer und Typ
+
Methode
+
Beschreibung
+
String
+
getId()
+
+
Retrieves the unique identifier of the entity.
+
+
+
+
+
+

+
+
Methodendetails
+
- +
  +
  getId
  +
  String getId()
  +
  Retrieves the unique identifier of the entity.
  +
  +
  Gibt zurück:
  +
  the unique identifier as a String
  +
  +
  +
+
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/model/ResultInfo.html b/docs/apidocs/codes/thischwa/cf/model/ResultInfo.html new file mode 100644 index 0000000..56f57b8 --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/model/ResultInfo.html @@ -0,0 +1,162 @@ + + + + +ResultInfo (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

+ + +

codes.thischwa.cf.model.ResultInfo

public class ResultInfo +extends Object

Represents metadata for paginated results. + +

This class contains information about the current page, page size, total pages, and result + counts, which can be utilized in managing and navigating through paginated data. + +

page: The current page number. +
perPage: The number of results per page. +
totalPages: The total number of pages available. +
count: The number of results on the current page. +
totalCount: The total number of results across all pages. +

+
+
Konstruktorübersicht
+
Konstruktoren
+
+
Konstruktor
+
Beschreibung
+
ResultInfo()
+

+
+
+
+
+
Methodenübersicht
+
+
Von Klasse geerbte Methoden java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+

+
+
Konstruktordetails
+
- +
  +
  ResultInfo
  +
  public ResultInfo()
  +
  +
+
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/model/ZoneEntity.html b/docs/apidocs/codes/thischwa/cf/model/ZoneEntity.html new file mode 100644 index 0000000..62f6688 --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/model/ZoneEntity.html @@ -0,0 +1,176 @@ + + + + +ZoneEntity (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

+ + +

codes.thischwa.cf.model.AbstractEntity +

codes.thischwa.cf.model.ZoneEntity

Alle implementierten Schnittstellen:: ResponseEntity

public class ZoneEntity +extends AbstractEntity

Represents a DNS zone entity in the Cloudflare DNS system.
+ +

This class encapsulates all relevant data and metadata associated with a zone, including but + not limited to the following attributes: + +

Zone name. +
Development mode status. +
Active and original name servers linked to the zone. +
Timestamps indicating when the zone was created, modified, or activated. +
Current operational status of the zone (e.g., active, inactive). +
Boolean flag indicating whether the zone is paused. +
Zone type, representing the nature of the DNS zone (e.g., full, partial). +

+ +

This class extends AbstractEntity to inherit basic entity properties and to provide a + consistent interface across domain models.

+
+
Konstruktorübersicht
+
Konstruktoren
+
+
Konstruktor
+
Beschreibung
+
ZoneEntity()
+

+
+
+
+
+
Methodenübersicht
+
+
Von Klasse geerbte Methoden java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+
Von Schnittstelle geerbte Methoden codes.thischwa.cf.model.ResponseEntity
+getId
+
+

+
+
Konstruktordetails
+
- +
  +
  ZoneEntity
  +
  public ZoneEntity()
  +
  +
+
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/model/ZoneMultipleResponse.html b/docs/apidocs/codes/thischwa/cf/model/ZoneMultipleResponse.html new file mode 100644 index 0000000..b2cc41a --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/model/ZoneMultipleResponse.html @@ -0,0 +1,155 @@ + + + + +ZoneMultipleResponse (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

+ + +

codes.thischwa.cf.model.AbstractMultipleResponse<ZoneEntity> +

codes.thischwa.cf.model.ZoneMultipleResponse

public class ZoneMultipleResponse +extends AbstractMultipleResponse<ZoneEntity>

Represents a response model that contains multiple ZoneEntity instances.

+
+
Konstruktorübersicht
+
Konstruktoren
+
+
Konstruktor
+
Beschreibung
+
ZoneMultipleResponse()
+

+
+
+
+
+
Methodenübersicht
+
+
Von Klasse geerbte Methoden java.lang.Object
+clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+
+

+
+
Konstruktordetails
+
- +
  +
  ZoneMultipleResponse
  +
  public ZoneMultipleResponse()
  +
  +
+
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractEntity.html b/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractEntity.html new file mode 100644 index 0000000..a5c49b3 --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractEntity.html @@ -0,0 +1,96 @@ + + + + +Verwendungsweise von Klasse codes.thischwa.cf.model.AbstractEntity (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

Packages, die AbstractEntity verwenden

Package

Beschreibung

The model of CloudflareDNS-java.

+
+
Verwendungen von AbstractEntity in codes.thischwa.cf.model
+
Unterklassen von AbstractEntity in codes.thischwa.cf.model
+
+
Modifizierer und Typ
+
Klasse
+
Beschreibung
+
class
+
RecordEntity
+
+
Represents a DNS record entity within a specific zone.
+
+
class
+
ZoneEntity
+
+
Represents a DNS zone entity in the Cloudflare DNS system.
+
+
+
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractMultipleResponse.html b/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractMultipleResponse.html new file mode 100644 index 0000000..8886e0c --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractMultipleResponse.html @@ -0,0 +1,96 @@ + + + + +Verwendungsweise von Klasse codes.thischwa.cf.model.AbstractMultipleResponse (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

Packages, die AbstractMultipleResponse verwenden

Package

Beschreibung

The model of CloudflareDNS-java.

+
+
Verwendungen von AbstractMultipleResponse in codes.thischwa.cf.model
+
Unterklassen von AbstractMultipleResponse in codes.thischwa.cf.model
+
+
Modifizierer und Typ
+
Klasse
+
Beschreibung
+
class
+
RecordMultipleResponse
+
+
Represents the API response of the Cloudflare API containing multiple DNS record entities.
+
+
class
+
ZoneMultipleResponse
+
+
Represents a response model that contains multiple ZoneEntity instances.
+
+
+
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractResponse.html b/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractResponse.html new file mode 100644 index 0000000..87db884 --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractResponse.html @@ -0,0 +1,112 @@ + + + + +Verwendungsweise von Klasse codes.thischwa.cf.model.AbstractResponse (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

Packages, die AbstractResponse verwenden

Package

Beschreibung

The model of CloudflareDNS-java.

+
+
Verwendungen von AbstractResponse in codes.thischwa.cf.model
+
Unterklassen von AbstractResponse in codes.thischwa.cf.model
+
+
Modifizierer und Typ
+
Klasse
+
Beschreibung
+
class
+
AbstractMultipleResponse<T extends ResponseEntity>
+
+
Abstract base class for response models that contain multiple result entries.
+
+
class
+
AbstractSingleResponse<T extends ResponseEntity>
+
+
Represents a base abstract response model for handling single response entities within an API + response.
+
+
class
+
RecordMultipleResponse
+
+
Represents the API response of the Cloudflare API containing multiple DNS record entities.
+
+
class
+
RecordSingleResponse
+
+
Represents the API response of the Cloudflare API containing a single DNS record entity.
+
+
class
+
ZoneMultipleResponse
+
+
Represents a response model that contains multiple ZoneEntity instances.
+
+
+
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractSingleResponse.html b/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractSingleResponse.html new file mode 100644 index 0000000..97e16f2 --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/AbstractSingleResponse.html @@ -0,0 +1,91 @@ + + + + +Verwendungsweise von Klasse codes.thischwa.cf.model.AbstractSingleResponse (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

Packages, die AbstractSingleResponse verwenden

Package

Beschreibung

The model of CloudflareDNS-java.

+
+
Verwendungen von AbstractSingleResponse in codes.thischwa.cf.model
+
Unterklassen von AbstractSingleResponse in codes.thischwa.cf.model
+
+
Modifizierer und Typ
+
Klasse
+
Beschreibung
+
class
+
RecordSingleResponse
+
+
Represents the API response of the Cloudflare API containing a single DNS record entity.
+
+
+
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/PagingRequest.html b/docs/apidocs/codes/thischwa/cf/model/class-use/PagingRequest.html new file mode 100644 index 0000000..69495e5 --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/PagingRequest.html @@ -0,0 +1,125 @@ + + + + +Verwendungsweise von Klasse codes.thischwa.cf.model.PagingRequest (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

Packages, die PagingRequest verwenden

Package

Beschreibung

The base package of CloudflareDNS-java.

The model of CloudflareDNS-java.

+
+
Verwendungen von PagingRequest in codes.thischwa.cf
+
Methoden in codes.thischwa.cf mit Parametern vom Typ PagingRequest
+
+
Modifizierer und Typ
+
Methode
+
Beschreibung
+
List<RecordEntity>
+
CfDnsClient.sldListAll(ZoneEntity zone, + String sld, + PagingRequest pagingRequest)
+
+
Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
+
+
List<ZoneEntity>
+
CfDnsClient.zoneListAll(PagingRequest pagingRequest)
+
+
Retrieves a list of all zones from the Cloudflare API.
+
+
+
+
+
+
Verwendungen von PagingRequest in codes.thischwa.cf.model
+
Methoden in codes.thischwa.cf.model, die PagingRequest zurückgeben
+
+
Modifizierer und Typ
+
Methode
+
Beschreibung
+
static PagingRequest
+
PagingRequest.defaultPaging()
+
+
Creates a default PagingRequest instance with a page number set to 1 and a high number + of items per page (5,000,000) to accommodate large dataset requests.
+
+
static PagingRequest
+
PagingRequest.of(int page, + int perPage)
+
+
Creates a new PagingRequest instance with the specified page number and items per page.
+
+
+
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/RecordEntity.html b/docs/apidocs/codes/thischwa/cf/model/class-use/RecordEntity.html new file mode 100644 index 0000000..069e6b7 --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/RecordEntity.html @@ -0,0 +1,172 @@ + + + + +Verwendungsweise von Klasse codes.thischwa.cf.model.RecordEntity (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

Packages, die RecordEntity verwenden

Package

Beschreibung

The base package of CloudflareDNS-java.

The model of CloudflareDNS-java.

+
+
Verwendungen von RecordEntity in codes.thischwa.cf
+
Methoden in codes.thischwa.cf, die RecordEntity zurückgeben
+
+
Modifizierer und Typ
+
Methode
+
Beschreibung
+
RecordEntity
+
CfDnsClient.recordCreate(ZoneEntity zone, + RecordEntity rec)
+
+
Creates a new DNS record in the specified zone using the Cloudflare API.
+
+
RecordEntity
+
CfDnsClient.recordUpdate(ZoneEntity zone, + RecordEntity rec)
+
+
Updates an existing DNS record in a specified Cloudflare zone.
+
+
RecordEntity
+
CfDnsClient.sldInfo(ZoneEntity zone, + String sld, + RecordType type)
+
+
Retrieves detailed information about a specific second-level domain (SLD) record for a given + zone and record type from the Cloudflare API.
+
+
+
Methoden in codes.thischwa.cf, die Typen mit Argumenten vom Typ RecordEntity zurückgeben
+
+
Modifizierer und Typ
+
Methode
+
Beschreibung
+
List<RecordEntity>
+
CfDnsClient.sldListAll(ZoneEntity zone, + String sld)
+
+
Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
+
+
List<RecordEntity>
+
CfDnsClient.sldListAll(ZoneEntity zone, + String sld, + PagingRequest pagingRequest)
+
+
Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
+
+
+
Methoden in codes.thischwa.cf mit Parametern vom Typ RecordEntity
+
+
Modifizierer und Typ
+
Methode
+
Beschreibung
+
RecordEntity
+
CfDnsClient.recordCreate(ZoneEntity zone, + RecordEntity rec)
+
+
Creates a new DNS record in the specified zone using the Cloudflare API.
+
+
boolean
+
CfDnsClient.recordDelete(ZoneEntity zone, + RecordEntity rec)
+
+
Deletes a DNS record of the specified type within a given zone on the Cloudflare API.
+
+
RecordEntity
+
CfDnsClient.recordUpdate(ZoneEntity zone, + RecordEntity rec)
+
+
Updates an existing DNS record in a specified Cloudflare zone.
+
+
+
+
+
+
Verwendungen von RecordEntity in codes.thischwa.cf.model
+
Methoden in codes.thischwa.cf.model, die RecordEntity zurückgeben
+
+
Modifizierer und Typ
+
Methode
+
Beschreibung
+
static RecordEntity
+
RecordEntity.build(String name, + RecordType type, + Integer ttl, + String ip)
+
+
Builds and returns a RecordEntity instance with the specified attributes.
+
+
+
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/RecordMultipleResponse.html b/docs/apidocs/codes/thischwa/cf/model/class-use/RecordMultipleResponse.html new file mode 100644 index 0000000..111a7b4 --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/RecordMultipleResponse.html @@ -0,0 +1,62 @@ + + + + +Verwendungsweise von Klasse codes.thischwa.cf.model.RecordMultipleResponse (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

+ +Keine Verwendung von codes.thischwa.cf.model.RecordMultipleResponse

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/RecordSingleResponse.html b/docs/apidocs/codes/thischwa/cf/model/class-use/RecordSingleResponse.html new file mode 100644 index 0000000..7d33793 --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/RecordSingleResponse.html @@ -0,0 +1,62 @@ + + + + +Verwendungsweise von Klasse codes.thischwa.cf.model.RecordSingleResponse (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

+ +Keine Verwendung von codes.thischwa.cf.model.RecordSingleResponse

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/RecordType.html b/docs/apidocs/codes/thischwa/cf/model/class-use/RecordType.html new file mode 100644 index 0000000..2b8c42e --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/RecordType.html @@ -0,0 +1,142 @@ + + + + +Verwendungsweise von Enum-Klasse codes.thischwa.cf.model.RecordType (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

Packages, die RecordType verwenden

Package

Beschreibung

The base package of CloudflareDNS-java.

The model of CloudflareDNS-java.

+
+
Verwendungen von RecordType in codes.thischwa.cf
+
Methoden in codes.thischwa.cf mit Parametern vom Typ RecordType
+
+
Modifizierer und Typ
+
Methode
+
Beschreibung
+
void
+
CfDnsClient.recordDeleteTypeIfExists(ZoneEntity zone, + String sld, + RecordType type)
+
+
Attempts to delete a DNS record of a specific type for a given zone and second-level domain + (SLD), if it exists.
+
+
RecordEntity
+
CfDnsClient.sldInfo(ZoneEntity zone, + String sld, + RecordType type)
+
+
Retrieves detailed information about a specific second-level domain (SLD) record for a given + zone and record type from the Cloudflare API.
+
+
+
+
+
+
Verwendungen von RecordType in codes.thischwa.cf.model
+
Methoden in codes.thischwa.cf.model, die RecordType zurückgeben
+
+
Modifizierer und Typ
+
Methode
+
Beschreibung
+
static RecordType
+
RecordType.valueOf(String name)
+
+
Gibt die Enum-Konstante dieser Klasse mit dem angegebenen Namen zurück.
+
+
static RecordType[]
+
RecordType.values()
+
+
Gibt ein Array mit den Konstanten dieser Enum-Klasse in +der Reihenfolge ihrer Deklaration zurück.
+
+
+
Methoden in codes.thischwa.cf.model mit Parametern vom Typ RecordType
+
+
Modifizierer und Typ
+
Methode
+
Beschreibung
+
static RecordEntity
+
RecordEntity.build(String name, + RecordType type, + Integer ttl, + String ip)
+
+
Builds and returns a RecordEntity instance with the specified attributes.
+
+
+
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/ResponseEntity.html b/docs/apidocs/codes/thischwa/cf/model/class-use/ResponseEntity.html new file mode 100644 index 0000000..7d95328 --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/ResponseEntity.html @@ -0,0 +1,118 @@ + + + + +Verwendungsweise von Schnittstelle codes.thischwa.cf.model.ResponseEntity (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

Packages, die ResponseEntity verwenden

Package

Beschreibung

The model of CloudflareDNS-java.

+
+
Verwendungen von ResponseEntity in codes.thischwa.cf.model
+
Klassen in codes.thischwa.cf.model mit Typparametern vom Typ ResponseEntity
+
+
Modifizierer und Typ
+
Klasse
+
Beschreibung
+
class
+
AbstractMultipleResponse<T extends ResponseEntity>
+
+
Abstract base class for response models that contain multiple result entries.
+
+
class
+
AbstractSingleResponse<T extends ResponseEntity>
+
+
Represents a base abstract response model for handling single response entities within an API + response.
+
+
+
Klassen in codes.thischwa.cf.model, die ResponseEntity implementieren
+
+
Modifizierer und Typ
+
Klasse
+
Beschreibung
+
class
+
AbstractEntity
+
+
Represents a base abstract entity class for modeling domain objects with a unique identifier.
+
+
class
+
RecordEntity
+
+
Represents a DNS record entity within a specific zone.
+
+
class
+
ZoneEntity
+
+
Represents a DNS zone entity in the Cloudflare DNS system.
+
+
+
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/ResultInfo.html b/docs/apidocs/codes/thischwa/cf/model/class-use/ResultInfo.html new file mode 100644 index 0000000..bdb8501 --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/ResultInfo.html @@ -0,0 +1,62 @@ + + + + +Verwendungsweise von Klasse codes.thischwa.cf.model.ResultInfo (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

+ +Keine Verwendung von codes.thischwa.cf.model.ResultInfo

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/ZoneEntity.html b/docs/apidocs/codes/thischwa/cf/model/class-use/ZoneEntity.html new file mode 100644 index 0000000..edd022a --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/ZoneEntity.html @@ -0,0 +1,166 @@ + + + + +Verwendungsweise von Klasse codes.thischwa.cf.model.ZoneEntity (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

Packages, die ZoneEntity verwenden

Package

Beschreibung

The base package of CloudflareDNS-java.

+
+
Verwendungen von ZoneEntity in codes.thischwa.cf
+
Methoden in codes.thischwa.cf, die ZoneEntity zurückgeben
+
+
Modifizierer und Typ
+
Methode
+
Beschreibung
+
ZoneEntity
+
CfDnsClient.zoneInfo(String name)
+
+
Retrieves detailed information about a specific zone by its name.
+
+
+
Methoden in codes.thischwa.cf, die Typen mit Argumenten vom Typ ZoneEntity zurückgeben
+
+
Modifizierer und Typ
+
Methode
+
Beschreibung
+
List<ZoneEntity>
+
CfDnsClient.zoneListAll()
+
+
Retrieves a list of all zones from the Cloudflare API.
+
+
List<ZoneEntity>
+
CfDnsClient.zoneListAll(PagingRequest pagingRequest)
+
+
Retrieves a list of all zones from the Cloudflare API.
+
+
+
Methoden in codes.thischwa.cf mit Parametern vom Typ ZoneEntity
+
+
Modifizierer und Typ
+
Methode
+
Beschreibung
+
RecordEntity
+
CfDnsClient.recordCreate(ZoneEntity zone, + RecordEntity rec)
+
+
Creates a new DNS record in the specified zone using the Cloudflare API.
+
+
boolean
+
CfDnsClient.recordDelete(ZoneEntity zone, + RecordEntity rec)
+
+
Deletes a DNS record of the specified type within a given zone on the Cloudflare API.
+
+
boolean
+
CfDnsClient.recordDelete(ZoneEntity zone, + String id)
+
+
Deletes a DNS record of the specified type within a given zone on the Cloudflare API.
+
+
void
+
CfDnsClient.recordDeleteTypeIfExists(ZoneEntity zone, + String sld, + RecordType type)
+
+
Attempts to delete a DNS record of a specific type for a given zone and second-level domain + (SLD), if it exists.
+
+
RecordEntity
+
CfDnsClient.recordUpdate(ZoneEntity zone, + RecordEntity rec)
+
+
Updates an existing DNS record in a specified Cloudflare zone.
+
+
RecordEntity
+
CfDnsClient.sldInfo(ZoneEntity zone, + String sld, + RecordType type)
+
+
Retrieves detailed information about a specific second-level domain (SLD) record for a given + zone and record type from the Cloudflare API.
+
+
List<RecordEntity>
+
CfDnsClient.sldListAll(ZoneEntity zone, + String sld)
+
+
Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
+
+
List<RecordEntity>
+
CfDnsClient.sldListAll(ZoneEntity zone, + String sld, + PagingRequest pagingRequest)
+
+
Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
+
+
+
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/model/class-use/ZoneMultipleResponse.html b/docs/apidocs/codes/thischwa/cf/model/class-use/ZoneMultipleResponse.html new file mode 100644 index 0000000..4f19ba2 --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/model/class-use/ZoneMultipleResponse.html @@ -0,0 +1,62 @@ + + + + +Verwendungsweise von Klasse codes.thischwa.cf.model.ZoneMultipleResponse (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

+ +Keine Verwendung von codes.thischwa.cf.model.ZoneMultipleResponse

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/model/package-summary.html b/docs/apidocs/codes/thischwa/cf/model/package-summary.html new file mode 100644 index 0000000..2e3518d --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/model/package-summary.html @@ -0,0 +1,165 @@ + + + + +codes.thischwa.cf.model (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

package codes.thischwa.cf.model

The model of CloudflareDNS-java.

+
+
Zugehörige Packages
+
+
Package
+
Beschreibung
+
codes.thischwa.cf
+
+
The base package of CloudflareDNS-java.
+
+
+
+
+
+
+
+
+
Klasse
+
Beschreibung
+
AbstractEntity
+
+
Represents a base abstract entity class for modeling domain objects with a unique identifier.
+
+
AbstractMultipleResponse<T extends ResponseEntity>
+
+
Abstract base class for response models that contain multiple result entries.
+
+
AbstractResponse
+
+
Abstract base class for API response models.
+
+
AbstractSingleResponse<T extends ResponseEntity>
+
+
Represents a base abstract response model for handling single response entities within an API + response.
+
+
PagingRequest
+
+
Represents a request model for paginated data.
+
+
RecordEntity
+
+
Represents a DNS record entity within a specific zone.
+
+
RecordMultipleResponse
+
+
Represents the API response of the Cloudflare API containing multiple DNS record entities.
+
+
RecordSingleResponse
+
+
Represents the API response of the Cloudflare API containing a single DNS record entity.
+
+
RecordType
+
+
Enum representing various DNS record types.
+
+
ResponseEntity
+
+
Represents a contract for entities that have a unique identifier.
+
+
ResultInfo
+
+
Represents metadata for paginated results.
+
+
ZoneEntity
+
+
Represents a DNS zone entity in the Cloudflare DNS system.
+
+
ZoneMultipleResponse
+
+
Represents a response model that contains multiple ZoneEntity instances.
+
+
+
+
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/model/package-tree.html b/docs/apidocs/codes/thischwa/cf/model/package-tree.html new file mode 100644 index 0000000..9579b8c --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/model/package-tree.html @@ -0,0 +1,118 @@ + + + + +codes.thischwa.cf.model Klassenhierarchie (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

+ +Packagehierarchien: +

Alle Packages

Klassenhierarchie

java.lang.Object +
- codes.thischwa.cf.model.AbstractEntity (implements codes.thischwa.cf.model.ResponseEntity) +
  - codes.thischwa.cf.model.RecordEntity
  - codes.thischwa.cf.model.ZoneEntity
  +
- codes.thischwa.cf.model.AbstractResponse +
  - codes.thischwa.cf.model.AbstractMultipleResponse<T> +
    - codes.thischwa.cf.model.RecordMultipleResponse
    - codes.thischwa.cf.model.ZoneMultipleResponse
    +
  - codes.thischwa.cf.model.AbstractSingleResponse<T> +
    - codes.thischwa.cf.model.RecordSingleResponse
    +
  +
- codes.thischwa.cf.model.PagingRequest
- codes.thischwa.cf.model.ResultInfo
+

Schnittstellenhierarchie

codes.thischwa.cf.model.ResponseEntity

Enum-Klassenhierarchie

java.lang.Object +
- java.lang.Enum<E> (implements java.lang.Comparable<T>, java.lang.constant.Constable, java.io.Serializable) +
  - codes.thischwa.cf.model.RecordType
  +
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/model/package-use.html b/docs/apidocs/codes/thischwa/cf/model/package-use.html new file mode 100644 index 0000000..09bb69b --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/model/package-use.html @@ -0,0 +1,146 @@ + + + + +Verwendungsweise von Package codes.thischwa.cf.model (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

Packages, die codes.thischwa.cf.model verwenden

Package

Beschreibung

The base package of CloudflareDNS-java.

The model of CloudflareDNS-java.

+
+
Von codes.thischwa.cf verwendete Klassen in codes.thischwa.cf.model
+
+
Klasse
+
Beschreibung
+
PagingRequest
+
+
Represents a request model for paginated data.
+
+
RecordEntity
+
+
Represents a DNS record entity within a specific zone.
+
+
RecordType
+
+
Enum representing various DNS record types.
+
+
ZoneEntity
+
+
Represents a DNS zone entity in the Cloudflare DNS system.
+
+
+
+
+
+
Von codes.thischwa.cf.model verwendete Klassen in codes.thischwa.cf.model
+
+
Klasse
+
Beschreibung
+
AbstractEntity
+
+
Represents a base abstract entity class for modeling domain objects with a unique identifier.
+
+
AbstractMultipleResponse
+
+
Abstract base class for response models that contain multiple result entries.
+
+
AbstractResponse
+
+
Abstract base class for API response models.
+
+
AbstractSingleResponse
+
+
Represents a base abstract response model for handling single response entities within an API + response.
+
+
PagingRequest
+
+
Represents a request model for paginated data.
+
+
RecordEntity
+
+
Represents a DNS record entity within a specific zone.
+
+
RecordType
+
+
Enum representing various DNS record types.
+
+
ResponseEntity
+
+
Represents a contract for entities that have a unique identifier.
+
+
+
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/package-summary.html b/docs/apidocs/codes/thischwa/cf/package-summary.html new file mode 100644 index 0000000..f3f5ece --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/package-summary.html @@ -0,0 +1,130 @@ + + + + +codes.thischwa.cf (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

package codes.thischwa.cf

The base package of CloudflareDNS-java.

+
+
Zugehörige Packages
+
+
Package
+
Beschreibung
+
codes.thischwa.cf.model
+
+
The model of CloudflareDNS-java.
+
+
+
+
+
+
+
+
+
Klasse
+
Beschreibung
+
CfDnsClient
+
+
CfDnsClient is a client interface to interact with Cloudflare DNS service.
+
+
CfRequest
+
+
Enum CfRequest encapsulates various API endpoint paths for managing DNS zones and records in a + cohesive and reusable manner.
+
+
CloudflareApiException
+
+
Represents a custom exception for errors encountered while interacting with the Cloudflare API.
+
+
CloudflareNotFoundException
+
+
This exception is thrown to indicate that a requested resource was not found during interaction + with the Cloudflare API.
+
+
+
+
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/package-tree.html b/docs/apidocs/codes/thischwa/cf/package-tree.html new file mode 100644 index 0000000..bd4e346 --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/package-tree.html @@ -0,0 +1,103 @@ + + + + +codes.thischwa.cf Klassenhierarchie (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

+ +Packagehierarchien: +

Alle Packages

Klassenhierarchie

java.lang.Object +
- codes.thischwa.cf.CfDnsClient
- java.lang.Throwable (implements java.io.Serializable) +
  - java.lang.Exception +
    - codes.thischwa.cf.CloudflareApiException +
      - codes.thischwa.cf.CloudflareNotFoundException
      +
    +
  +
+

Enum-Klassenhierarchie

java.lang.Object +
- java.lang.Enum<E> (implements java.lang.Comparable<T>, java.lang.constant.Constable, java.io.Serializable) +
  - codes.thischwa.cf.CfRequest
  +
+

+ +

+ + diff --git a/docs/apidocs/codes/thischwa/cf/package-use.html b/docs/apidocs/codes/thischwa/cf/package-use.html new file mode 100644 index 0000000..8c9fd10 --- /dev/null +++ b/docs/apidocs/codes/thischwa/cf/package-use.html @@ -0,0 +1,93 @@ + + + + +Verwendungsweise von Package codes.thischwa.cf (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

Packages, die codes.thischwa.cf verwenden

Package

Beschreibung

The base package of CloudflareDNS-java.

+
+
Von codes.thischwa.cf verwendete Klassen in codes.thischwa.cf
+
+
Klasse
+
Beschreibung
+
CfRequest
+
+
Enum CfRequest encapsulates various API endpoint paths for managing DNS zones and records in a + cohesive and reusable manner.
+
+
CloudflareApiException
+
+
Represents a custom exception for errors encountered while interacting with the Cloudflare API.
+
+
+
+

+ +

+ + diff --git a/docs/apidocs/copy.svg b/docs/apidocs/copy.svg new file mode 100644 index 0000000..7c46ab1 --- /dev/null +++ b/docs/apidocs/copy.svg @@ -0,0 +1,33 @@ + + + + + diff --git a/docs/apidocs/element-list b/docs/apidocs/element-list new file mode 100644 index 0000000..9decf90 --- /dev/null +++ b/docs/apidocs/element-list @@ -0,0 +1,2 @@ +codes.thischwa.cf +codes.thischwa.cf.model diff --git a/docs/apidocs/help-doc.html b/docs/apidocs/help-doc.html new file mode 100644 index 0000000..988e7d0 --- /dev/null +++ b/docs/apidocs/help-doc.html @@ -0,0 +1,198 @@ + + + + +API-Hilfe (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

Hilfe zu JavaDoc

Navigation: +
- Suchen
+
Seitenarten: +
- Überblick
- Package
- Klasse oder Schnittstelle
- Weitere Dateien
- Verwendung
- Baum (Klassenhierarchie)
- Serialisierte Form
- Alle Packages
- Alle Klassen und Schnittstellen
- Index
+

+ +Ausgehend von der Seite Überblick können Sie die Dokumentation mithilfe der Links durchsuchen, die sich auf jeder Seite und in der Navigationsleiste oben auf jeder Seite befinden. Mit Index und dem Suchfeld können Sie zu spezifischen Deklarationen und Übersichtsseiten navigieren, wie Alle Packages, Alle Klassen und Schnittstellen +

Suchen

Sie können nach Definitionen von Modulen, Packages, Typen, Feldern, Methoden, Systemeigenschaften und anderen Begriffen suchen, die in der API definiert sind. Dazu können Sie den Namen ganz oder teilweise oder optional auch Abkürzungen mit Binnenmajuskeln ("camelCase") eingeben. Sie können auch mehrere durch Leerzeichen getrennte Suchbegriffe angeben. Beispiele:

"j.l.obj" stimmt mit "java.lang.Object" überein
"InpStr" stimmt mit "java.io.InputStream" überein
"math exact long" stimmt mit "java.lang.Math.absExact(long)" überein

Eine vollständige Beschreibung der Suchfeatures finden Sie in der Javadoc-Suchspezifikation.

Seitenarten

+Die folgenden Abschnitte beschreiben die verschiedenen Seitenarten in dieser Collection. +

Überblick

Die Seite Überblick ist die Titelseite dieses API-Dokuments und enthält eine Liste aller Packages mit einer Übersicht für jedes Packages. Diese Seite kann auch eine Gesamtbeschreibung des Packagesets enthalten.

Package

Für jedes Package ist eine Seite vorhanden, die eine Liste der Klassen und Schnittstellen mit jeweils einer Übersicht dafür enthält. Diese Seiten können die folgenden Kategorien enthalten:

Schnittstellen
Klassen
Enum-Klassen
Ausnahmeklassen
Annotationsschnittstellen

Klasse oder Schnittstelle

Für jede Klasse, Schnittstelle, verschachtelte Klasse und verschachtelte Schnittstelle ist eine separate Seite vorhanden. Jede dieser Seiten enthält drei Abschnitte, die aus einer Deklaration und Beschreibung, Mitgliederübersichtstabellen und detaillierten Mitgliederbeschreibungen bestehen. Die Einträge in diesen Abschnitten werden weggelassen, wenn sie leer oder nicht anwendbar sind.

Klassenvererbungsdiagramm
Direkte Unterklassen
Alle bekannten Unterschnittstellen
Alle bekannten Implementierungsklassen
Klassen- oder Schnittstellendeklaration
Klassen- oder Schnittstellenbeschreibung

+
+

Verschachtelte Klassen - Übersicht
Enum-Konstanten - Übersicht
Feldübersicht
Eigenschaftsübersicht
Konstruktorübersicht
Methodenübersicht
Erforderliche Elemente - Übersicht
Optionale Elemente - Übersicht

+
+

Enum-Konstanten - Details
Felddetails
Eigenschaftsdetails
Konstruktordetails
Methodendetails
Elementdetails

Hinweis: Annotationsschnittstellen haben erforderliche und optionale Elemente, aber nicht Methoden. Nur Enum-Klassen haben Enum-Konstanten. Die Komponenten einer Datensatzklasse werden als Teil der Deklaration der Datensatzklasse angezeigt. Eigenschaften sind ein Feature von JavaFX.

Die Übersichtseinträge sind alphabetisch geordnet, während die detaillierten Beschreibungen in der Reihenfolge aufgeführt werden, in der sie im Quellcode auftreten. So werden die vom Programmierer festgelegten logischen Gruppierungen beibehalten.

Weitere Dateien

Packages und Module können Seiten mit weiteren Informationen zu den Deklarationen in der Nähe enthalten.

Verwendung

Für jedes dokumentierte Package sowie jede Klasse und jede Schnittstelle ist eine eigene Verwendungsseite vorhanden. Auf dieser Seite wird beschrieben, welche Packages, Klassen, Methoden, Konstruktoren und Felder einen Teil der angegebenen Klasse oder des angegebenen Packages verwenden. Bei der Klasse oder Schnittstelle A enthält die Verwendungsseite die Unterklassen von A, als A deklarierte Felder, Methoden, die A zurückgeben, sowie Methoden und Konstruktoren mit Parametern des Typs A. Sie können diese Seite aufrufen, indem Sie zunächst das Package, die Klasse oder die Schnittstelle aufrufen und anschließend in der Navigationsleiste auf den Link "Verwendung" klicken.

Baum (Klassenhierarchie)

Es gibt eine Seite Klassenhierarchie für alle Packages, und für jedes Package gibt es eine Hierarchie. Jede Hierarchieseite enthält eine Klassen- und eine Schnittstellenliste. Die Klassen sind nach Vererbungsstruktur organisiert, beginnend mit java.lang.Object. Die Schnittstellen erben nicht von java.lang.Object.

Wenn Sie auf der Übersichtsseite auf "Baum" klicken, wird die Hierarchie für alle Packages angezeigt.
Wenn Sie eine bestimmte Package-, Klassen- oder Schnittstellenseite anzeigen und auf "Baum" klicken, wird die Hierarchie nur für dieses Package angezeigt.

Serialisierte Form

Jede serialisierbare oder externalisierbare Klasse verfügt über eine Beschreibung der zugehörigen Serialisierungsfelder und -methoden. Diese Informationen sind eher für Implementierer als für Benutzer der API von Interesse. Die Navigationsleiste enthält zwar keinen Link, Sie können diese Informationen jedoch abrufen, indem Sie zu einer beliebigen serialisierten Klasse navigieren und im Abschnitt "Siehe auch" der Klassenbeschreibung auf "Serialisierte Form" klicken.

Alle Packages

Die Seite Alle Packages enthält einen alphabetischen Index aller Packages, die in der Dokumentation enthalten sind.

Alle Klassen und Schnittstellen

Die Seite Alle Klassen und Schnittstellen enthält einen alphabetischen Index aller Klassen und Schnittstellen in der Dokumentation, einschließlich Annotationsschnittstellen, Enum-Klassen und Datensatzklassen.

Index

Die Index enthält einen alphabetischen Index aller Klassen, Schnittstellen, Konstruktoren, Methoden und Felder in der Dokumentation sowie Übersichtsseiten wie Alle Packages, Alle Klassen und Schnittstellen.

+Diese Hilfedatei gilt für die vom Standard-Doclet generierte API-Dokumentation.

+ +

+ + diff --git a/docs/apidocs/index-all.html b/docs/apidocs/index-all.html new file mode 100644 index 0000000..40d0952 --- /dev/null +++ b/docs/apidocs/index-all.html @@ -0,0 +1,417 @@ + + + + +Index (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

+ +A B C D G H L M N O P R S T U V Z
Alle Klassen und Schnittstellen|Alle Packages|Serialisierte Form +

A

A - Enum-Konstante in Enum-Klasse codes.thischwa.cf.model.RecordType
AAAA - Enum-Konstante in Enum-Klasse codes.thischwa.cf.model.RecordType
AbstractEntity - Klasse in codes.thischwa.cf.model: +
Represents a base abstract entity class for modeling domain objects with a unique identifier.
+
AbstractEntity() - Konstruktor für Klasse codes.thischwa.cf.model.AbstractEntity
AbstractMultipleResponse<T> - Klasse in codes.thischwa.cf.model: +
Abstract base class for response models that contain multiple result entries.
+
AbstractMultipleResponse() - Konstruktor für Klasse codes.thischwa.cf.model.AbstractMultipleResponse
AbstractResponse - Klasse in codes.thischwa.cf.model: +
Abstract base class for API response models.
+
AbstractResponse() - Konstruktor für Klasse codes.thischwa.cf.model.AbstractResponse
AbstractSingleResponse<T> - Klasse in codes.thischwa.cf.model: +
Represents a base abstract response model for handling single response entities within an API + response.
+
AbstractSingleResponse() - Konstruktor für Klasse codes.thischwa.cf.model.AbstractSingleResponse
addQueryString(String) - Methode in Klasse codes.thischwa.cf.model.PagingRequest: +
Appends a query string with pagination parameters (page and perPage) to the provided endpoint.
+

B

build(String, RecordType, Integer, String) - Statische Methode in Klasse codes.thischwa.cf.model.RecordEntity: +
Builds and returns a RecordEntity instance with the specified attributes.
+

C

CAA - Enum-Konstante in Enum-Klasse codes.thischwa.cf.model.RecordType
CERT - Enum-Konstante in Enum-Klasse codes.thischwa.cf.model.RecordType
CfDnsClient - Klasse in codes.thischwa.cf: +
CfDnsClient is a client interface to interact with Cloudflare DNS service.
+
CfDnsClient(boolean, String, String, String, String) - Konstruktor für Klasse codes.thischwa.cf.CfDnsClient: +
Constructs a new instance of CfDnsClient, which facilitates interactions with the + Cloudflare DNS API.
+
CfDnsClient(String, String, String) - Konstruktor für Klasse codes.thischwa.cf.CfDnsClient: +
Constructs a CfDnsClient instance for interacting with the Cloudflare DNS API.
+
CfDnsClient(String, String, String, String) - Konstruktor für Klasse codes.thischwa.cf.CfDnsClient: +
Constructs a CfDnsClient instance for interacting with the Cloudflare DNS API.
+
CfRequest - Enum-Klasse in codes.thischwa.cf: +
Enum CfRequest encapsulates various API endpoint paths for managing DNS zones and records in a + cohesive and reusable manner.
+
CloudflareApiException - Ausnahmeklasse in codes.thischwa.cf: +
Represents a custom exception for errors encountered while interacting with the Cloudflare API.
+
CloudflareApiException(String) - Konstruktor für Ausnahmeklasse codes.thischwa.cf.CloudflareApiException: +
Constructs a new CloudflareApiException with the specified detail message.
+
CloudflareApiException(String, Throwable) - Konstruktor für Ausnahmeklasse codes.thischwa.cf.CloudflareApiException: +
Constructs a new CloudflareApiException with the specified detail message and cause.
+
CloudflareApiException(Throwable) - Konstruktor für Ausnahmeklasse codes.thischwa.cf.CloudflareApiException: +
Constructs a new CloudflareApiException with the specified cause.
+
CloudflareNotFoundException - Ausnahmeklasse in codes.thischwa.cf: +
This exception is thrown to indicate that a requested resource was not found during interaction + with the Cloudflare API.
+
CloudflareNotFoundException(String) - Konstruktor für Ausnahmeklasse codes.thischwa.cf.CloudflareNotFoundException: +
Constructs a new CloudflareNotFoundException with the specified detail message.
+
CloudflareNotFoundException(String, Throwable) - Konstruktor für Ausnahmeklasse codes.thischwa.cf.CloudflareNotFoundException: +
Constructs a new CloudflareNotFoundException with the specified detail message and cause.
+
CloudflareNotFoundException(Throwable) - Konstruktor für Ausnahmeklasse codes.thischwa.cf.CloudflareNotFoundException: +
Constructs a new CloudflareNotFoundException with the specified cause.
+
CNAME - Enum-Konstante in Enum-Klasse codes.thischwa.cf.model.RecordType
codes.thischwa.cf - Package codes.thischwa.cf: +
The base package of CloudflareDNS-java.
+
codes.thischwa.cf.model - Package codes.thischwa.cf.model: +
The model of CloudflareDNS-java.
+

D

defaultPaging() - Statische Methode in Klasse codes.thischwa.cf.model.PagingRequest: +
Creates a default PagingRequest instance with a page number set to 1 and a high number + of items per page (5,000,000) to accommodate large dataset requests.
+
deleteRequest(String, Class<T>) - Methode in Klasse codes.thischwa.cf.CfDnsClient: +
Sends a DELETE request to the given endpoint and maps the response.
+
DNSKEY - Enum-Konstante in Enum-Klasse codes.thischwa.cf.model.RecordType
DS - Enum-Konstante in Enum-Klasse codes.thischwa.cf.model.RecordType

G

getId() - Methode in Schnittstelle codes.thischwa.cf.model.ResponseEntity: +
Retrieves the unique identifier of the entity.
+
getPagingParams() - Methode in Klasse codes.thischwa.cf.model.PagingRequest: +
Retrieves the pagination parameters in a key-value map format.
+
getRequest(String, Class<T>) - Methode in Klasse codes.thischwa.cf.CfDnsClient: +
Sends a GET request to the given endpoint and maps the response.
+

H

HTTPS - Enum-Konstante in Enum-Klasse codes.thischwa.cf.model.RecordType

L

LOC - Enum-Konstante in Enum-Klasse codes.thischwa.cf.model.RecordType

M

MX - Enum-Konstante in Enum-Klasse codes.thischwa.cf.model.RecordType

N

NAPTR - Enum-Konstante in Enum-Klasse codes.thischwa.cf.model.RecordType
NS - Enum-Konstante in Enum-Klasse codes.thischwa.cf.model.RecordType

O

of(int, int) - Statische Methode in Klasse codes.thischwa.cf.model.PagingRequest: +
Creates a new PagingRequest instance with the specified page number and items per page.
+
OPENPGPKEY - Enum-Konstante in Enum-Klasse codes.thischwa.cf.model.RecordType

P

PagingRequest - Klasse in codes.thischwa.cf.model: +
Represents a request model for paginated data.
+
patchRequest(String, R, Class<T>) - Methode in Klasse codes.thischwa.cf.CfDnsClient: +
Sends a PATCH request with a payload to the given endpoint and maps the response.
+
postRequest(String, R, Class<T>) - Methode in Klasse codes.thischwa.cf.CfDnsClient: +
Sends a POST request with a payload to the given endpoint and maps the response.
+
PTR - Enum-Konstante in Enum-Klasse codes.thischwa.cf.model.RecordType
putRequest(String, R, Class<T>) - Methode in Klasse codes.thischwa.cf.CfDnsClient: +
Sends a PUT request with a payload to the given endpoint and maps the response.
+

R

RECORD_CREATE - Enum-Konstante in Enum-Klasse codes.thischwa.cf.CfRequest
RECORD_DELETE - Enum-Konstante in Enum-Klasse codes.thischwa.cf.CfRequest
RECORD_INFO_NAME - Enum-Konstante in Enum-Klasse codes.thischwa.cf.CfRequest
RECORD_INFO_NAME_TYPE - Enum-Konstante in Enum-Klasse codes.thischwa.cf.CfRequest
RECORD_UPDATE - Enum-Konstante in Enum-Klasse codes.thischwa.cf.CfRequest
recordCreate(ZoneEntity, RecordEntity) - Methode in Klasse codes.thischwa.cf.CfDnsClient: +
Creates a new DNS record in the specified zone using the Cloudflare API.
+
recordDelete(ZoneEntity, RecordEntity) - Methode in Klasse codes.thischwa.cf.CfDnsClient: +
Deletes a DNS record of the specified type within a given zone on the Cloudflare API.
+
recordDelete(ZoneEntity, String) - Methode in Klasse codes.thischwa.cf.CfDnsClient: +
Deletes a DNS record of the specified type within a given zone on the Cloudflare API.
+
recordDeleteTypeIfExists(ZoneEntity, String, RecordType) - Methode in Klasse codes.thischwa.cf.CfDnsClient: +
Attempts to delete a DNS record of a specific type for a given zone and second-level domain + (SLD), if it exists.
+
RecordEntity - Klasse in codes.thischwa.cf.model: +
Represents a DNS record entity within a specific zone.
+
RecordEntity() - Konstruktor für Klasse codes.thischwa.cf.model.RecordEntity
RecordMultipleResponse - Klasse in codes.thischwa.cf.model: +
Represents the API response of the Cloudflare API containing multiple DNS record entities.
+
RecordMultipleResponse() - Konstruktor für Klasse codes.thischwa.cf.model.RecordMultipleResponse
RecordSingleResponse - Klasse in codes.thischwa.cf.model: +
Represents the API response of the Cloudflare API containing a single DNS record entity.
+
RecordSingleResponse() - Konstruktor für Klasse codes.thischwa.cf.model.RecordSingleResponse
RecordType - Enum-Klasse in codes.thischwa.cf.model: +
Enum representing various DNS record types.
+
recordUpdate(ZoneEntity, RecordEntity) - Methode in Klasse codes.thischwa.cf.CfDnsClient: +
Updates an existing DNS record in a specified Cloudflare zone.
+
ResponseEntity - Schnittstelle in codes.thischwa.cf.model: +
Represents a contract for entities that have a unique identifier.
+
ResultInfo - Klasse in codes.thischwa.cf.model: +
Represents metadata for paginated results.
+
ResultInfo() - Konstruktor für Klasse codes.thischwa.cf.model.ResultInfo

S

sldInfo(ZoneEntity, String, RecordType) - Methode in Klasse codes.thischwa.cf.CfDnsClient: +
Retrieves detailed information about a specific second-level domain (SLD) record for a given + zone and record type from the Cloudflare API.
+
sldListAll(ZoneEntity, String) - Methode in Klasse codes.thischwa.cf.CfDnsClient: +
Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
+
sldListAll(ZoneEntity, String, PagingRequest) - Methode in Klasse codes.thischwa.cf.CfDnsClient: +
Retrieves all record entities for a specific second-level domain (SLD) within a given DNS zone.
+
SMIMEA - Enum-Konstante in Enum-Klasse codes.thischwa.cf.model.RecordType
SRV - Enum-Konstante in Enum-Klasse codes.thischwa.cf.model.RecordType
SSHFP - Enum-Konstante in Enum-Klasse codes.thischwa.cf.model.RecordType
SVCB - Enum-Konstante in Enum-Klasse codes.thischwa.cf.model.RecordType

T

TLSA - Enum-Konstante in Enum-Klasse codes.thischwa.cf.model.RecordType
toString() - Methode in Enum-Klasse codes.thischwa.cf.model.RecordType
TXT - Enum-Konstante in Enum-Klasse codes.thischwa.cf.model.RecordType

U

URI - Enum-Konstante in Enum-Klasse codes.thischwa.cf.model.RecordType

V

valueOf(String) - Statische Methode in Enum-Klasse codes.thischwa.cf.CfRequest: +
Gibt die Enum-Konstante dieser Klasse mit dem angegebenen Namen zurück.
+
valueOf(String) - Statische Methode in Enum-Klasse codes.thischwa.cf.model.RecordType: +
Gibt die Enum-Konstante dieser Klasse mit dem angegebenen Namen zurück.
+
values() - Statische Methode in Enum-Klasse codes.thischwa.cf.CfRequest: +
Gibt ein Array mit den Konstanten dieser Enum-Klasse in +der Reihenfolge ihrer Deklaration zurück.
+
values() - Statische Methode in Enum-Klasse codes.thischwa.cf.model.RecordType: +
Gibt ein Array mit den Konstanten dieser Enum-Klasse in +der Reihenfolge ihrer Deklaration zurück.
+

Z

ZONE_INFO - Enum-Konstante in Enum-Klasse codes.thischwa.cf.CfRequest
ZONE_LIST - Enum-Konstante in Enum-Klasse codes.thischwa.cf.CfRequest
ZoneEntity - Klasse in codes.thischwa.cf.model: +
Represents a DNS zone entity in the Cloudflare DNS system.
+
ZoneEntity() - Konstruktor für Klasse codes.thischwa.cf.model.ZoneEntity
zoneInfo(String) - Methode in Klasse codes.thischwa.cf.CfDnsClient: +
Retrieves detailed information about a specific zone by its name.
+
zoneListAll() - Methode in Klasse codes.thischwa.cf.CfDnsClient: +
Retrieves a list of all zones from the Cloudflare API.
+
zoneListAll(PagingRequest) - Methode in Klasse codes.thischwa.cf.CfDnsClient: +
Retrieves a list of all zones from the Cloudflare API.
+
ZoneMultipleResponse - Klasse in codes.thischwa.cf.model: +
Represents a response model that contains multiple ZoneEntity instances.
+
ZoneMultipleResponse() - Konstruktor für Klasse codes.thischwa.cf.model.ZoneMultipleResponse

+A B C D G H L M N O P R S T U V Z
Alle Klassen und Schnittstellen|Alle Packages|Serialisierte Form

+ +

+ + diff --git a/docs/apidocs/index.html b/docs/apidocs/index.html new file mode 100644 index 0000000..7637f7d --- /dev/null +++ b/docs/apidocs/index.html @@ -0,0 +1,77 @@ + + + + +Überblick (CloudflareDNS-java 0.1.0-SNAPSHOT API) + + + + + + + + + + + + + + +

+ +

Packages

Package

Beschreibung

The base package of CloudflareDNS-java.