com.dnsimple.endpoints.http

Class ServicesEndpoint

java.lang.Object

com.dnsimple.endpoints.http.ServicesEndpoint

All Implemented Interfaces:

Services

public class ServicesEndpoint
extends Object
implements Services

Constructor Summary

Constructors

Constructor and Description
ServicesEndpoint(HttpEndpointClient client)

Method Summary

Modifier and Type	Method and Description
AppliedServicesResponse	appliedServices(String accountId, String domainId) Lists the one-click services applied to the domain.
AppliedServicesResponse	appliedServices(String accountId, String domainId, Map<String,Object> options) Lists the one-click services applied to the domain.
ApplyServiceResponse	applyService(String accountId, String domainId, String serviceId, Map<String,Object> settings) Apply the given one-click service to the given domain.
GetServiceResponse	getService(String serviceId) Get a specific service by ID.
ListServicesResponse	listServices() Lists the available one-click services.
ListServicesResponse	listServices(Map<String,Object> options) Lists the available one-click services.
UnapplyServiceResponse	unapplyService(String accountId, String domainId, String serviceId) Unapply the given one-click service the given domain.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServicesEndpoint

public ServicesEndpoint(HttpEndpointClient client)

Method Detail

listServices

public ListServicesResponse listServices()
                                  throws DnsimpleException,
                                         IOException

Description copied from interface: Services

Lists the available one-click services.

Specified by:

listServices in interface Services

Returns:

The list services response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/services/#list

listServices

public ListServicesResponse listServices(Map<String,Object> options)
                                  throws DnsimpleException,
                                         IOException

Description copied from interface: Services

Lists the available one-click services.

Specified by:

listServices in interface Services

Parameters:

options - Options to pass to the DNSimple API

Returns:

The list services response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/services/#list

getService

public GetServiceResponse getService(String serviceId)
                              throws DnsimpleException,
                                     IOException

Description copied from interface: Services

Get a specific service by ID.

Specified by:

getService in interface Services

Parameters:

serviceId - The service ID

Returns:

The get service response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/services/#get

appliedServices

public AppliedServicesResponse appliedServices(String accountId,
                                               String domainId)
                                        throws DnsimpleException,
                                               IOException

Description copied from interface: Services

Lists the one-click services applied to the domain.

Specified by:

appliedServices in interface Services

Parameters:

accountId - The account ID

domainId - The domain name or ID

Returns:

The applied services response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/services/domains/#applied

appliedServices

public AppliedServicesResponse appliedServices(String accountId,
                                               String domainId,
                                               Map<String,Object> options)
                                        throws DnsimpleException,
                                               IOException

Description copied from interface: Services

Lists the one-click services applied to the domain.

Specified by:

appliedServices in interface Services

Parameters:

accountId - The account ID

domainId - The domain name or ID

options - Options passed to the DNSimple API

Returns:

The applied services response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/services/domains/#applied

applyService

public ApplyServiceResponse applyService(String accountId,
                                         String domainId,
                                         String serviceId,
                                         Map<String,Object> settings)
                                  throws DnsimpleException,
                                         IOException

Description copied from interface: Services

Apply the given one-click service to the given domain.

Specified by:

applyService in interface Services

Parameters:

accountId - The account ID

domainId - The domain name or ID

serviceId - The service ID to apply

settings - A Map of settings for the service

Returns:

The apply service response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/services/domains/#apply

unapplyService

public UnapplyServiceResponse unapplyService(String accountId,
                                             String domainId,
                                             String serviceId)
                                      throws DnsimpleException,
                                             IOException

Description copied from interface: Services

Unapply the given one-click service the given domain.

Specified by:

unapplyService in interface Services

Parameters:

accountId - The account ID

domainId - The domain name or ID

serviceId - The service ID to unapply

Returns:

The unapply service response

Throws:

DnsimpleException - Any API errors

IOException - Any IO errors

See Also:

https://developer.dnsimple.com/v2/services/domains/#apply