// Copyright 2016 Google Inc. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.api.ads.dfp.jaxws.v201608;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlSeeAlso;
import javax.xml.bind.annotation.XmlType;
/**
*
* The API error base class that provides details about an error that occurred
* while processing a service request.
*
* <p>The OGNL field path is provided for parsers to identify the request data
* element that may have caused the error.</p>
*
*
* <p>Java class for ApiError complex type.
*
* <p>The following schema fragment specifies the expected content contained within this class.
*
* <pre>
* <complexType name="ApiError">
* <complexContent>
* <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
* <sequence>
* <element name="fieldPath" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
* <element name="trigger" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
* <element name="errorString" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
* </sequence>
* </restriction>
* </complexContent>
* </complexType>
* </pre>
*
*
*/
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "ApiError", propOrder = {
"fieldPath",
"trigger",
"errorString"
})
@XmlSeeAlso({
PackageActionError.class,
TemplateInstantiatedCreativeError.class,
PublisherQueryLanguageContextError.class,
ContentMetadataTargetingError.class,
CustomFieldError.class,
AdSenseAccountError.class,
CreativeTemplateError.class,
ActivityError.class,
ForecastError.class,
DateTimeRangeTargetingError.class,
GenericTargetingError.class,
ServerError.class,
PrecisionError.class,
AdRuleFrequencyCapError.class,
UserDomainTargetingError.class,
CustomCreativeError.class,
RequiredSizeError.class,
RequiredCollectionError.class,
ProposalLineItemActionError.class,
ContentPartnerError.class,
CompanyCreditStatusError.class,
ContactError.class,
QuotaError.class,
WorkflowActionError.class,
CreativeWrapperError.class,
ClickTrackingLineItemError.class,
ParseError.class,
SetTopBoxCreativeError.class,
AdRuleDateError.class,
TeamError.class,
LiveStreamEventActionError.class,
SamSessionError.class,
ProgrammaticError.class,
CompanyError.class,
ProductPackageItemError.class,
TypeError.class,
ContentMetadataKeyHierarchyError.class,
InvalidPhoneNumberError.class,
TimeZoneError.class,
AdRuleSlotError.class,
InventoryUnitPartnerAssociationError.class,
FrequencyCapError.class,
ProductError.class,
CreativeAssetMacroError.class,
AdUnitHierarchyError.class,
ImageError.class,
StatementError.class,
PoddingError.class,
AuthenticationError.class,
ReservationDetailsError.class,
InternalApiError.class,
CreativeError.class,
LineItemFlightDateError.class,
PublisherQueryLanguageSyntaxError.class,
HtmlBundleProcessorError.class,
ProgrammaticProductError.class,
NotNullError.class,
WorkflowRequestError.class,
AdRulePriorityError.class,
TechnologyTargetingError.class,
BaseRateError.class,
AudienceExtensionError.class,
RangeError.class,
BillingError.class,
LineItemCreativeAssociationOperationError.class,
ExchangeRateError.class,
AvailableBillingError.class,
LineItemCreativeAssociationError.class,
ProductActionError.class,
ProductPackageItemActionError.class,
PlacementError.class,
ProposalActionError.class,
SwiffyConversionError.class,
LabelError.class,
NullError.class,
ApiVersionError.class,
ProductTemplateError.class,
StringLengthError.class,
CollectionSizeError.class,
InvalidEmailError.class,
FeatureError.class,
GrpSettingsError.class,
TokenError.class,
RequiredError.class,
OrderActionError.class,
OrderError.class,
CrossSellError.class,
InventoryTargetingError.class,
DayPartTargetingError.class,
LineItemOperationError.class,
CustomTargetingError.class,
WorkflowValidationError.class,
AssetError.class,
CreativeSetError.class,
InvalidUrlError.class,
DealError.class,
EntityChildrenLimitReachedError.class,
ReconciliationImportError.class,
CustomFieldValueError.class,
RichMediaStudioCreativeError.class,
LineItemError.class,
AdUnitTypeError.class,
InventoryUnitError.class,
ReconciliationError.class,
InvalidColorError.class,
CreativePreviewError.class,
InventoryUnitSizesError.class,
ProposalLineItemError.class,
PackageError.class,
CommonError.class,
AudienceSegmentError.class,
GeoTargetingError.class,
ProductPackageRateCardAssociationError.class,
FileError.class,
ProductTemplateActionError.class,
ReportError.class,
LiveStreamEventDateTimeError.class,
ProposalLineItemProgrammaticError.class,
AdUnitCodeError.class,
SetTopBoxLineItemError.class,
EntityLimitReachedError.class,
RequiredNumberError.class,
ProposalError.class,
LineItemActivityAssociationError.class,
PremiumRateError.class,
RegExError.class,
UniqueError.class,
PermissionError.class,
AdExclusionRuleError.class,
VideoPositionTargetingError.class,
BaseRateActionError.class,
ProgrammaticEntitiesError.class,
CreativeTemplateOperationError.class,
NetworkError.class,
InventoryUnitRefreshRateError.class,
NonProgrammaticProductError.class,
RateCardActionError.class,
LabelEntityAssociationError.class,
RateCardError.class,
ProductPackageActionError.class
})
public abstract class ApiError {
protected String fieldPath;
protected String trigger;
protected String errorString;
/**
* Gets the value of the fieldPath property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getFieldPath() {
return fieldPath;
}
/**
* Sets the value of the fieldPath property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setFieldPath(String value) {
this.fieldPath = value;
}
/**
* Gets the value of the trigger property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getTrigger() {
return trigger;
}
/**
* Sets the value of the trigger property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setTrigger(String value) {
this.trigger = value;
}
/**
* Gets the value of the errorString property.
*
* @return
* possible object is
* {@link String }
*
*/
public String getErrorString() {
return errorString;
}
/**
* Sets the value of the errorString property.
*
* @param value
* allowed object is
* {@link String }
*
*/
public void setErrorString(String value) {
this.errorString = value;
}
}