com.dnsimple

Interface Zones

All Known Implementing Classes:

ZonesEndpoint

public interface Zones

Provides access to the DNSimple Zones API.

See Also:

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

Method Summary

Modifier and Type	Method and Description
CreateZoneRecordResponse	createZoneRecord(String accountId, String zoneId, Map<String,Object> attributes) Create a record in a zone.
DeleteZoneRecordResponse	deleteZoneRecord(String accountId, String zoneId, String recordId) Delete a record from a zone.
GetZoneResponse	getZone(String accountId, String zoneId) Get a specific zone associated to an account using the zone's name or ID.
GetZoneFileResponse	getZoneFile(String accountId, String zoneId) Get the zone file associated to an account using the zone's name or ID.
GetZoneRecordResponse	getZoneRecord(String accountId, String zoneId, String recordId) Get a specific record associated to a zone using the zone's name or ID.
ListZoneRecordsResponse	listZoneRecords(String accountId, String zoneId) Lists the records in the zone.
ListZoneRecordsResponse	listZoneRecords(String accountId, String zoneId, Map<String,Object> options) Lists the records in the zone.
ListZonesResponse	listZones(String accountId) Lists the zones in the account.
ListZonesResponse	listZones(String accountId, Map<String,Object> options) Lists the zones in the account.
UpdateZoneRecordResponse	updateZoneRecord(String accountId, String zoneId, String recordId, Map<String,Object> attributes) Update a record in a zone.

Method Detail

listZones

ListZonesResponse listZones(String accountId)
                     throws DnsimpleException,
                            IOException

Lists the zones in the account.

Parameters:

accountId - The account ID

Returns:

The list zones response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/zones/#list

listZones

ListZonesResponse listZones(String accountId,
                            Map<String,Object> options)
                     throws DnsimpleException,
                            IOException

Lists the zones in the account.

Parameters:

accountId - The account ID

options - A Map of options to pass to the zones API

Returns:

The list zones response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/zones/#list

getZone

GetZoneResponse getZone(String accountId,
                        String zoneId)
                 throws DnsimpleException,
                        IOException

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

Parameters:

accountId - The account ID

zoneId - The zone name or ID

Returns:

The get zone response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/zones/#get

getZoneFile

GetZoneFileResponse getZoneFile(String accountId,
                                String zoneId)
                         throws DnsimpleException,
                                IOException

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

Parameters:

accountId - The account ID

zoneId - The zone name or ID

Returns:

The get zone file response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/zones/#get-file

listZoneRecords

ListZoneRecordsResponse listZoneRecords(String accountId,
                                        String zoneId)
                                 throws DnsimpleException,
                                        IOException

Lists the records in the zone.

Parameters:

accountId - The account ID

zoneId - The zone name or ID

Returns:

The list zone records response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/zones/records/#list

listZoneRecords

ListZoneRecordsResponse listZoneRecords(String accountId,
                                        String zoneId,
                                        Map<String,Object> options)
                                 throws DnsimpleException,
                                        IOException

Lists the records in the zone.

Parameters:

accountId - The account ID

zoneId - The zone name or ID

options - A Map of options to pass to the zones API

Returns:

The list zone records response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/zones/records/#list

getZoneRecord

GetZoneRecordResponse getZoneRecord(String accountId,
                                    String zoneId,
                                    String recordId)
                             throws DnsimpleException,
                                    IOException

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

Parameters:

accountId - The account ID

zoneId - The zone name or ID

recordId - The zone record ID

Returns:

The get zone record response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/zones/records/#get

createZoneRecord

CreateZoneRecordResponse createZoneRecord(String accountId,
                                          String zoneId,
                                          Map<String,Object> attributes)
                                   throws DnsimpleException,
                                          IOException

Create a record in a zone.

Parameters:

accountId - The account ID

zoneId - The zone name or ID

attributes - The zone attributes

Returns:

The create zone record response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/zones/records/#create

updateZoneRecord

UpdateZoneRecordResponse updateZoneRecord(String accountId,
                                          String zoneId,
                                          String recordId,
                                          Map<String,Object> attributes)
                                   throws DnsimpleException,
                                          IOException

Update a record in a zone.

Parameters:

accountId - The account ID

zoneId - The zone name or ID

recordId - The zone record ID

attributes - The zone attributes

Returns:

The update zone record response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/zones/records/#update

deleteZoneRecord

DeleteZoneRecordResponse deleteZoneRecord(String accountId,
                                          String zoneId,
                                          String recordId)
                                   throws DnsimpleException,
                                          IOException

Delete a record from a zone.

Parameters:

accountId - The account ID

zoneId - The zone name or ID

recordId - The zone record ID

Returns:

The delete zone record response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/zones/records/#delete