com.google.api.ads.adwords.v201109.cm.BulkMutateResult
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
public class BulkMutateResult
Represents a result part of a BulkMutateJob.
Once one or more mutate operations have been processed, the bulk mutate job will eventually be completed. This means that the job will have a result corresponding to each operation. The types of results for an operation are:
ReturnValueResult: the corresponding operation
was successfully
processed and this result contains the return value of
that operation;
FailureResult or BatchFailureResult:
the corresponding
operation was in a batch that failed with errors. Please
inspect these
errors to determine if the operation itself was faulty
and if so what
errors need to be fixed before you submit this operation
as part of a
future job.LostResult: the corresponding operation was
processed - it was
either successful and had a return value, or it was a
part of a failed
batch. Unfortunately, despite our best efforts, we were
unable to
durably save the result. You may have to retrieve the
related state of
your account to determine if this operation actually succeeded.UnprocessedResult: the corresponding operation was not
processed
because the job was aborted Note: The job's status
will be
COMPLETED, signifying that although it may have
some operations
that were processed, it cannot be resumed.The results of a job are structured so that the each
operation can be
easily matched to its corresponding result. So for every
BulkMutateRequest in a job, there is a corresponding
BulkMutateResult; For every OperationStream
in a request
part, there is a corresponding OperationStreamResult;
And, for
every Operation in an operation stream, there
is an
OperationResult.
Within an operation stream, the operations are processed in atomic batches. So even one faulty operation may cause its neighboring non-faulty operations to fail just because they happened to be processed in the same batch. It is important to keep this batch failure reporting scheme in mind when handling operation failures.
There will be a single ApiException returned
for each failing
batch of operations, and it will have a similar structure
and
interpretation to the exceptions returned by the synchronous
AdWords API
services. This exception is returned in a FailureResult
that
corresponds to the first operation of the failing batch.
The exception may contain multiple errors, and each
error may have
OGNL paths that identify the faulty operation(s)
by index (or
position within the batch). The first operation in the
batch has an
implicit index of 0. The subsequent operations in the
batch have a
corresponding BatchFailureResult which explicitly
specifies the
index of the operation within the batch.
| Constructor Summary | |
|---|---|
BulkMutateResult()
|
|
BulkMutateResult(Integer partIndex,
OperationStreamResult[] operationStreamResults)
|
|
| Method Summary | |
|---|---|
boolean |
equals(Object obj)
|
static org.apache.axis.encoding.Deserializer |
getDeserializer(String mechType,
Class _javaType,
QName _xmlType)
Get Custom Deserializer |
OperationStreamResult[] |
getOperationStreamResults()
Gets the operationStreamResults value for this BulkMutateResult. |
OperationStreamResult |
getOperationStreamResults(int i)
|
Integer |
getPartIndex()
Gets the partIndex value for this BulkMutateResult. |
static org.apache.axis.encoding.Serializer |
getSerializer(String mechType,
Class _javaType,
QName _xmlType)
Get Custom Serializer |
static org.apache.axis.description.TypeDesc |
getTypeDesc()
Return type metadata object |
int |
hashCode()
|
void |
setOperationStreamResults(int i,
OperationStreamResult _value)
|
void |
setOperationStreamResults(OperationStreamResult[] operationStreamResults)
Sets the operationStreamResults value for this BulkMutateResult. |
void |
setPartIndex(Integer partIndex)
Sets the partIndex value for this BulkMutateResult. |
| Methods inherited from class java.lang.Object |
|---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public BulkMutateResult()
public BulkMutateResult(Integer partIndex,
OperationStreamResult[] operationStreamResults)
| Method Detail |
|---|
public Integer getPartIndex()
public void setPartIndex(Integer partIndex)
partIndex - * The index of this result part;
From 0 (inclusive) to numResultParts (exclusive).public OperationStreamResult[] getOperationStreamResults()
OperationStreamResult's that comprise this
result part of
the bulk mutate job. Each operation result is indexed
to its corresponding
OperationStream in the BulkMutateRequest.public void setOperationStreamResults(OperationStreamResult[] operationStreamResults)
operationStreamResults - * List of OperationStreamResult's that comprise this
result part of
the bulk mutate job. Each operation result is indexed
to its corresponding
OperationStream in the BulkMutateRequest.public OperationStreamResult getOperationStreamResults(int i)
public void setOperationStreamResults(int i,
OperationStreamResult _value)
public boolean equals(Object obj)
equals in class Objectpublic int hashCode()
hashCode in class Objectpublic static org.apache.axis.description.TypeDesc getTypeDesc()
public static org.apache.axis.encoding.Serializer getSerializer(String mechType,
Class _javaType,
QName _xmlType)
public static org.apache.axis.encoding.Deserializer getDeserializer(String mechType,
Class _javaType,
QName _xmlType)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||