com.microsoft.bingads.v10.bulk.DownloadParameters 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.23.2
Show newest version
package com.microsoft.bingads.v10.bulk;

import java.io.File;
import java.util.Calendar;
import java.util.Collection;
import java.util.List;

import com.microsoft.bingads.v10.bulk.DownloadFileType;


/**
 * Describes the available parameters when performing a download, such as the type of entities and data scope that you want to download. 
 */
public class DownloadParameters {

    private SubmitDownloadParameters submitDownloadParameters;

    SubmitDownloadParameters getSubmitDownloadParameters() {
        return submitDownloadParameters;
    }

    void setSubmitDownloadParameters(SubmitDownloadParameters submitParams) {
        this.submitDownloadParameters = submitParams;
    }

    private File resultFileDirectory;
    private String resultFileName;

    /**
     * Gets or sets a value indicating whether the local result file should be
     * overwritten if it already exists.
     */
    private boolean overwriteResultFile;

    public DownloadParameters() {
        this.submitDownloadParameters = new SubmitDownloadParameters();
    }

    /**
     * Gets the extension type of the downloaded file. For possible values, see
     * DownloadFileType Value Set at
     * http://go.microsoft.com/fwlink/?LinkId=620273.
     */
    public DownloadFileType getFileType() {
        return this.submitDownloadParameters.getFileType();
    }

    /**
     * Sets the extension type of the downloaded file. For possible values, see
     * DownloadFileType Value Set at
     * http://go.microsoft.com/fwlink/?LinkId=620273.
     */
    public void setFileType(DownloadFileType fileType) {
        this.submitDownloadParameters.setFileType(fileType);
    }

    /**
     * Gets the scope or types of data to download. For possible values, see
     * DataScope Value Set at
     * http://go.microsoft.com/fwlink/?LinkId=620271.
     */
    public Collection getDataScope() {
        return this.submitDownloadParameters.getDataScope();
    }
    
    /**
     * Sets the scope or types of data to download. For possible values, see
     * DataScope Value Set at
     * http://go.microsoft.com/fwlink/?LinkId=620271.
     */
    public void setDataScope(Collection value) {
        this.submitDownloadParameters.setDataScope(value);
    }

    /**
     * Gets the type of entities to download. For possible values, see
     * BulkDownloadEntity Value Set at
     * http://go.microsoft.com/fwlink/?LinkId=620272.
     */
    public Collection getEntities() {
        return this.submitDownloadParameters.getEntities();
    }

    /**
     * Sets the type of entities to download. For possible values, see
     * BulkDownloadEntity Value Set at
     * http://go.microsoft.com/fwlink/?LinkId=620272.
     */
    public void setEntities(Collection entities) {
        submitDownloadParameters.setEntities(entities);
    }

    /**
     * Gets the Ids of the campaigns to download. You can specify a maximum of 1,000 campaigns.
     * The campaigns that you specify must belong to the same account.
     */
    public List getCampaignIds() {
        return this.submitDownloadParameters.getCampaignIds();
    }

    /**
     * Sets the Ids of the campaigns to download. You can specify a maximum of 1,000 campaigns.
     * The campaigns that you specify must belong to the same account.
     */
    public void setCampaignIds(List campaignIds) {
        this.submitDownloadParameters.setCampaignIds(campaignIds);
    }

    /**
     * Gets the last time that you requested a download. The date and time is
     * expressed in Coordinated Universal Time (UTC). Typically, you request a
     * full download the first time you call the operation by setting this
     * element to null. On all subsequent calls you set the last sync time to
     * the time stamp of the previous download. The download file contains the
     * time stamp of the download in the SyncTime column of the Account record.
     * Use the time stamp to set LastSyncTimeInUTC the next time that you
     * request a download. If you specify the last sync time, only those
     * entities that have changed (been updated or deleted) since the specified
     * date and time will be downloaded. However, if the campaign data has not
     * been previously downloaded, the operation performs a full download.
     */
    public Calendar getLastSyncTimeInUTC() {
        return this.submitDownloadParameters.getLastSyncTimeInUTC();
    }

    /**
     * Sets the last time that you requested a download. The date and time is
     * expressed in Coordinated Universal Time (UTC). Typically, you request a
     * full download the first time you call the operation by setting this
     * element to null. On all subsequent calls you set the last sync time to
     * the time stamp of the previous download. The download file contains the
     * time stamp of the download in the SyncTime column of the Account record.
     * Use the time stamp to set LastSyncTimeInUTC the next time that you
     * request a download. If you specify the last sync time, only those
     * entities that have changed (been updated or deleted) since the specified
     * date and time will be downloaded. However, if the campaign data has not
     * been previously downloaded, the operation performs a full download.
     */
    public void setLastSyncTimeInUTC(Calendar lastSyncTimeInUTC) {
        this.submitDownloadParameters.setLastSyncTimeInUTC(lastSyncTimeInUTC);
    }

    /**
     * Gets the date range values for the requested performance data in a bulk
     * download. For possible values, see PerformanceStatsDateRange Data Object
     * at http://go.microsoft.com/fwlink/?LinkId=620274.
     */
    public PerformanceStatsDateRange getPerformanceStatsDateRange() {
        return this.submitDownloadParameters.getPerformanceStatsDateRange();
    }

    /**
     * Sets the date range values for the requested performance data in a bulk
     * download. For possible values, see PerformanceStatsDateRange Data Object
     * at http://go.microsoft.com/fwlink/?LinkId=620274.
     */
    public void setPerformanceStatsDateRange(
            PerformanceStatsDateRange performanceStatsDateRange) {
        this.submitDownloadParameters.setPerformanceStatsDateRange(performanceStatsDateRange);
    }

    /**
     * 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 download result file.
     */
    public String getResultFileName() {
        return resultFileName;
    }

    /**
     * Sets the name of the local download result file.
     */
    public void setResultFileName(String resultFileName) {
        this.resultFileName = resultFileName;
    }

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

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