Package com.google.ads.googleads.lib.utils

Class AbstractErrorUtils.ErrorPath<GoogleAdsErrorType extends com.google.protobuf.Message>

java.lang.Object

com.google.ads.googleads.lib.utils.AbstractErrorUtils.ErrorPath<GoogleAdsErrorType>

Enclosing class:

AbstractErrorUtils<GoogleAdsFailureT extends com.google.protobuf.Message,GoogleAdsErrorT extends com.google.protobuf.Message,FieldPathElementT extends com.google.protobuf.Message>

protected static class AbstractErrorUtils.ErrorPath<GoogleAdsErrorType extends com.google.protobuf.Message>
extends Object

Wrapper around a (@link GoogleAdsErrorT} specifying the location the error occurred, if available.

Although multiple field paths are possible in a GoogleAdsError, this object only contains the first FieldPathElement. Currently this is the only element required to identify which operation caused the failure, though future updates may expand on this class to provide additional information from the FieldPathElements.

Constructor Summary

Constructors

Constructor	Description
ErrorPath(GoogleAdsErrorType error, String fieldName, Optional<Long> index)

Method Summary

Modifier and Type	Method	Description
GoogleAdsErrorType	getError()
String	getFieldName()
Optional<Long>	getIndex()	Returns the index portion of this error path element.
boolean	isOperationIndex()	Returns if the field represents the portion of the error path that identifies the index of an operation in a request.

Methods inherited from class java.lang.Object

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

Constructor Details

ErrorPath

public ErrorPath(GoogleAdsErrorType error,
 String fieldName,
 Optional<Long> index)

Method Details

getError

public GoogleAdsErrorType getError()

getFieldName

public String getFieldName()

getIndex

public Optional<Long> getIndex()

Returns the index portion of this error path element.

isOperationIndex

public boolean isOperationIndex()

Returns if the field represents the portion of the error path that identifies the index of an operation in a request.