Package org.jclouds.dynect.v3.features

Interface RecordApi

public interface RecordApi

Method Summary

Modifier and Type	Method	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("GetAllRecord")
@GET
@Path("/AllRecord/{zone}")
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("GetRecord")
@GET
@Path("/AllRecord/{zone}/{fqdn}")
com.google.common.collect.FluentIterable<RecordId> listByFQDN(@PathParam("fqdn")
                                                              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("GetRecord")
@GET
@Path("/{type}Record/{zone}/{fqdn}")
com.google.common.collect.FluentIterable<RecordId> listByFQDNAndType(@PathParam("fqdn")
                                                                     String fqdn,
                                                                     @PathParam("type")
                                                                     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("CreateRecord")
@POST
@Path("/{type}Record/{zone}/{fqdn}")
@Consumes("application/json")
@Produces("application/json")
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("DeleteRecord")
@DELETE
@Consumes("application/json")
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("GetRecord")
@GET
@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("GetAAAARecord")
@GET
@Path("/AAAARecord/{zone}/{fqdn}/{id}")
@Nullable
Record<AAAAData> getAAAA(@PathParam("fqdn")
                         String fqdn,
                         @PathParam("id")
                         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("GetARecord")
@GET
@Path("/ARecord/{zone}/{fqdn}/{id}")
@Nullable
Record<AData> getA(@PathParam("fqdn")
                   String fqdn,
                   @PathParam("id")
                   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("GetCNAMERecord")
@GET
@Path("/CNAMERecord/{zone}/{fqdn}/{id}")
@Nullable
Record<CNAMEData> getCNAME(@PathParam("fqdn")
                           String fqdn,
                           @PathParam("id")
                           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("GetMXRecord")
@GET
@Path("/MXRecord/{zone}/{fqdn}/{id}")
@Nullable
Record<MXData> getMX(@PathParam("fqdn")
                     String fqdn,
                     @PathParam("id")
                     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("GetNSRecord")
@GET
@Path("/NSRecord/{zone}/{fqdn}/{id}")
@Nullable
Record<NSData> getNS(@PathParam("fqdn")
                     String fqdn,
                     @PathParam("id")
                     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("GetPTRRecord")
@GET
@Path("/PTRRecord/{zone}/{fqdn}/{id}")
@Nullable
Record<PTRData> getPTR(@PathParam("fqdn")
                       String fqdn,
                       @PathParam("id")
                       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("GetSOARecord")
@GET
@Path("/SOARecord/{zone}/{fqdn}/{id}")
@Nullable
SOARecord getSOA(@PathParam("fqdn")
                 String fqdn,
                 @PathParam("id")
                 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("GetSPFRecord")
@GET
@Path("/SPFRecord/{zone}/{fqdn}/{id}")
@Nullable
Record<SPFData> getSPF(@PathParam("fqdn")
                       String fqdn,
                       @PathParam("id")
                       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("GetSRVRecord")
@GET
@Path("/SRVRecord/{zone}/{fqdn}/{id}")
@Nullable
Record<SRVData> getSRV(@PathParam("fqdn")
                       String fqdn,
                       @PathParam("id")
                       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("GetSSHFPRecord")
@GET
@Path("/SSHFPRecord/{zone}/{fqdn}/{id}")
@Nullable
Record<SSHFPData> getSSHFP(@PathParam("fqdn")
                           String fqdn,
                           @PathParam("id")
                           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("GetTXTRecord")
@GET
@Path("/TXTRecord/{zone}/{fqdn}/{id}")
@Nullable
Record<TXTData> getTXT(@PathParam("fqdn")
                       String fqdn,
                       @PathParam("id")
                       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