Interface RecordApi


public interface RecordApi
  • Method Details

    • create

      @Named("record:create") @POST @Consumes("application/json") @Path("/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("record:list") @GET @Consumes("application/json") @Path("/records") PagedIterable<RecordDetail> list()
      This call lists all records configured for the specified domain.
    • listByType

      @Named("record:list") @GET @Consumes("application/json") @Path("/records") PagedIterable<RecordDetail> listByType(@QueryParam("type") String typeFilter)
      RecordDetails filtered by type.
    • listByTypeAndData

      @Named("record:list") @GET @Consumes("application/json") @Path("/records") PagedIterable<RecordDetail> listByTypeAndData(@QueryParam("type") String typeFilter, @QueryParam("data") String dataFilter)
      RecordDetails filtered by type and data.
    • listByNameAndType

      @Named("record:list") @GET @Consumes("application/json") @Path("/records") PagedIterable<RecordDetail> listByNameAndType(@QueryParam("name") String nameFilter, @QueryParam("type") String typeFilter)
      RecordDetails filtered by name and type.
    • list

      @Named("record:list") @GET @Consumes("application/json") @Path("/records") PaginatedCollection<RecordDetail> list(PaginationOptions options)
      Use PaginationOptions to manually control the list of RecordDetail pages returned.
    • getByNameAndTypeAndData

      @Named("record:get") @GET @Consumes("application/json") @Path("/records") @Nullable RecordDetail getByNameAndTypeAndData(@QueryParam("name") String nameFilter, @QueryParam("type") String typeFilter, @QueryParam("data") String dataFilter)
      RecordDetails filtered by name and type and data.
    • get

      @Named("record:get") @GET @Consumes("application/json") @Path("/records/{recordId}") @Nullable RecordDetail get(@PathParam("recordId") String recordId)
      Get the details for the specified record in the specified domain.
    • update

      @Named("record:update") @PUT @Consumes("application/json") @Path("/records/{recordId}") Job<Void> update(@PathParam("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("record:update") @PUT @Consumes("application/json") @Path("/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("record:delete") @DELETE @Path("/records/{recordId}") @Consumes("*/*") Job<Void> delete(@PathParam("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("record:delete") @DELETE @Path("/records") @Consumes("*/*") Job<Void> delete(@QueryParam("id") Iterable<String> recordId)
      Delete the specified records in the specified domain.

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