com.dnsimple

Interface Services

All Known Implementing Classes:

ServicesEndpoint

public interface Services

Provides access to the DNSimple one-click Services API.

See Also:

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

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.

Method Detail

listServices

ListServicesResponse listServices()
                           throws DnsimpleException,
                                  IOException

Lists the available one-click 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

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

Lists the available one-click 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

GetServiceResponse getService(String serviceId)
                       throws DnsimpleException,
                              IOException

Get a specific service by ID.

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

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

Lists the one-click services applied to the domain.

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

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

Lists the one-click services applied to the domain.

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

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

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

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

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

Unapply the given one-click service the given domain.

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