Interface RecordApi


  • public interface RecordApi
    • Method Detail

      • 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.
      • 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).