ZoneApi (Apache jclouds 2.1.0 API)

```
public interface ZoneApi
```

Method Summary

Methods
Modifier and Type	Method and Description
`Job`	`delete(String fqdn)` Deletes the zone.
`Job`	`deleteChanges(String fqdn)` Deletes changes to the specified zone that have been created during the current session but not yet published to the zone.
`Job`	`freeze(String fqdn)` freezes the specified zone.
`Zone`	`get(String fqdn)` Retrieves information about the specified zone.
`com.google.common.collect.FluentIterable<String>`	`list()` Lists all zone ids.
`Zone`	`publish(String fqdn)` Publishes the current zone
`Job`	`scheduleCreate(CreatePrimaryZone createZone)` Schedules addition of a new primary zone into the current session.
`Job`	`scheduleCreateWithContact(String fqdn, String contact)` Schedules addition of a new primary zone with one hour default TTL and `SerialStyle#INCREMENT` into the current session.
`Job`	`thaw(String fqdn)` thaws the specified zone.

Method Detail

list

@Named(value="ListZones")
@GET
@Path(value="/Zone")
com.google.common.collect.FluentIterable<String> list()
                                                      throws DynECTExceptions.JobStillRunningException

Lists all zone ids.

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

scheduleCreate

@Named(value="CreatePrimaryZone")
@POST
@Path(value="/Zone/{fqdn}")
@Consumes(value="application/json")
Job scheduleCreate(@PathParam(value="fqdn")
                                          CreatePrimaryZone createZone)
                   throws DynECTExceptions.JobStillRunningException,
                          DynECTExceptions.TargetExistsException

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

Parameters:: zone - required parameters to create the zone.
Returns:: job relating to the scheduled creation.
Throws:: DynECTExceptions.JobStillRunningException - if a different job in the session is still running; DynECTExceptions.TargetExistsException - if the same fqdn exists

scheduleCreateWithContact

@Named(value="CreatePrimaryZone")
@POST
@Produces(value="application/json")
@Path(value="/Zone/{fqdn}")
@Consumes(value="application/json")
Job scheduleCreateWithContact(@PathParam(value="fqdn")
                                                              String fqdn,
                                                              String contact)
                              throws DynECTExceptions.JobStillRunningException,
                                     DynECTExceptions.TargetExistsException

Schedules addition of a new primary zone with one hour default TTL and SerialStyle#INCREMENT into the current session. Calling publish(String) will publish the zone, creating the zone.

Parameters:: fqdn - fqdn of the zone to create; contact - email address of the contact
Returns:: job relating to the scheduled creation.
Throws:: DynECTExceptions.JobStillRunningException - if a different job in the session is still running; DynECTExceptions.TargetExistsException - if the same fqdn exists

get
```
@Named(value="GetZone")
@GET
@Path(value="/Zone/{fqdn}")
@Nullable
Zone get(@PathParam(value="fqdn")
                               String fqdn)
         throws DynECTExceptions.JobStillRunningException
```
Retrieves information about the specified zone.

Parameters:
fqdn - fqdn of the zone to get information about. ex jclouds.org

Returns:
null if not found

Throws:

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

delete

@Named(value="DeleteZone")
@DELETE
@Path(value="/Zone/{fqdn}")
@Consumes(value="application/json")
@Nullable
Job delete(@PathParam(value="fqdn")
                                             String fqdn)
           throws DynECTExceptions.JobStillRunningException

Deletes the zone. No need to call @link ZoneApi#publish(String)}.

Parameters:: fqdn - zone to delete
Returns:: job relating to the scheduled deletion or null, if the zone never existed.
Throws:: DynECTExceptions.JobStillRunningException - if a different job in the session is still running

deleteChanges

@Named(value="DeleteZoneChanges")
@DELETE
@Path(value="/ZoneChanges/{fqdn}")
@Consumes(value="application/json")
Job deleteChanges(@PathParam(value="fqdn")
                                           String fqdn)
                  throws DynECTExceptions.JobStillRunningException

Deletes changes to the specified zone that have been created during the current session but not yet published to the zone.

Parameters:: fqdn - fqdn of the zone to delete changes from ex jclouds.org
Throws:: DynECTExceptions.JobStillRunningException - if a different job in the session is still running

publish

@Named(value="PublishZone")
@PUT
@Path(value="/Zone/{fqdn}")
@Produces(value="application/json")
Zone publish(@PathParam(value="fqdn")
                                   String fqdn)
             throws DynECTExceptions.JobStillRunningException,
                    ResourceNotFoundException

Publishes the current zone

Parameters:: fqdn - fqdn of the zone to publish. ex jclouds.org
Throws:: DynECTExceptions.JobStillRunningException - if a different job in the session is still running; ResourceNotFoundException - if the zone doesn't exist

freeze

@Named(value="FreezeZone")
@PUT
@Path(value="/Zone/{fqdn}")
@Produces(value="application/json")
@Consumes(value="application/json")
Job freeze(@PathParam(value="fqdn")
                                          String fqdn)
           throws DynECTExceptions.JobStillRunningException

freezes the specified zone.

Parameters:: fqdn - fqdn of the zone to freeze ex jclouds.org
Throws:: DynECTExceptions.JobStillRunningException - if a different job in the session is still running

thaw

@Named(value="ThawZone")
@PUT
@Path(value="/Zone/{fqdn}")
@Produces(value="application/json")
@Consumes(value="application/json")
Job thaw(@PathParam(value="fqdn")
                                        String fqdn)
         throws DynECTExceptions.JobStillRunningException

thaws the specified zone.

Parameters:: fqdn - fqdn of the zone to thaw ex jclouds.org
Throws:: DynECTExceptions.JobStillRunningException - if a different job in the session is still running

Interface ZoneApi