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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of microsoft.bingads Show documentation

The Bing Ads Java SDK is a library improving developer experience when working with the Bing Ads services by providing high-level access to features such as Bulk API, OAuth Authorization and SOAP API.

There is a newer version: 13.0.22.1

Show newest version

package com.microsoft.bingads.v13.bulk;

import java.io.File;


/**
 * Describes the available parameters when submitting a file for upload, such as the path of the upload result file. 
 */
public class FileUploadParameters {

    private final SubmitUploadParameters submitUploadParameters = new SubmitUploadParameters();
    
    private File resultFileDirectory;

    private String resultFileName;

    private boolean overwriteResultFile;
    
    private boolean autoDeleteTempFile;

    /**
     * Reserved for internal use.
     */
    SubmitUploadParameters getSubmitUploadParameters() {
        return submitUploadParameters;
    }

    /**
     * Gets the directory where the file will be downloaded.
     */
    public File getResultFileDirectory() {
        return resultFileDirectory;
    }

    /**
     * Sets the directory where the file will be downloaded.
     */
    public void setResultFileDirectory(File resultFileDirectory) {
        this.resultFileDirectory = resultFileDirectory;
    }

    /**
     * Gets the name of the local result file.
     */
    public String getResultFileName() {
        return resultFileName;
    }

    /**
     * Sets the name of the local result file.
     */
    public void setResultFileName(String resultFileName) {
        this.resultFileName = resultFileName;
    }
    
    /**
     * Gets whether the bulk service should return success and error results or only error results.
     */
    public ResponseMode getResponseMode() {
        return submitUploadParameters.getResponseMode();
    }
    
    /**
     * Sets whether the bulk service should return success and error results or only error results.
     */
    public void setResponseMode(ResponseMode value) {
        submitUploadParameters.setResponseMode(value);
    }
    
    /**
     * Gets the fully qualified local path of the upload file.
     */
    public File getUploadFilePath() {
        return submitUploadParameters.getUploadFilePath();
    }
    
    /**
     * Sets the fully qualified local path of the upload file.
     */
    public void setUploadFilePath(File value) {
        submitUploadParameters.setUploadFilePath(value);
    }

    /**
     * Get whether the upload file should be compressed before uploading. The default value is True.
     */
    public boolean getCompressUploadFile() {
        return submitUploadParameters.getCompressUploadFile();
    }

    /**
     * Set whether the upload file should be compressed before uploading. The default value is True.
     */
    public void setCompressUploadFile(boolean compressUploadFile) {
        submitUploadParameters.setCompressUploadFile(compressUploadFile);
    }

    /**
     * Gets whether the local result file should be overwritten if it already exists.
     */
    public boolean getOverwriteResultFile() {
        return overwriteResultFile;
    }

    /**
     * Gets whether the local result file should be overwritten if it already exists.
     */
    public void setOverwriteResultFile(boolean overwriteResultFile) {
        this.overwriteResultFile = overwriteResultFile;
    }

    /**
     * Gets whether the temporary upload file should be deleted.
     */
	public boolean getAutoDeleteTempFile() {
		return autoDeleteTempFile;
	}

    /**
     * Sets whether the temporary upload file should be deleted.
     */
	public void setAutoDeleteTempFile(boolean autoDeleteTempFile) {
		this.autoDeleteTempFile = autoDeleteTempFile;
	}

    /**
     * Gets whether the upload file should be named with request id.
     */
    public boolean getRenameUploadFileToMatchRequestId() {
        return submitUploadParameters.getRenameUploadFileToMatchRequestId();
    }

    /**
     * Sets whether the upload file should be named with request id.
     */
    public void setRenameUploadFileToMatchRequestId(boolean arg) {
        submitUploadParameters.submitUploadParameters(arg);
    }
}