com.gooddata.md.maintenance.PartialMdExportToken Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gooddata-java Show documentation
GoodData Java SDK
There is a newer version: 3.12.0+api3
package com.gooddata.md.maintenance;

import static com.gooddata.util.Validate.notEmpty;

import com.fasterxml.jackson.annotation.JsonTypeInfo;
import com.fasterxml.jackson.annotation.JsonTypeName;
import org.springframework.web.util.UriTemplate;

/**
 * Partial metadata export token. Serves as configuration structure for import.
 * Serialization only.
 */
@JsonTypeName("partialMDImport")
@JsonTypeInfo(include = JsonTypeInfo.As.WRAPPER_OBJECT, use = JsonTypeInfo.Id.NAME)
public class PartialMdExportToken {

    public static final String URI = "/gdc/md/{projectId}/maintenance/partialmdimport";
    public static final UriTemplate TEMPLATE = new UriTemplate(URI);

    private final String token;
    private boolean overwriteNewer;
    private boolean updateLDMObjects;
    private boolean importAttributeProperties;

    /**
     * Creates new PartialMdExportToken.
     * 

     * Sets default values to properties:
     * 
     *     importAttributeProperties - default false
     *     overwriteNewer - default true
     *     updateLDMObjects - default false
     * 
     *
     * @param token token identifying metadata partially exported from another project
     */
    public PartialMdExportToken(String token) {
        this(token, false);
    }

    /**
     * Creates new PartialMdExportToken. For internal purposes only.
     * 

     * Sets default values to properties:
     * 
     *     overwriteNewer - default true
     *     updateLDMObjects - default false
     * 
     *
     * @param token token identifying metadata partially exported from another project
     * @param importAttributeProperties see {@link #setImportAttributeProperties(boolean)}
     */
    PartialMdExportToken(String token, boolean importAttributeProperties) {
        this.token = notEmpty(token, "token");
        setImportAttributeProperties(importAttributeProperties);
        setOverwriteNewer(true);
        setUpdateLDMObjects(false);
    }

    public String getToken() {
        return token;
    }

    public boolean isOverwriteNewer() {
        return overwriteNewer;
    }

    public boolean isUpdateLDMObjects() {
        return updateLDMObjects;
    }

    public boolean isImportAttributeProperties() {
        return importAttributeProperties;
    }

    /**
     * Sets the flag {@code overwriteNewer}.
     * If {@code true}, UDM/ADM objects are overwritten without checking modification time.
     *
     * @param overwriteNewer flag value to be set
     */
    public void setOverwriteNewer(boolean overwriteNewer) {
        this.overwriteNewer = overwriteNewer;
    }

    /**
     * Sets the flag {@code updateLDMObjects}.
     * If {@code true}, related LDM objects name, description and tags are overwritten
     *
     * @param updateLDMObjects flag value to be set
     */
    public void setUpdateLDMObjects(boolean updateLDMObjects) {
        this.updateLDMObjects = updateLDMObjects;
    }

    /**
     * Sets the flag {@code importAttributeProperties}.
     * If {@code true}, following attribute properties are cloned:
     * 
     *     for attribute - import drillDownStepAttributeDF setting
     *     for attributeDisplayForm - import type setting
     * 
     * It also implies {@code 'updateLDMObjects = true'} for all mentioned types.

     * It will not reliably work (can fail) for exports without {@code 'exportAttributeProperties = true'}.
     *
     * @param importAttributeProperties flag value to be set
     */
    public void setImportAttributeProperties(boolean importAttributeProperties) {
        this.importAttributeProperties = importAttributeProperties;
    }
}