com.microsoft.bingads.v13.reporting

Class ReportingDownloadOperation

java.lang.Object

com.microsoft.bingads.v13.reporting.ReportingDownloadOperation

public class ReportingDownloadOperation
extends Object

Reserved for internal use. Represent a reporting download operation requested by a user. You can use it to poll for the download operation status, and then download the results file when available.

Constructor Summary

Constructors

Constructor and Description
ReportingDownloadOperation(String requestId, AuthorizationData authorizationData)
ReportingDownloadOperation(String requestId, AuthorizationData authorizationData, ApiEnvironment apiEnvironment)

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 reporting download 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.
ReportingOperationStatus	getFinalStatus()
HttpFileService	getHttpFileService()
String	getRequestId()
ServiceClient<IReportingService>	getServiceClient()
Future<ReportingOperationStatus>	getStatusAsync(AsyncCallback<ReportingOperationStatus> callback) Gets the status of the reporting download operation.
int	getStatusPollIntervalInMilliseconds() Gets the time interval in milliseconds between two status polling attempts.
ReportingStatusProvider	getStatusProvider()
String	getTrackingId()
ZipExtractor	getZipExtractor()
void	setDownloadHttpTimeoutInMilliseconds(int downloadHttpTimeoutInMilliseconds) Sets the timeout of HttpClient download operation.
void	setFinalStatus(ReportingOperationStatus finalStatus)
void	setHttpFileService(HttpFileService httpFileService)
void	setRequestId(String requestId)
void	setServiceClient(ServiceClient<IReportingService> serviceClient)
void	setStatusPollIntervalInMilliseconds(int statusPollIntervalInMilliseconds) Sets the time interval in milliseconds between two status polling attempts.
void	setStatusProvider(ReportingStatusProvider statusProvider)
void	setTrackingId(String trackingId)
void	setZipExtractor(ZipExtractor zipExtractor)
Future<ReportingOperationStatus>	trackAsync(AsyncCallback<ReportingOperationStatus> callback) Runs asynchronously until the reporting service has finished processing the reporting download operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReportingDownloadOperation

public ReportingDownloadOperation(String requestId,
                                  AuthorizationData authorizationData)

Parameters:

requestId -

authorizationData -

ReportingDownloadOperation

public ReportingDownloadOperation(String requestId,
                                  AuthorizationData authorizationData,
                                  ApiEnvironment apiEnvironment)

Method Detail

trackAsync

public Future<ReportingOperationStatus> trackAsync(AsyncCallback<ReportingOperationStatus> callback)

Runs asynchronously until the reporting service has finished processing the reporting download operation.

Parameters:

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

Returns:

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

getStatusAsync

public Future<ReportingOperationStatus> getStatusAsync(AsyncCallback<ReportingOperationStatus> callback)

Gets the status of the reporting download operation.

Returns:

a ReportingOperationStatus object pointing to the current status of the reporting download operation in Future

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 reporting download 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

getAuthorizationData

public AuthorizationData getAuthorizationData()

Returns:

the authorizationData

getRequestId

public String getRequestId()

Returns:

the requestId

setRequestId

public void setRequestId(String requestId)

Parameters:

requestId - the requestId to set

getTrackingId

public String getTrackingId()

Returns:

the trackingId

setTrackingId

public void setTrackingId(String trackingId)

Parameters:

trackingId - the trackingId to set

getStatusProvider

public ReportingStatusProvider getStatusProvider()

Returns:

the statusProvider

setStatusProvider

public void setStatusProvider(ReportingStatusProvider statusProvider)

Parameters:

statusProvider - the statusProvider to set

getHttpFileService

public HttpFileService getHttpFileService()

Returns:

the httpFileService

setHttpFileService

public void setHttpFileService(HttpFileService httpFileService)

Parameters:

httpFileService - the httpFileService to set

getZipExtractor

public ZipExtractor getZipExtractor()

Returns:

the zipExtractor

setZipExtractor

public void setZipExtractor(ZipExtractor zipExtractor)

Parameters:

zipExtractor - the zipExtractor to set

getServiceClient

public ServiceClient<IReportingService> getServiceClient()

Returns:

the serviceClient

setServiceClient

public void setServiceClient(ServiceClient<IReportingService> serviceClient)

Parameters:

serviceClient - the serviceClient to set

getFinalStatus

public ReportingOperationStatus getFinalStatus()

Returns:

the finalStatus

setFinalStatus

public void setFinalStatus(ReportingOperationStatus finalStatus)

Parameters:

finalStatus - the finalStatus to set

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).