com.dnsimple

Class Client

java.lang.Object

com.dnsimple.Client

public class Client
extends Object

Instances of the Client handle low-level HTTP calls to the API.

Field Summary

Fields

Modifier and Type	Field and Description
Accounts	accounts
Certificates	certificates
Contacts	contacts
Domains	domains
Identity	identity
Oauth	oauth
Registrar	registrar
Services	services
Templates	templates
Tlds	tlds
VanityNameServers	vanityNameServers
Webhooks	webhooks
Zones	zones

Constructor Summary

Constructors

Constructor and Description
Client() Construct a new API client with the default HTTP endpoint adapter.
Client(EndpointAdapter adapter) Construct a new API client with the given endpoint adapter.

Method Summary

Modifier and Type	Method and Description
void	setAccessToken(String accessToken) Set the access token to use for the client instance.
void	setTransport(com.google.api.client.http.HttpTransport transport) Set the underlying transport mechanism.
void	setUserAgent(String userAgent) Set the user agent to use for the client instance.

Methods inherited from class java.lang.Object

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

Field Detail

accounts

public final Accounts accounts

certificates

public final Certificates certificates

contacts

public final Contacts contacts

domains

public final Domains domains

identity

public final Identity identity

oauth

public final Oauth oauth

registrar

public final Registrar registrar

services

public final Services services

templates

public final Templates templates

tlds

public final Tlds tlds

vanityNameServers

public final VanityNameServers vanityNameServers

webhooks

public final Webhooks webhooks

zones

public final Zones zones

Constructor Detail

Client

public Client()

Construct a new API client with the default HTTP endpoint adapter. Once you have a client instance, use the public properties such as `accounts` or `domains` to communicate with the remote API. For example: Client client = new Client(); WhoamiResponse response = client.accounts.whoami();

Client

public Client(EndpointAdapter adapter)

Construct a new API client with the given endpoint adapter. Once you have a client instance, use the public properties such as `accounts` or `domains` to communicate with the remote API. For example: EndpointAdapter adapter = new TestEndpointAdapter(); Client client = new Client(adapter); WhoamiResponse response = client.accounts.whoami();

Parameters:

adapter - The endpoint adapter to use in the client.

Method Detail

setTransport

public void setTransport(com.google.api.client.http.HttpTransport transport)

Set the underlying transport mechanism. This method is primarily used to specify a mocked transport layer during testing.

Parameters:

transport - The transport instance

setAccessToken

public void setAccessToken(String accessToken)

Set the access token to use for the client instance.

Parameters:

accessToken - The access token string

setUserAgent

public void setUserAgent(String userAgent)

Set the user agent to use for the client instance.

Parameters:

userAgent - The user agent string