com.qiniu.storage.model.BucketLifeCycleRule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of qiniu-java-sdk Show documentation
Qiniu Cloud Storage SDK for Java
There is a newer version: 7.17.0
package com.qiniu.storage.model;

import com.google.gson.annotations.SerializedName;

/**
 * BucketLifeCycleRule 定义了关于七牛存储空间关于生命周期的一些配置，规则。

 * 比如存储空间中文件可以设置多少天后删除，多少天后转低频存储等等

 * 

 * 规则按最长前缀匹配，前缀规则优先于全局规则匹配，每个上传的文件最多匹配一个规则

 */
public class BucketLifeCycleRule {

    /**
     * 规则名称， 在设置的bucket中规则名称需要是唯一的

     * 同时长度小于50， 不能为空

     * 由字母，数字和下划线组成
     */
    @SerializedName("name")
    String name;

    /**
     * 以该前缀开头的文件应用此规则，同一个 bucket 里面前缀不能重复，规则按最长前缀匹配
     */
    @SerializedName("prefix")
    String prefix;

    /**
     * 指定存储空间内的文件多少天后删除

     * 0 - 不删除

     * > 0 表示多少天后删除
     */
    @SerializedName("delete_after_days")
    int deleteAfterDays;

    /**
     * 在多少天后转低频存储

     * 0  - 表示不转低频

     * < 0 表示上传的文件立即使用低频存储

     * > 0 表示转低频的天数
     */
    @SerializedName("to_line_after_days")
    int toLineAfterDays;

    /**
     * 指定文件上传多少天后转归档直读存储。
     * 0 表示不转归档直读存储，
     * < 0 表示上传的文件立即变归档直读存储
     * > 0 表示多少天后转归档直读存储
     */
    @SerializedName("to_archive_ir_after_days")
    int toArchiveIRAfterDays;

    /**
     * 指定文件上传多少天后转归档存储。
     * 0 表示不转归档存储，
     * < 0 表示上传的文件立即变归档存储
     * > 0 表示多少天后转归档存储
     */
    @SerializedName("to_archive_after_days")
    int toArchiveAfterDays;

    /**
     * 指定文件上传多少天后转深度归档存储。
     * 0 表示不转深度归档存储，
     * < 0 表示上传的文件立即变深度归档存储
     * > 0 表示多少天后转深度归档存储
     */
    @SerializedName("to_deep_archive_after_days")
    int toDeepArchiveAfterDays;

    public BucketLifeCycleRule(String name, String prefix) {
        this.name = name;
        this.prefix = prefix;
    }

    /**
     * 获得规则名称，在设置的bucket中规则名称是唯一的
     *
     * @return 规则名
     */
    public String getName() {
        return this.name;
    }

    /**
     * 规则名称， 在设置的bucket中规则名称需要是唯一的

     * 同时长度小于50， 不能为空

     * 由字母，数字和下划线组成
     *
     * @param name 规则名
     * @return 规则信息
     */
    public BucketLifeCycleRule setName(String name) {
        this.name = name;
        return this;
    }

    /**
     * 获得前缀
     *
     * @return 前缀
     */
    public String getPrefix() {
        return this.prefix;
    }

    /**
     * 以该前缀开头的文件应用此规则

     * 同一个 bucket 里面前缀不能重复，规则按最长前缀匹配
     *
     * @param prefix 前缀
     * @return 规则信息
     */
    public BucketLifeCycleRule setPrefix(String prefix) {
        this.prefix = prefix;
        return this;
    }

    /**
     * 获得 指定多少天后删除存储空间内的文件
     *
     * @return 多少天后删除存储空间内的文件
     */
    public int getDeleteAfterDays() {
        return this.deleteAfterDays;
    }

    /**
     * 指定存储空间内的文件多少天后删除

     * 0 - 不删除

     * 大于 0 表示多少天后删除
     *
     * @param deleteAfterDays 多少天后删除
     * @return 规则信息
     */
    public BucketLifeCycleRule setDeleteAfterDays(int deleteAfterDays) {
        this.deleteAfterDays = deleteAfterDays;
        return this;
    }

    /**
     * 获得在多少天后转低频存储
     *
     * @return 多少天后转低频存储
     */
    public int getToLineAfterDays() {
        return this.toLineAfterDays;
    }

    /**
     * 在多少天后转低频存储

     *
     * @param toLineAfterDays 0  - 表示不转低频

     *                        大于 0 表示转低频的天数
     * @return 规则信息
     */
    public BucketLifeCycleRule setToLineAfterDays(int toLineAfterDays) {
        this.toLineAfterDays = toLineAfterDays;
        return this;
    }

    /**
     * 获得在多少天后转归档直读存储
     *
     * @return 多少天后转归档直读存储
     */
    public int getToArchiveIRAfterDays() {
        return toArchiveIRAfterDays;
    }

    /**
     * 在多少天后转归档直读存储

     *
     * @param toArchiveIRAfterDays 0  - 表示不转归档直读存储

     *                             大于 0 表示多少天后转归档直读存储
     * @return 规则信息
     */
    public BucketLifeCycleRule setToArchiveIRAfterDays(int toArchiveIRAfterDays) {
        this.toArchiveIRAfterDays = toArchiveIRAfterDays;
        return this;
    }

    /**
     * 获得在多少天后转归档存储
     *
     * @return 多少天后转归档存储
     */
    public int getToArchiveAfterDays() {
        return toArchiveAfterDays;
    }

    /**
     * 在多少天后转归档存储

     *
     * @param toArchiveAfterDays 0  - 表示不转归档存储

     *                           大于 0 表示多少天后转归档存储
     * @return 规则信息
     */
    public BucketLifeCycleRule setToArchiveAfterDays(int toArchiveAfterDays) {
        this.toArchiveAfterDays = toArchiveAfterDays;
        return this;
    }

    /**
     * 获得在多少天后转深度归档存储
     *
     * @return 多少天后转深度归档存储
     */
    public int getToDeepArchiveAfterDays() {
        return toDeepArchiveAfterDays;
    }

    /**
     * 在多少天后转深度归档存储

     *
     * @param toDeepArchiveAfterDays 0  - 表示不转深度归档存储

     *                               大于 0 表示多少天后转深度归档存储
     * @return 规则信息
     */
    public BucketLifeCycleRule setToDeepArchiveAfterDays(int toDeepArchiveAfterDays) {
        this.toDeepArchiveAfterDays = toDeepArchiveAfterDays;
        return this;
    }

    /**
     * 编码成 query 参数格式
     *
     * @return query
     */
    public String asQueryString() {
        return String.format("name=%s&prefix=%s&delete_after_days=%d&to_line_after_days=%d&to_archive_ir_after_days=%d&to_archive_after_days=%d&to_deep_archive_after_days=%d",
                null == name ? "" : name,
                null == prefix ? "" : prefix,
                deleteAfterDays,
                toLineAfterDays,
                toArchiveIRAfterDays,
                toArchiveAfterDays,
                toDeepArchiveAfterDays
        );
    }

}