Module co.tryterra.terraclient

Package co.tryterra.terraclient

Enum RequestConfig.Samples

java.lang.Object

java.lang.Enum<RequestConfig.Samples>

co.tryterra.terraclient.RequestConfig.Samples

All Implemented Interfaces:

Serializable, Comparable<RequestConfig.Samples>

Enclosing class:

RequestConfig

public static enum RequestConfig.Samples
extends Enum<RequestConfig.Samples>

Enum representing all possible values for the with_samples query parameter.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACCOUNT_DEFAULT	Use the account default.
EXCLUDE	Exclude samples from the response data.
INCLUDE	Include samples in the response data.

Method Summary

Modifier and Type	Method	Description
static RequestConfig.Samples	valueOf(String name)	Returns the enum constant of this type with the specified name.
static RequestConfig.Samples[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INCLUDE

public static final RequestConfig.Samples INCLUDE

Include samples in the response data.

EXCLUDE

public static final RequestConfig.Samples EXCLUDE

Exclude samples from the response data.

ACCOUNT_DEFAULT

public static final RequestConfig.Samples ACCOUNT_DEFAULT

Use the account default. This is dictated by whether the developer account has the samples scope enabled on the developer dashboard.

Method Detail

values

public static RequestConfig.Samples[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RequestConfig.Samples c : RequestConfig.Samples.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RequestConfig.Samples valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null