org.jclouds.ultradns.ws.features

Interface RoundRobinPoolApi

public interface RoundRobinPoolApi

Author:

Adrian Cole

See Also:

,

Method Summary

Methods

Modifier and Type	Method and Description
String	addAAAARecordWithAddressAndTTL(String lbPoolID, String ipv6Address, int ttl) adds a new AAAA record to the pool
String	addARecordWithAddressAndTTL(String lbPoolID, String ipv4Address, int ttl) adds a new A record to the pool
String	createForDNameAndType(String name, String dname, int rrType) creates a round robin pool.
void	delete(String id) removes a pool and all its records and probes
void	deleteRecord(String guid) deletes a specific pooled resource record
com.google.common.collect.FluentIterable<RoundRobinPool>	list() Returns all round robin pools in the zone.
com.google.common.collect.FluentIterable<ResourceRecordDetail>	listRecords(String poolId) Returns all records in the round robin pool.
void	updateRecordWithAddressAndTTL(String lbPoolID, String guid, String ipv4Address, int ttl) updates an existing A or AAAA record in the pool.

Method Detail

list

@Named(value="getLoadBalancingPoolsByZone")
com.google.common.collect.FluentIterable<RoundRobinPool> list()
                                                              throws ResourceNotFoundException

Returns all round robin pools in the zone.

Throws:

ResourceNotFoundException - if the zone doesn't exist

listRecords

@Named(value="getRRPoolRecords")
com.google.common.collect.FluentIterable<ResourceRecordDetail> listRecords(String poolId)
                                                                           throws ResourceNotFoundException

Returns all records in the round robin pool.

Throws:

ResourceNotFoundException - if the pool doesn't exist

createForDNameAndType

@Named(value="addRRLBPool")
String createForDNameAndType(String name,
                                 String dname,
                                 int rrType)
                             throws UltraDNSWSExceptions.ResourceAlreadyExistsException

creates a round robin pool.

Parameters:

name - name of the RR pool

dname - dname of the RR pool {ex. www.jclouds.org.}

rrType - the record type supported.

Returns:

the guid of the new pool

Throws:

UltraDNSWSExceptions.ResourceAlreadyExistsException - if a pool already exists with the same attrs

addARecordWithAddressAndTTL

@Named(value="addRecordToRRPool")
String addARecordWithAddressAndTTL(String lbPoolID,
                                       String ipv4Address,
                                       int ttl)
                                   throws UltraDNSWSExceptions.ResourceAlreadyExistsException

adds a new A record to the pool

Parameters:

lbPoolID - the pool to add the record to.

ipv4Address - the ipv4 address

ttl - the ttl of the record

Returns:

the guid of the new record

Throws:

UltraDNSWSExceptions.ResourceAlreadyExistsException - if a record already exists with the same attrs

updateRecordWithAddressAndTTL

@Named(value="updateRecordOfRRPool")
void updateRecordWithAddressAndTTL(String lbPoolID,
                                       String guid,
                                       String ipv4Address,
                                       int ttl)
                                   throws ResourceNotFoundException

updates an existing A or AAAA record in the pool.

Parameters:

lbPoolID - the pool to add the record to.

guid - the global unique identifier for the resource record ResourceRecordMetadata#getGuid()

address - the ipv4 or ipv6 address

ttl - the ttl of the record

Throws:

ResourceNotFoundException - if the guid doesn't exist

deleteRecord

@Named(value="deleteRecordOfRRPool")
void deleteRecord(String guid)

deletes a specific pooled resource record

Parameters:

guid - the global unique identifier for the resource record ResourceRecordMetadata#getGuid()

addAAAARecordWithAddressAndTTL

@Named(value="addRecordToRRPool")
String addAAAARecordWithAddressAndTTL(String lbPoolID,
                                          String ipv6Address,
                                          int ttl)
                                      throws UltraDNSWSExceptions.ResourceAlreadyExistsException

adds a new AAAA record to the pool

Parameters:

lbPoolID - the pool to add the record to.

ipv6Address - the ipv6 address

ttl - the ttl of the record

Returns:

the guid of the new record

Throws:

UltraDNSWSExceptions.ResourceAlreadyExistsException - if a record already exists with the same attrs

delete

@Named(value="deleteLBPool")
void delete(String id)

removes a pool and all its records and probes

Parameters:

id - the id