com.google.api.ads.dfp.jaxws.v201711

Enum ForecastErrorReason

java.lang.Object

java.lang.Enum<ForecastErrorReason>

com.google.api.ads.dfp.jaxws.v201711.ForecastErrorReason

All Implemented Interfaces:

Serializable, Comparable<ForecastErrorReason>

public enum ForecastErrorReason
extends Enum<ForecastErrorReason>

Java class for ForecastError.Reason.

The following schema fragment specifies the expected content contained within this class.

 <simpleType name="ForecastError.Reason">
   <restriction base="{http://www.w3.org/2001/XMLSchema}string">
     <enumeration value="SERVER_NOT_AVAILABLE"/>
     <enumeration value="INTERNAL_ERROR"/>
     <enumeration value="NO_FORECAST_YET"/>
     <enumeration value="NOT_ENOUGH_INVENTORY"/>
     <enumeration value="SUCCESS"/>
     <enumeration value="ZERO_LENGTH_RESERVATION"/>
     <enumeration value="EXCEEDED_QUOTA"/>
     <enumeration value="UNKNOWN"/>
   </restriction>
 </simpleType>
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
EXCEEDED_QUOTA The number of requests made per second is too high and has exceeded the allowable limit.
INTERNAL_ERROR There was an unexpected internal error.
NO_FORECAST_YET The forecast could not be retrieved because there is not enough forecasting data available yet.
NOT_ENOUGH_INVENTORY There's not enough inventory for the requested reservation.
SERVER_NOT_AVAILABLE The forecast could not be retrieved due to a server side connection problem.
SUCCESS No error from forecast.
UNKNOWN The value returned if the actual value is not exposed by the requested API version.
ZERO_LENGTH_RESERVATION The requested reservation is of zero length.

Method Summary

Modifier and Type	Method and Description
static ForecastErrorReason	fromValue(String v)
String	value()
static ForecastErrorReason	valueOf(String name) Returns the enum constant of this type with the specified name.
static ForecastErrorReason[]	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

SERVER_NOT_AVAILABLE

public static final ForecastErrorReason SERVER_NOT_AVAILABLE

The forecast could not be retrieved due to a server side connection problem. Please try again soon.

INTERNAL_ERROR

public static final ForecastErrorReason INTERNAL_ERROR

There was an unexpected internal error.

NO_FORECAST_YET

public static final ForecastErrorReason NO_FORECAST_YET

The forecast could not be retrieved because there is not enough forecasting data available yet. It may take up to one week before enough data is available.

NOT_ENOUGH_INVENTORY

public static final ForecastErrorReason NOT_ENOUGH_INVENTORY

There's not enough inventory for the requested reservation.

SUCCESS

public static final ForecastErrorReason SUCCESS

No error from forecast.

ZERO_LENGTH_RESERVATION

public static final ForecastErrorReason ZERO_LENGTH_RESERVATION

The requested reservation is of zero length. No forecast is returned.

EXCEEDED_QUOTA

public static final ForecastErrorReason EXCEEDED_QUOTA

The number of requests made per second is too high and has exceeded the allowable limit. The recommended approach to handle this error is to wait about 5 seconds and then retry the request. Note that this does not guarantee the request will succeed. If it fails again, try increasing the wait time.

Another way to mitigate this error is to limit requests to 2 per second. Once again this does not guarantee that every request will succeed, but may help reduce the number of times you receive this error.

UNKNOWN

public static final ForecastErrorReason UNKNOWN

The value returned if the actual value is not exposed by the requested API version.

Method Detail

values

public static ForecastErrorReason[] 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 (ForecastErrorReason c : ForecastErrorReason.values())
    System.out.println(c);

Returns:

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

valueOf

public static ForecastErrorReason 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

value

public String value()

fromValue

public static ForecastErrorReason fromValue(String v)