Package com.dnsimple.endpoints

Class Zones

java.lang.Object

com.dnsimple.endpoints.Zones

public class Zones
extends Object

Provides access to the DNSimple Zones API.

See Also:

• https://developer.dnsimple.com/v2/zones

Constructor Summary

Constructors

Constructor	Description
Zones(HttpEndpointClient client)

Method Summary

Modifier and Type	Method	Description
SimpleResponse<Zone>	activateDns(Number account, String zoneName)	Activate DNS resolution for the zone in the account.
SimpleResponse<ZoneDistribution>	checkZoneDistribution(Number account, String zone)	Checks if a zone change is fully distributed to all our nameservers across the globe.
SimpleResponse<ZoneDistribution>	checkZoneRecordDistribution(Number account, String zone, Number record)	Checks if a zone record change is fully distributed to all our nameservers of our regions.
SimpleResponse<ZoneRecord>	createZoneRecord(Number account, String zone, ZoneRecordOptions options)	Create a record in a zone.
SimpleResponse<Zone>	deactivateDns(Number account, String zoneName)	Deactivate DNS resolution for the zone in the account.
EmptyResponse	deleteZoneRecord(Number account, String zone, Number record)	Delete a record from a zone.
SimpleResponse<Zone>	getZone(Number account, String zone)	Get a specific zone associated to an account using the zone's name or ID.
SimpleResponse<ZoneFile>	getZoneFile(Number account, String zone)	Get the zone file associated to an account using the zone's name or ID.
SimpleResponse<ZoneRecord>	getZoneRecord(Number account, String zone, Number record)	Get a specific record associated to a zone using the zone's name or ID.
PaginatedResponse<ZoneRecord>	listZoneRecords(Number account, String zone)	Lists the records in the zone.
PaginatedResponse<ZoneRecord>	listZoneRecords(Number account, String zone, ListOptions options)	Lists the records in the zone.
PaginatedResponse<Zone>	listZones(Number account)	Lists the zones in the account.
PaginatedResponse<Zone>	listZones(Number account, ListOptions options)	Lists the zones in the account.
SimpleResponse<ZoneRecord>	updateZoneRecord(Number account, String zone, Number record, ZoneRecordUpdateOptions options)	Update a record in a zone.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Zones

public Zones(HttpEndpointClient client)

Method Details

activateDns

public SimpleResponse<Zone> activateDns(Number account,
 String zoneName)

Activate DNS resolution for the zone in the account.

Parameters:

account - The account ID

zoneName - The zone name

Returns:

The zone

See Also:

• https://developer.dnsimple.com/v2/zones/#activateZoneService

deactivateDns

public SimpleResponse<Zone> deactivateDns(Number account,
 String zoneName)

Deactivate DNS resolution for the zone in the account.

Parameters:

account - The account ID

zoneName - The zone name

Returns:

The zone

See Also:

• https://developer.dnsimple.com/v2/zones/#deactivateZoneService

listZones

public PaginatedResponse<Zone> listZones(Number account)

Lists the zones in the account.

Parameters:

account - The account ID

Returns:

The list zones response

See Also:

• https://developer.dnsimple.com/v2/zones/#listZones

listZones

public PaginatedResponse<Zone> listZones(Number account,
 ListOptions options)

Lists the zones in the account.

Parameters:

account - The account ID

options - The options for the list request

Returns:

The list zones response

See Also:

• https://developer.dnsimple.com/v2/zones/#listZones

getZone

public SimpleResponse<Zone> getZone(Number account,
 String zone)

Get a specific zone associated to an account using the zone's name or ID.

Parameters:

account - The account ID

zone - The zone name

Returns:

The get zone response

See Also:

• https://developer.dnsimple.com/v2/zones/#getZone

getZoneFile

public SimpleResponse<ZoneFile> getZoneFile(Number account,
 String zone)

Get the zone file associated to an account using the zone's name or ID.

Parameters:

account - The account ID

zone - The zone name

Returns:

The get zone file response

See Also:

• https://developer.dnsimple.com/v2/zones/#getZoneFile

checkZoneDistribution

public SimpleResponse<ZoneDistribution> checkZoneDistribution(Number account,
 String zone)

Checks if a zone change is fully distributed to all our nameservers across the globe.

Parameters:

account - The account ID

zone - The zone name

Returns:

The result of the check

See Also:

• https://developer.dnsimple.com/v2/zones/#checkZoneDistribution

listZoneRecords

public PaginatedResponse<ZoneRecord> listZoneRecords(Number account,
 String zone)

Lists the records in the zone.

Parameters:

account - The account ID

zone - The zone name

Returns:

The list zone records response

See Also:

• https://developer.dnsimple.com/v2/zones/records/#listZoneRecords

listZoneRecords

public PaginatedResponse<ZoneRecord> listZoneRecords(Number account,
 String zone,
 ListOptions options)

Lists the records in the zone.

Parameters:

account - The account ID

zone - The zone name

options - The options for the list request

Returns:

The list zone records response

See Also:

• https://developer.dnsimple.com/v2/zones/records/#listZoneRecords

createZoneRecord

public SimpleResponse<ZoneRecord> createZoneRecord(Number account,
 String zone,
 ZoneRecordOptions options)

Create a record in a zone.

Parameters:

account - The account ID

zone - The zone name

options - Options for the Zone record

Returns:

The create zone record response

See Also:

• https://developer.dnsimple.com/v2/zones/records/#createZoneRecord

getZoneRecord

public SimpleResponse<ZoneRecord> getZoneRecord(Number account,
 String zone,
 Number record)

Get a specific record associated to a zone using the zone's name or ID.

Parameters:

account - The account ID

zone - The zone name

record - The zone record ID

Returns:

The get zone record response

See Also:

• https://developer.dnsimple.com/v2/zones/records/#getZoneRecord

updateZoneRecord

public SimpleResponse<ZoneRecord> updateZoneRecord(Number account,
 String zone,
 Number record,
 ZoneRecordUpdateOptions options)

Update a record in a zone.

Parameters:

account - The account ID

zone - The zone name

record - The zone record ID

options - The options to update the Zone record

Returns:

The update zone record response

See Also:

• https://developer.dnsimple.com/v2/zones/records/#updateZoneRecord

deleteZoneRecord

public EmptyResponse deleteZoneRecord(Number account,
 String zone,
 Number record)

Delete a record from a zone.

Parameters:

account - The account ID

zone - The zone name

record - The zone record ID

Returns:

The delete zone record response

See Also:

• https://developer.dnsimple.com/v2/zones/records/#deleteZoneRecord

checkZoneRecordDistribution

public SimpleResponse<ZoneDistribution> checkZoneRecordDistribution(Number account,
 String zone,
 Number record)

Checks if a zone record change is fully distributed to all our nameservers of our regions.

Parameters:

account - The account ID

zone - The zone name

record - The zone record ID

Returns:

The result of the check

See Also:

• https://developer.dnsimple.com/v2/zones/#checkZoneRecordDistribution