com.google.api.ads.adwords.jaxws.utils.v201809.batchjob

Class BatchJobHelper

java.lang.Object

com.google.api.ads.adwords.jaxws.utils.v201809.batchjob.BatchJobHelper

All Implemented Interfaces:

BatchJobHelperInterface<com.google.api.ads.adwords.jaxws.v201809.cm.Operation,com.google.api.ads.adwords.jaxws.v201809.cm.Operand,com.google.api.ads.adwords.jaxws.v201809.cm.ApiError,MutateResult,BatchJobMutateResponse>

public class BatchJobHelper
extends Object
implements BatchJobHelperInterface<com.google.api.ads.adwords.jaxws.v201809.cm.Operation,com.google.api.ads.adwords.jaxws.v201809.cm.Operand,com.google.api.ads.adwords.jaxws.v201809.cm.ApiError,MutateResult,BatchJobMutateResponse>

Implementation of BatchJobHelperInterface for JAX-WS v201809.

Constructor Summary

Constructors

Constructor and Description
BatchJobHelper(AdWordsSession session)

Method Summary

Modifier and Type	Method and Description
BatchJobMutateResponse	downloadBatchJobMutateResponse(String downloadUrl) Downloads and returns the results from the attempted operations for a completed batch job.
BatchJobMutateResponse	downloadBatchJobMutateResponse(String downloadUrl, int startIndex, int numberResults) Downloads and returns a chunk of results from the attempted operations for a completed batch job.
BatchJobUploadResponse	uploadBatchJobOperations(Iterable<com.google.api.ads.adwords.jaxws.v201809.cm.Operation> operations, String uploadUrl) Uploads the specified operations to the batch job.
BatchJobUploadResponse	uploadIncrementalBatchJobOperations(Iterable<? extends com.google.api.ads.adwords.jaxws.v201809.cm.Operation> operations, boolean isLastRequest, BatchJobUploadStatus batchJobUploadStatus) Uploads the specified operations to the batch job.

Methods inherited from class java.lang.Object

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

Constructor Detail

BatchJobHelper

public BatchJobHelper(AdWordsSession session)

Method Detail

uploadBatchJobOperations

public BatchJobUploadResponse uploadBatchJobOperations(Iterable<com.google.api.ads.adwords.jaxws.v201809.cm.Operation> operations,
                                                       String uploadUrl)
                                                throws BatchJobException

Description copied from interface: BatchJobHelperInterface

Uploads the specified operations to the batch job. After this method returns successfully, the job will transition to the ACTIVE state.

Use this method if you want to upload all operations in a single request. To upload operations across multiple requests, use BatchJobHelperInterface.uploadIncrementalBatchJobOperations(Iterable, boolean, BatchJobUploadStatus) instead.

Specified by:

uploadBatchJobOperations in interface BatchJobHelperInterface<com.google.api.ads.adwords.jaxws.v201809.cm.Operation,com.google.api.ads.adwords.jaxws.v201809.cm.Operand,com.google.api.ads.adwords.jaxws.v201809.cm.ApiError,MutateResult,BatchJobMutateResponse>

Parameters:

operations - the operations to upload to the batch job

uploadUrl - the BatchJob#getUploadUrl()

Returns:

the response from the upload if the request succeeded

Throws:

BatchJobException - if the request failed

uploadIncrementalBatchJobOperations

public BatchJobUploadResponse uploadIncrementalBatchJobOperations(Iterable<? extends com.google.api.ads.adwords.jaxws.v201809.cm.Operation> operations,
                                                                  boolean isLastRequest,
                                                                  BatchJobUploadStatus batchJobUploadStatus)
                                                           throws BatchJobException

Description copied from interface: BatchJobHelperInterface

Uploads the specified operations to the batch job. Use this method if you want to upload operations incrementally. To upload all operations in a single request, use BatchJobHelperInterface.uploadBatchJobOperations(Iterable, String) instead.

If isLastRequest, then after this method returns successfully, the job will transition to the ACTIVE state.

Specified by:

uploadIncrementalBatchJobOperations in interface BatchJobHelperInterface<com.google.api.ads.adwords.jaxws.v201809.cm.Operation,com.google.api.ads.adwords.jaxws.v201809.cm.Operand,com.google.api.ads.adwords.jaxws.v201809.cm.ApiError,MutateResult,BatchJobMutateResponse>

Parameters:

operations - the operations to upload to the batch job

isLastRequest - if this is the last set of operations to upload for the job

batchJobUploadStatus - the current upload status. If this is the first upload, set the BatchJobUploadStatus.getResumableUploadUri() to the BatchJob#getUploadUrl().

Returns:

the response from the upload if the request succeeded

Throws:

BatchJobException - if the request failed

downloadBatchJobMutateResponse

public BatchJobMutateResponse downloadBatchJobMutateResponse(String downloadUrl)
                                                      throws BatchJobException

Description copied from interface: BatchJobHelperInterface

Downloads and returns the results from the attempted operations for a completed batch job.

Specified by:

downloadBatchJobMutateResponse in interface BatchJobHelperInterface<com.google.api.ads.adwords.jaxws.v201809.cm.Operation,com.google.api.ads.adwords.jaxws.v201809.cm.Operand,com.google.api.ads.adwords.jaxws.v201809.cm.ApiError,MutateResult,BatchJobMutateResponse>

Parameters:

downloadUrl - the BatchJob.getDownloadUrl()

Throws:

BatchJobException

downloadBatchJobMutateResponse

public BatchJobMutateResponse downloadBatchJobMutateResponse(String downloadUrl,
                                                             int startIndex,
                                                             int numberResults)
                                                      throws BatchJobException

Description copied from interface: BatchJobHelperInterface

Downloads and returns a chunk of results from the attempted operations for a completed batch job.

NOTE: This is only available on Axis implementations of this interface. The JAX-WS implementations will throw an UnsupportedOperationException.

Specified by:

downloadBatchJobMutateResponse in interface BatchJobHelperInterface<com.google.api.ads.adwords.jaxws.v201809.cm.Operation,com.google.api.ads.adwords.jaxws.v201809.cm.Operand,com.google.api.ads.adwords.jaxws.v201809.cm.ApiError,MutateResult,BatchJobMutateResponse>

Parameters:

downloadUrl - the BatchJob.getDownloadUrl()

startIndex - zero-based index of the first result to return

numberResults - maximum number of results to return

Throws:

BatchJobException - if unable to download the results.