org.jclouds.dynect.v3.features

Interface RecordApi

public interface RecordApi

Author:

Adrian Cole

Method Summary

Methods

Modifier and Type	Method and Description
Record<? extends Map<String,Object>>	get(RecordId recordId) retrieves a resource record without regard to type
Record<AData>	getA(String fqdn, long recordId) Gets the ARecord or null if not present.
Record<AAAAData>	getAAAA(String fqdn, long recordId) Gets the AAAARecord or null if not present.
Record<CNAMEData>	getCNAME(String fqdn, long recordId) Gets the CNAMERecord or null if not present.
Record<MXData>	getMX(String fqdn, long recordId) Gets the MXRecord or null if not present.
Record<NSData>	getNS(String fqdn, long recordId) Gets the NSRecord or null if not present.
Record<PTRData>	getPTR(String fqdn, long recordId) Gets the PTRRecord or null if not present.
SOARecord	getSOA(String fqdn, long recordId) Gets the SOARecord or null if not present.
Record<SPFData>	getSPF(String fqdn, long recordId) Gets the SPFRecord or null if not present.
Record<SRVData>	getSRV(String fqdn, long recordId) Gets the SRVRecord or null if not present.
Record<SSHFPData>	getSSHFP(String fqdn, long recordId) Gets the SSHFPRecord or null if not present.
Record<TXTData>	getTXT(String fqdn, long recordId) Gets the TXTRecord or null if not present.
com.google.common.collect.FluentIterable<RecordId>	list() Retrieves a list of resource record ids for all records of any type in the given zone.
com.google.common.collect.FluentIterable<RecordId>	listByFQDN(String fqdn) Retrieves a list of resource record ids for all records of the fqdn in the given zone
com.google.common.collect.FluentIterable<RecordId>	listByFQDNAndType(String fqdn, String type) Retrieves a list of resource record ids for all records of the fqdn and type in the given zone
Job	scheduleCreate(CreateRecord<?> newRecord) Schedules addition of a new record into the current session.
Job	scheduleDelete(RecordId recordId) Schedules deletion of a record into the current session.

Method Detail

list

@Named(value="GetAllRecord")
com.google.common.collect.FluentIterable<RecordId> list()
                                                        throws DynECTExceptions.JobStillRunningException

Retrieves a list of resource record ids for all records of any type in the given zone.

Throws:

DynECTExceptions.JobStillRunningException - if a different job in the session is still running

listByFQDN

@Named(value="GetRecord")
com.google.common.collect.FluentIterable<RecordId> listByFQDN(String fqdn)
                                                              throws DynECTExceptions.JobStillRunningException

Retrieves a list of resource record ids for all records of the fqdn in the given zone

Throws:

DynECTExceptions.JobStillRunningException - if a different job in the session is still running

listByFQDNAndType

@Named(value="GetRecord")
com.google.common.collect.FluentIterable<RecordId> listByFQDNAndType(String fqdn,
                                                                         String type)
                                                                     throws DynECTExceptions.JobStillRunningException

Retrieves a list of resource record ids for all records of the fqdn and type in the given zone

Throws:

DynECTExceptions.JobStillRunningException - if a different job in the session is still running

scheduleCreate

@Named(value="CreateRecord")
Job scheduleCreate(CreateRecord<?> newRecord)
                   throws DynECTExceptions.JobStillRunningException

Schedules addition of a new record into the current session. Calling ZoneApi.publish(String) will publish the zone, creating the record.

Parameters:

newRecord - record to create

Returns:

job relating to the scheduled creation.

Throws:

DynECTExceptions.JobStillRunningException - if a different job in the session is still running

scheduleDelete

@Nullable
@Named(value="DeleteRecord")
Job scheduleDelete(RecordId recordId)
                   throws DynECTExceptions.JobStillRunningException

Schedules deletion of a record into the current session. Calling ZoneApi.publish(String) will publish the changes, deleting the record.

Parameters:

recordId - record to delete

Returns:

job relating to the scheduled deletion or null, if the record never existed.

Throws:

DynECTExceptions.JobStillRunningException - if a different job in the session is still running

get

@Named(value="GetRecord")
@Nullable
Record<? extends Map<String,Object>> get(RecordId recordId)
                                         throws DynECTExceptions.JobStillRunningException

retrieves a resource record without regard to type

Returns:

null if not found

Throws:

DynECTExceptions.JobStillRunningException - if a different job in the session is still running

getAAAA

@Named(value="GetAAAARecord")
@Nullable
Record<AAAAData> getAAAA(String fqdn,
                                      long recordId)
                         throws DynECTExceptions.JobStillRunningException

Gets the AAAARecord or null if not present.

Parameters:

fqdn - Node.getFQDN()

recordId - RecordId.getId()

Returns:

null if not found

Throws:

DynECTExceptions.JobStillRunningException - if a different job in the session is still running

getA

@Named(value="GetARecord")
@Nullable
Record<AData> getA(String fqdn,
                                long recordId)
                   throws DynECTExceptions.JobStillRunningException

Gets the ARecord or null if not present.

Parameters:

fqdn - Node.getFQDN()

recordId - RecordId.getId()

Returns:

null if not found

Throws:

DynECTExceptions.JobStillRunningException - if a different job in the session is still running

getCNAME

@Named(value="GetCNAMERecord")
@Nullable
Record<CNAMEData> getCNAME(String fqdn,
                                        long recordId)
                           throws DynECTExceptions.JobStillRunningException

Gets the CNAMERecord or null if not present.

Parameters:

fqdn - Node.getFQDN()

recordId - RecordId.getId()

Returns:

null if not found

Throws:

DynECTExceptions.JobStillRunningException - if a different job in the session is still running

getMX

@Named(value="GetMXRecord")
@Nullable
Record<MXData> getMX(String fqdn,
                                  long recordId)
                     throws DynECTExceptions.JobStillRunningException

Gets the MXRecord or null if not present.

Parameters:

fqdn - Node.getFQDN()

recordId - RecordId.getId()

Returns:

null if not found

Throws:

DynECTExceptions.JobStillRunningException - if a different job in the session is still running

getNS

@Named(value="GetNSRecord")
@Nullable
Record<NSData> getNS(String fqdn,
                                  long recordId)
                     throws DynECTExceptions.JobStillRunningException

Gets the NSRecord or null if not present.

Parameters:

fqdn - Node.getFQDN()

recordId - RecordId.getId()

Returns:

null if not found

Throws:

DynECTExceptions.JobStillRunningException - if a different job in the session is still running

getPTR

@Named(value="GetPTRRecord")
@Nullable
Record<PTRData> getPTR(String fqdn,
                                    long recordId)
                       throws DynECTExceptions.JobStillRunningException

Gets the PTRRecord or null if not present.

Parameters:

fqdn - Node.getFQDN()

recordId - RecordId.getId()

Returns:

null if not found

Throws:

DynECTExceptions.JobStillRunningException - if a different job in the session is still running

getSOA

@Named(value="GetSOARecord")
@Nullable
SOARecord getSOA(String fqdn,
                              long recordId)
                 throws DynECTExceptions.JobStillRunningException

Gets the SOARecord or null if not present.

Parameters:

fqdn - Node.getFQDN()

recordId - RecordId.getId()

Returns:

null if not found

Throws:

DynECTExceptions.JobStillRunningException - if a different job in the session is still running

getSPF

@Named(value="GetSPFRecord")
@Nullable
Record<SPFData> getSPF(String fqdn,
                                    long recordId)
                       throws DynECTExceptions.JobStillRunningException

Gets the SPFRecord or null if not present.

Parameters:

fqdn - Node.getFQDN()

recordId - RecordId.getId()

Returns:

null if not found

Throws:

DynECTExceptions.JobStillRunningException - if a different job in the session is still running

getSRV

@Named(value="GetSRVRecord")
@Nullable
Record<SRVData> getSRV(String fqdn,
                                    long recordId)
                       throws DynECTExceptions.JobStillRunningException

Gets the SRVRecord or null if not present.

Parameters:

fqdn - Node.getFQDN()

recordId - RecordId.getId()

Returns:

null if not found

Throws:

DynECTExceptions.JobStillRunningException - if a different job in the session is still running

getSSHFP

@Named(value="GetSSHFPRecord")
@Nullable
Record<SSHFPData> getSSHFP(String fqdn,
                                        long recordId)
                           throws DynECTExceptions.JobStillRunningException

Gets the SSHFPRecord or null if not present.

Parameters:

fqdn - Node.getFQDN()

recordId - RecordId.getId()

Returns:

null if not found

Throws:

DynECTExceptions.JobStillRunningException - if a different job in the session is still running

getTXT

@Named(value="GetTXTRecord")
@Nullable
Record<TXTData> getTXT(String fqdn,
                                    long recordId)
                       throws DynECTExceptions.JobStillRunningException

Gets the TXTRecord or null if not present.

Parameters:

fqdn - Node.getFQDN()

recordId - RecordId.getId()

Returns:

null if not found

Throws:

DynECTExceptions.JobStillRunningException - if a different job in the session is still running