com.microsoft.bingads.v13.bulk.BulkUploadOperation Maven / Gradle / Ivy

Go to download
package com.microsoft.bingads.v13.bulk;

import java.util.List;

import com.microsoft.bingads.ApiEnvironment;
import com.microsoft.bingads.AuthorizationData;
import com.microsoft.bingads.v13.internal.bulk.UploadStatusProvider;

/**
 * Represents a bulk upload operation requested by a user.
 *
 * 
 * Example: {@link BulkServiceManager#submitUploadAsync} method returns an instance of this
 * class. If for any reason you do not want to wait for the file to finish
 * uploading, for example if your application quits unexpectedly or you have
 * other tasks to process, you can use an instance of
 * {@link BulkUploadOperation} to download the upload results file when it is
 * available.
 * 
 *
 */
public class BulkUploadOperation extends BulkOperation {

    /**
     * Initializes a new instance of this class with the specified requestId and authorization data.
     *
     * @param requestId The identifier of an upload request that has previously been submitted.
     * @param authorizationData Represents a user who intends to access the corresponding customer and account.
     */
	public BulkUploadOperation(String requestId, AuthorizationData authorizationData, IBulkService service) {
        this(requestId, authorizationData, service, null, null);
    }
    
    public BulkUploadOperation(String requestId, AuthorizationData authorizationData, IBulkService service, ApiEnvironment apiEnvironment) {
    	this(requestId, authorizationData, service, null, apiEnvironment);
    }

    protected BulkUploadOperation(String requestId, AuthorizationData authorizationData, IBulkService service, String trackingId) {
    	this(requestId, authorizationData, service, trackingId, null);
    }
    
    protected BulkUploadOperation(String requestId, AuthorizationData authorizationData, IBulkService service, String trackingId, ApiEnvironment apiEnvironment) {
        super(requestId, authorizationData, new UploadStatusProvider(requestId), trackingId, apiEnvironment);
    }

    @Override
    RuntimeException getOperationCouldNotBeCompletedException(List errors, UploadStatus status) {
        return new BulkUploadCouldNotBeCompletedException(errors, status);
    }
}