com.google.api.ads.dfp.axis.v201302

Class ApiError

java.lang.Object

com.google.api.ads.dfp.axis.v201302.ApiError

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ActivityError, AdRuleDateError, AdRuleFrequencyCapError, AdRulePriorityError, AdRuleSlotError, AdSenseAccountError, AdUnitAfcSizeError, AdUnitCodeError, AdUnitHierarchyError, AdUnitTypeError, ApiVersionError, AssetError, AudienceExtensionError, AuthenticationError, ClickTrackingLineItemError, CommonError, CompanyCreditStatusError, CompanyError, ContactError, ContentPartnerError, CreativeAssetMacroError, CreativeError, CreativeSetError, CreativeTemplateError, CreativeWrapperError, CustomCreativeError, CustomFieldError, CustomFieldValueError, CustomTargetingError, DateTimeRangeTargetingError, DayPartTargetingError, EntityLimitReachedError, FeatureError, FileError, ForecastError, FrequencyCapError, GenericTargetingError, GeoTargetingError, ImageError, InternalApiError, InvalidColorError, InvalidEmailError, InvalidUrlError, InventoryTargetingError, InventoryUnitError, InventoryUnitPartnerAssociationError, InventoryUnitSizesError, LabelEntityAssociationError, LabelError, LineItemCreativeAssociationError, LineItemCreativeAssociationOperationError, LineItemError, LineItemFlightDateError, LineItemOperationError, NotNullError, NullError, OrderActionError, OrderError, ParseError, PermissionError, PlacementError, PoddingError, PublisherQueryLanguageContextError, PublisherQueryLanguageSyntaxError, QuotaError, RangeError, RegExError, ReportError, RequiredCollectionError, RequiredError, RequiredNumberError, RequiredSizeError, ReservationDetailsError, RichMediaStudioCreativeError, ServerError, StatementError, StringLengthError, TeamError, TechnologyTargetingError, TemplateInstantiatedCreativeError, TypeError, UniqueError, UserDomainTargetingError

public abstract class ApiError
extends Object
implements Serializable

The API error base class that provides details about an error that occurred while processing a service request.

The OGNL field path is provided for parsers to identify the request data element that may have caused the error.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ApiError()
ApiError(String fieldPath, String trigger, String errorString, String apiErrorType)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getApiErrorType() Gets the apiErrorType value for this ApiError.
static org.apache.axis.encoding.Deserializer	getDeserializer(String mechType, Class _javaType, QName _xmlType) Get Custom Deserializer
String	getErrorString() Gets the errorString value for this ApiError.
String	getFieldPath() Gets the fieldPath value for this ApiError.
static org.apache.axis.encoding.Serializer	getSerializer(String mechType, Class _javaType, QName _xmlType) Get Custom Serializer
String	getTrigger() Gets the trigger value for this ApiError.
static org.apache.axis.description.TypeDesc	getTypeDesc() Return type metadata object
int	hashCode()
void	setApiErrorType(String apiErrorType) Sets the apiErrorType value for this ApiError.
void	setErrorString(String errorString) Sets the errorString value for this ApiError.
void	setFieldPath(String fieldPath) Sets the fieldPath value for this ApiError.
void	setTrigger(String trigger) Sets the trigger value for this ApiError.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiError

public ApiError()

ApiError

public ApiError(String fieldPath,
        String trigger,
        String errorString,
        String apiErrorType)

Method Detail

getFieldPath

public String getFieldPath()

Gets the fieldPath value for this ApiError.

Returns:

fieldPath * The OGNL field path to identify cause of error.

setFieldPath

public void setFieldPath(String fieldPath)

Sets the fieldPath value for this ApiError.

Parameters:

fieldPath - * The OGNL field path to identify cause of error.

getTrigger

public String getTrigger()

Gets the trigger value for this ApiError.

Returns:

trigger * The data that caused the error.

setTrigger

public void setTrigger(String trigger)

Sets the trigger value for this ApiError.

Parameters:

trigger - * The data that caused the error.

getErrorString

public String getErrorString()

Gets the errorString value for this ApiError.

Returns:

errorString * A simple string representation of the error and reason.

setErrorString

public void setErrorString(String errorString)

Sets the errorString value for this ApiError.

Parameters:

errorString - * A simple string representation of the error and reason.

getApiErrorType

public String getApiErrorType()

Gets the apiErrorType value for this ApiError.

Returns:

apiErrorType * Indicates that this instance is a subtype of ApiError. Although this field is returned in the response, it is ignored on input and cannot be selected. Specify xsi:type instead.

setApiErrorType

public void setApiErrorType(String apiErrorType)

Sets the apiErrorType value for this ApiError.

Parameters:

apiErrorType - * Indicates that this instance is a subtype of ApiError. Although this field is returned in the response, it is ignored on input and cannot be selected. Specify xsi:type instead.

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()

Return type metadata object

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(String mechType,
                                                Class _javaType,
                                                QName _xmlType)

Get Custom Serializer

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(String mechType,
                                                    Class _javaType,
                                                    QName _xmlType)

Get Custom Deserializer