com.microsoft.bingads.v13.bulk.SubmitUploadParameters 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 minimum available parameters when submitting a file for upload, such as the path of the upload file. 
 */
public class SubmitUploadParameters {

    private ResponseMode responseMode;

    private File uploadFilePath;

    private boolean compressUploadFile;

    private boolean renameUploadFileToMatchRequestId;

    /**
     * Initializes a new instance of the class
     */
    protected SubmitUploadParameters() {
        responseMode = ResponseMode.ERRORS_AND_RESULTS;

        compressUploadFile = true;
    }

    /**
     * Gets whether the bulk service should return upload errors with the corresponding entity data.
     */
    public ResponseMode getResponseMode() {
        return responseMode;
    }

    /**
     * Sets whether the bulk service should return upload errors with the corresponding entity data.
     */
    public void setResponseMode(ResponseMode responseMode) {
        this.responseMode = responseMode;
    }
    
    /**
     * Gets the fully qualified local path of the upload file.
     */
    public File getUploadFilePath() {
        return uploadFilePath;
    }

    /**
     * Sets the fully qualified local path of the upload file.
     */
    public void setUploadFilePath(File uploadFilePath) {
        this.uploadFilePath = uploadFilePath;
    }

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

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

    public boolean getRenameUploadFileToMatchRequestId() {
        return this.renameUploadFileToMatchRequestId;
    }

    public void submitUploadParameters(boolean arg) {
        this.renameUploadFileToMatchRequestId = arg;
        
    }
}