com.microsoft.bingads.v13.bulk

Class BulkOperation<TStatus>

java.lang.Object

com.microsoft.bingads.v13.bulk.BulkOperation<TStatus>

Type Parameters:

TStatus - type of bulk operation status is being tracked

Direct Known Subclasses:

BulkDownloadOperation, BulkUploadOperation

public abstract class BulkOperation<TStatus>
extends Object

Reserved for internal use. The abstract base class that can be derived to represent a bulk operation requested by a user. You can use either the BulkDownloadOperation or BulkUploadOperation derived class to poll for the operation status, and then download the results file when available.

Method Summary

Modifier and Type	Method and Description
Future<File>	downloadResultFileAsync(File localResultDirectoryName, String localResultFileName, boolean decompress, AsyncCallback<File> callback) Downloads and optionally decompress the result file from the bulk operation
Future<File>	downloadResultFileAsync(File localResultDirectoryName, String localResultFileName, boolean decompress, boolean overwrite, AsyncCallback<File> callback) Downloads and optionally decompress the result file from the bulk operation, allows to overwrite the local result file.
AuthorizationData	getAuthorizationData()
int	getDownloadHttpTimeoutInMilliseconds() Gets the timeout of HttpClient download operation.
String	getRequestId()
Future<BulkOperationStatus<TStatus>>	getStatusAsync(AsyncCallback<BulkOperationStatus<TStatus>> callback) Gets the status of the bulk operation.
int	getStatusPollIntervalInMilliseconds() Gets the time interval in milliseconds between two status polling attempts.
String	getTrackingId()
void	setDownloadHttpTimeoutInMilliseconds(int downloadHttpTimeoutInMilliseconds) Sets the timeout of HttpClient download operation.
void	setStatusPollIntervalInMilliseconds(int statusPollIntervalInMilliseconds) Sets the time interval in milliseconds between two status polling attempts.
Future<BulkOperationStatus<TStatus>>	trackAsync(AsyncCallback<BulkOperationStatus<TStatus>> callback) Runs asynchronously until the bulk service has finished processing the bulk operation.
Future<BulkOperationStatus<TStatus>>	trackAsync(Progress<BulkOperationProgressInfo> progress, AsyncCallback<BulkOperationStatus<TStatus>> callback) Runs asynchronously until the bulk service has finished processing the bulk operation.

Methods inherited from class java.lang.Object

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

Method Detail

trackAsync

public Future<BulkOperationStatus<TStatus>> trackAsync(AsyncCallback<BulkOperationStatus<TStatus>> callback)

Runs asynchronously until the bulk service has finished processing the bulk operation.

Parameters:

callback - A handler that will be called with the BulkOperation when it has completed

Returns:

a Future that will be completed when the result file is available

trackAsync

public Future<BulkOperationStatus<TStatus>> trackAsync(Progress<BulkOperationProgressInfo> progress,
                                                       AsyncCallback<BulkOperationStatus<TStatus>> callback)

Runs asynchronously until the bulk service has finished processing the bulk operation.

Parameters:

progress - An object to be updated with the progress of the operation

callback - A handler that will be called with the BulkOperation when it has completed

Returns:

a Future that will be completed when the result file is available

getStatusAsync

public Future<BulkOperationStatus<TStatus>> getStatusAsync(AsyncCallback<BulkOperationStatus<TStatus>> callback)

Gets the status of the bulk operation.

Returns:

the current status of the bulk operation

getAuthorizationData

public AuthorizationData getAuthorizationData()

getRequestId

public String getRequestId()

getTrackingId

public String getTrackingId()

getStatusPollIntervalInMilliseconds

public int getStatusPollIntervalInMilliseconds()

Gets the time interval in milliseconds between two status polling attempts. The default value is 5000 (5 second).

setStatusPollIntervalInMilliseconds

public void setStatusPollIntervalInMilliseconds(int statusPollIntervalInMilliseconds)

Sets the time interval in milliseconds between two status polling attempts. The default value is 5000 (5 second).

getDownloadHttpTimeoutInMilliseconds

public int getDownloadHttpTimeoutInMilliseconds()

Gets the timeout of HttpClient download operation. The default value is 100000(100s).

setDownloadHttpTimeoutInMilliseconds

public void setDownloadHttpTimeoutInMilliseconds(int downloadHttpTimeoutInMilliseconds)

Sets the timeout of HttpClient download operation. The default value is 100000(100s).

downloadResultFileAsync

public Future<File> downloadResultFileAsync(File localResultDirectoryName,
                                            String localResultFileName,
                                            boolean decompress,
                                            AsyncCallback<File> callback)
                                     throws IOException,
                                            URISyntaxException

Downloads and optionally decompress the result file from the bulk operation

Parameters:

localResultDirectoryName - the directory to place the result file in

localResultFileName - the name to use for final result file

decompress - indicates whether the result file should be unzipped

callback - AsyncCallback object with File

Returns:

a File object pointing to the result file wrapped in Future

Throws:

IOException

URISyntaxException

downloadResultFileAsync

public Future<File> downloadResultFileAsync(File localResultDirectoryName,
                                            String localResultFileName,
                                            boolean decompress,
                                            boolean overwrite,
                                            AsyncCallback<File> callback)
                                     throws IOException,
                                            URISyntaxException

Downloads and optionally decompress the result file from the bulk operation, allows to overwrite the local result file.

Parameters:

localResultDirectoryName - the directory to place the result file in

localResultFileName - the name to use for final result file

decompress - indicates whether the result file should be unzipped

overwrite - indicates whether can overwrite if target file exists

callback - AsyncCallback object with File

Returns:

a File object pointing to the result file wrapped in Future

Throws:

IOException

URISyntaxException