Package codes.thischwa.cf

Enum Class CfRequest

java.lang.Object
java.lang.Enum<CfRequest>
codes.thischwa.cf.CfRequest
All Implemented Interfaces:
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.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    RECORD_CREATE
    Represents the API endpoint path for creating a new DNS record within a specific DNS zone.
    RECORD_DELETE
    Represents the API endpoint path for deleting an existing DNS record within a specific DNS zone.
    RECORD_INFO_NAME
    Represents the API endpoint path for retrieving information about a DNS record within a specific DNS zone by its name.
    RECORD_INFO_NAME_TYPE
    Represents the API endpoint path for retrieving information about a DNS record within a specific DNS zone by its name and type.
    RECORD_UPDATE
    Represents the API endpoint path for updating an existing DNS record within a specific DNS zone.
    ZONE_INFO
    Represents the API endpoint path for retrieving information about a specific DNS zone by its name.
    ZONE_LIST
    Represents the API endpoint path for retrieving the list of DNS zones.

  • Method Summary

    Modifier and Type
    Method
    Description
    static CfRequest
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static CfRequest[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • ZONE_LIST

      public static final CfRequest ZONE_LIST
      Represents the API endpoint path for retrieving the list of DNS zones.

    • ZONE_INFO

      public static final CfRequest ZONE_INFO
      Represents the API endpoint path for retrieving information about a specific DNS zone by its name. The endpoint path supports a placeholder for the zone name, which needs to be provided to construct the complete path.

    • RECORD_CREATE

      public static final CfRequest RECORD_CREATE
      Represents the API endpoint path for creating a new DNS record within a specific DNS zone. The endpoint path includes a placeholder for the zone identifier, which needs to be provided to construct the complete path.

    • RECORD_INFO_NAME

      public static final CfRequest RECORD_INFO_NAME
      Represents the API endpoint path for retrieving information about a DNS record within a specific DNS zone by its name. The endpoint path includes placeholders for the zone identifier and the record name, which need to be provided to construct the complete path.

    • RECORD_INFO_NAME_TYPE

      public static final CfRequest RECORD_INFO_NAME_TYPE
      Represents the API endpoint path for retrieving information about a DNS record within a specific DNS zone by its name and type. The endpoint path includes placeholders for the zone identifier, record name, and record type, which need to be provided to construct the complete path.

    • RECORD_UPDATE

      public static final CfRequest RECORD_UPDATE
      Represents the API endpoint path for updating an existing DNS record within a specific DNS zone. The endpoint path includes placeholders for the zone identifier and the record identifier, which need to be provided to construct the complete path.

    • RECORD_DELETE

      public static final CfRequest RECORD_DELETE
      Represents the API endpoint path for deleting an existing DNS record within a specific DNS zone. The endpoint path includes placeholders for the zone identifier and the record identifier, which need to be provided to construct the complete path.

  • Method Details

    • values

      public static CfRequest[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static CfRequest valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null