com.opsmatters.newrelic.api

Class NewRelicSyntheticsApi

java.lang.Object

com.opsmatters.newrelic.api.NewRelicClient

com.opsmatters.newrelic.api.NewRelicSyntheticsApi

public class NewRelicSyntheticsApi
extends NewRelicClient

Client used to invoke New Relic operations using the Synthetics API.

Author:

Gerald Curley (opsmatters)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NewRelicSyntheticsApi.Builder Builder to make NewRelicSyntheticsApi construction easier.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_HOST The default hostname for New Relic Synthetics.

Fields inherited from class com.opsmatters.newrelic.api.NewRelicClient

DEFAULT_PORT, httpContext, provider

Constructor Summary

Constructors

Constructor and Description
NewRelicSyntheticsApi() Default constructor.
NewRelicSyntheticsApi(String hostname, int port, HttpClientProvider provider) Constructor that takes a hostname, port and provider.

Method Summary

Modifier and Type	Method and Description
static NewRelicSyntheticsApi.Builder	builder() Returns a builder for the NewRelicSyntheticsApi.
String	getUriPrefix() Returns the uri prefix for resources used by the client.
LocationService	locations() Returns the operations related to Synthetics locations.
MonitorService	monitors() Returns the operations related to Synthetics monitors.
void	setHostname(String hostname) Sets the name of the host to connect to.

Methods inherited from class com.opsmatters.newrelic.api.NewRelicClient

checkInitialize, getHttpContext, handleErrors, initialize, setHandleErrors, setHttpClientProvider, setPort

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_HOST

public static final String DEFAULT_HOST

The default hostname for New Relic Synthetics.

See Also:

Constant Field Values

Constructor Detail

NewRelicSyntheticsApi

public NewRelicSyntheticsApi()

Default constructor.

NewRelicSyntheticsApi

public NewRelicSyntheticsApi(String hostname,
                             int port,
                             HttpClientProvider provider)

Constructor that takes a hostname, port and provider.

Parameters:

hostname - The hostname of the server

port - The port of the server

provider - The HTTP client provider

Method Detail

setHostname

public void setHostname(String hostname)

Sets the name of the host to connect to.

The default hostname is "synthetics.newrelic.com".

Overrides:

setHostname in class NewRelicClient

Parameters:

hostname - The name of the host

getUriPrefix

public String getUriPrefix()

Returns the uri prefix for resources used by the client.

Defaults to "/synthetics/api" for Synthetics.

Overrides:

getUriPrefix in class NewRelicClient

Returns:

The uri prefix for the client

monitors

public MonitorService monitors()

Returns the operations related to Synthetics monitors.

Returns:

The Synthetics monitor service

locations

public LocationService locations()

Returns the operations related to Synthetics locations.

Returns:

The Synthetics location service

builder

public static NewRelicSyntheticsApi.Builder builder()

Returns a builder for the NewRelicSyntheticsApi.

Returns:

The builder instance.