com.dyn.client.v3.traffic.features

Interface HttpRedirectApi

public interface HttpRedirectApi

Author:

Sunny Gleason, Adrian Cole

Method Summary

Methods

Modifier and Type	Method and Description
HttpRedirect	getHttpRedirect(String fqdn) Gets the HttpRedirect or null if not present.
com.google.common.collect.FluentIterable<String>	list() Retrieves a list of HTTP Redirects in the given zone.
Job	scheduleCreate(HttpRedirect newRedirect) Schedules addition of a new HTTP redirect into the current session.
Job	scheduleDelete(String fqdn) Schedules deletion of a redirect into the current session.
Job	scheduleUpdate(HttpRedirect newRedirect) Schedules update of an existing HTTP redirect into the current session.

Method Detail

list

@Named(value="GetAllHttpRedirects")
com.google.common.collect.FluentIterable<String> list()
                                                      throws DynTrafficExceptions.JobStillRunningException

Retrieves a list of HTTP Redirects in the given zone.

Throws:

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

scheduleCreate

@Named(value="CreateHttpRedirect")
Job scheduleCreate(HttpRedirect newRedirect)
                   throws DynTrafficExceptions.JobStillRunningException

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

Parameters:

newRedirect - record to create

Returns:

job relating to the scheduled creation.

Throws:

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

scheduleUpdate

@Named(value="UpdateHttpRedirect")
Job scheduleUpdate(HttpRedirect newRedirect)
                   throws DynTrafficExceptions.JobStillRunningException

Schedules update of an existing HTTP redirect into the current session. Calling ZoneApi.publish(String) will publish the zone, creating the redirect.

Parameters:

newRedirect - record to create

Returns:

job relating to the scheduled creation.

Throws:

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

scheduleDelete

@Nullable
@Named(value="DeleteHttpRedirect")
Job scheduleDelete(String fqdn)
                   throws DynTrafficExceptions.JobStillRunningException

Schedules deletion of a redirect into the current session. Calling ZoneApi.publish(String) will publish the changes, deleting the record.

Parameters:

fqdn - fqdn redirect to delete

Returns:

job relating to the scheduled deletion or null, if the record never existed.

Throws:

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

getHttpRedirect

@Named(value="GetHttpRedirect")
@Nullable
HttpRedirect getHttpRedirect(String fqdn)
                             throws DynTrafficExceptions.JobStillRunningException

Gets the HttpRedirect or null if not present.

Parameters:

fqdn - RecordId#getFQDN()

Returns:

null if not found

Throws:

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