com.dnsimple.endpoints.http

Class ZonesEndpoint

java.lang.Object

com.dnsimple.endpoints.http.ZonesEndpoint

All Implemented Interfaces:

Zones

public class ZonesEndpoint
extends Object
implements Zones

Constructor Summary

Constructors

Constructor and Description
ZonesEndpoint(HttpEndpointClient client)

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ZonesEndpoint

public ZonesEndpoint(HttpEndpointClient client)

Method Detail

listZones

public ListZonesResponse listZones(String accountId)
                            throws DnsimpleException,
                                   IOException

Description copied from interface: Zones

Lists the zones in the account.

Specified by:

listZones in interface Zones

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

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

Description copied from interface: Zones

Lists the zones in the account.

Specified by:

listZones in interface Zones

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

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

Description copied from interface: Zones

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

Specified by:

getZone in interface Zones

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

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

Description copied from interface: Zones

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

Specified by:

getZoneFile in interface Zones

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

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

Description copied from interface: Zones

Lists the records in the zone.

Specified by:

listZoneRecords in interface Zones

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

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

Description copied from interface: Zones

Lists the records in the zone.

Specified by:

listZoneRecords in interface Zones

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

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

Description copied from interface: Zones

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

Specified by:

getZoneRecord in interface Zones

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

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

Description copied from interface: Zones

Create a record in a zone.

Specified by:

createZoneRecord in interface Zones

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

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

Description copied from interface: Zones

Update a record in a zone.

Specified by:

updateZoneRecord in interface Zones

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

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

Description copied from interface: Zones

Delete a record from a zone.

Specified by:

deleteZoneRecord in interface Zones

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