org.jclouds.rackspace.clouddns.v1.features

Interface RecordApi

public interface RecordApi

Method Summary

Modifier and Type	Method and Description
Job<Set<RecordDetail>>	create(Iterable<Record> createRecords) Create Records for a Domain or Subdomain.
Job<Void>	delete(Iterable<String> recordId) Delete the specified records in the specified domain.
Job<Void>	delete(String recordId) Delete the specified record in the specified domain.
RecordDetail	get(String recordId) Get the details for the specified record in the specified domain.
RecordDetail	getByNameAndTypeAndData(String nameFilter, String typeFilter, String dataFilter) RecordDetails filtered by name and type and data.
PagedIterable<RecordDetail>	list() This call lists all records configured for the specified domain.
PaginatedCollection<RecordDetail>	list(PaginationOptions options) Use PaginationOptions to manually control the list of RecordDetail pages returned.
PagedIterable<RecordDetail>	listByNameAndType(String nameFilter, String typeFilter) RecordDetails filtered by name and type.
PagedIterable<RecordDetail>	listByType(String typeFilter) RecordDetails filtered by type.
PagedIterable<RecordDetail>	listByTypeAndData(String typeFilter, String dataFilter) RecordDetails filtered by type and data.
Job<Void>	update(Map<String,Record> idsToRecords) Update the configuration of the specified records in the specified domain.
Job<Void>	update(String recordId, Record record) Update the configuration of the specified record in the specified domain.

Method Detail

create

@Named(value="record:create")
 @POST
 @Consumes(value="application/json")
 @Path(value="/records")
Job<Set<RecordDetail>> create(Iterable<Record> createRecords)

Create Records for a Domain or Subdomain.

See Supported Record Types

To wait for this call to complete use JobPredicates.awaitComplete(CloudDNSApi, Job).

list

@Named(value="record:list")
 @GET
 @Consumes(value="application/json")
 @Path(value="/records")
PagedIterable<RecordDetail> list()

This call lists all records configured for the specified domain.

listByType

@Named(value="record:list")
 @GET
 @Consumes(value="application/json")
 @Path(value="/records")
PagedIterable<RecordDetail> listByType(@QueryParam(value="type")
                                                                                                                                       String typeFilter)

RecordDetails filtered by type.

listByTypeAndData

@Named(value="record:list")
 @GET
 @Consumes(value="application/json")
 @Path(value="/records")
PagedIterable<RecordDetail> listByTypeAndData(@QueryParam(value="type")
                                                                                                                                              String typeFilter,
                                                                                                                                              @QueryParam(value="data")
                                                                                                                                              String dataFilter)

RecordDetails filtered by type and data.

listByNameAndType

@Named(value="record:list")
 @GET
 @Consumes(value="application/json")
 @Path(value="/records")
PagedIterable<RecordDetail> listByNameAndType(@QueryParam(value="name")
                                                                                                                                              String nameFilter,
                                                                                                                                              @QueryParam(value="type")
                                                                                                                                              String typeFilter)

RecordDetails filtered by name and type.

list

@Named(value="record:list")
 @GET
 @Consumes(value="application/json")
 @Path(value="/records")
PaginatedCollection<RecordDetail> list(PaginationOptions options)

Use PaginationOptions to manually control the list of RecordDetail pages returned.

getByNameAndTypeAndData

@Named(value="record:get")
 @GET
 @Consumes(value="application/json")
 @Path(value="/records")
 @Nullable
RecordDetail getByNameAndTypeAndData(@QueryParam(value="name")
                                                                                                                                               String nameFilter,
                                                                                                                                               @QueryParam(value="type")
                                                                                                                                               String typeFilter,
                                                                                                                                               @QueryParam(value="data")
                                                                                                                                               String dataFilter)

RecordDetails filtered by name and type and data.

get

@Named(value="record:get")
 @GET
 @Consumes(value="application/json")
 @Path(value="/records/{recordId}")
 @Nullable
RecordDetail get(@PathParam(value="recordId")
                                                                                                                                      String recordId)

Get the details for the specified record in the specified domain.

update

@Named(value="record:update")
 @PUT
 @Consumes(value="application/json")
 @Path(value="/records/{recordId}")
Job<Void> update(@PathParam(value="recordId")
                                                                                                                              String recordId,
                                                                                                                              Record record)

Update the configuration of the specified record in the specified domain.

To wait for this call to complete use JobPredicates.awaitComplete(CloudDNSApi, Job).

update

@Named(value="record:update")
 @PUT
 @Consumes(value="application/json")
 @Path(value="/records")
Job<Void> update(Map<String,Record> idsToRecords)

Update the configuration of the specified records in the specified domain.

To wait for this call to complete use JobPredicates.awaitComplete(CloudDNSApi, Job).

delete

@Named(value="record:delete")
 @DELETE
 @Path(value="/records/{recordId}")
 @Consumes(value="*/*")
Job<Void> delete(@PathParam(value="recordId")
                                                                                                                    String recordId)

Delete the specified record in the specified domain.

To wait for this call to complete use JobPredicates.awaitComplete(CloudDNSApi, Job).

delete

@Named(value="record:delete")
 @DELETE
 @Path(value="/records")
 @Consumes(value="*/*")
Job<Void> delete(@QueryParam(value="id")
                                                                                                         Iterable<String> recordId)

Delete the specified records in the specified domain.

To wait for this call to complete use JobPredicates.awaitComplete(CloudDNSApi, Job).