com.obs.services.model.ListVersionsResult Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of esdk-obs-java-bundle Show documentation
The HuaweiCloud OBS Bundle SDK for Java used for accessing Object Storage Service, this SDK bundle includes third-party libraries and relocated to different namespaces
The newest version!
/**
* Copyright 2019 Huawei Technologies Co.,Ltd.
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use
* this file except in compliance with the License.  You may obtain a copy of the
* License at
* 
* http://www.apache.org/licenses/LICENSE-2.0
* 
* Unless required by applicable law or agreed to in writing, software distributed
* under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied.  See the License for the
* specific language governing permissions and limitations under the License.
**/

package com.obs.services.model;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

/**
 * Response to a request for listing versioning objects in a bucket
 */
public class ListVersionsResult extends HeaderResponse {
    private String bucketName;

    private String prefix;

    private String keyMarker;

    private String nextKeyMarker;

    private String versionIdMarker;

    private String nextVersionIdMarker;

    private String maxKeys;

    private boolean isTruncated;

    private VersionOrDeleteMarker[] versions;

    private List commonPrefixes;

    private String location;

    private String delimiter;

    @Deprecated
    //CHECKSTYLE:OFF
    public ListVersionsResult(String bucketName, String prefix, String keyMarker, String nextKeyMarker,
            String versionIdMarker, String nextVersionIdMarker, String maxKeys, boolean isTruncated,
            VersionOrDeleteMarker[] versions, List commonPrefixes, String location, String delimiter) {
        super();
        this.bucketName = bucketName;
        this.prefix = prefix;
        this.keyMarker = keyMarker;
        this.nextKeyMarker = nextKeyMarker;
        this.versionIdMarker = versionIdMarker;
        this.nextVersionIdMarker = nextVersionIdMarker;
        this.maxKeys = maxKeys;
        this.isTruncated = isTruncated;
        if (null != versions) {
            this.versions = versions.clone();
        } else {
            this.versions = null;
        }
        this.commonPrefixes = commonPrefixes;
        this.location = location;
        this.delimiter = delimiter;
    }

    private ListVersionsResult(Builder builder) {
        super();
        this.bucketName = builder.bucketName;
        this.prefix = builder.prefix;
        this.keyMarker = builder.keyMarker;
        this.nextKeyMarker = builder.nextKeyMarker;
        this.versionIdMarker = builder.versionIdMarker;
        this.nextVersionIdMarker = builder.nextVersionIdMarker;
        this.maxKeys = builder.maxKeys;
        this.isTruncated = builder.isTruncated;
        if (null != builder.versions) {
            this.versions = builder.versions.clone();
        } else {
            this.versions = null;
        }
        this.commonPrefixes = builder.commonPrefixes;
        this.location = builder.location;
        this.delimiter = builder.delimiter;
    }
    
    public static final class Builder {
        private String bucketName;
        private String prefix;
        private String keyMarker;
        private String nextKeyMarker;
        private String versionIdMarker;
        private String nextVersionIdMarker;
        private String maxKeys;
        private boolean isTruncated;
        private VersionOrDeleteMarker[] versions;
        private List commonPrefixes;
        private String location;
        private String delimiter;
        
        public Builder bucketName(String bucketName) {
            this.bucketName = bucketName;
            return this;
        }
        
        public Builder prefix(String prefix) {
            this.prefix = prefix;
            return this;
        }
        
        public Builder keyMarker(String keyMarker) {
            this.keyMarker = keyMarker;
            return this;
        }
        
        public Builder nextKeyMarker(String nextKeyMarker) {
            this.nextKeyMarker = nextKeyMarker;
            return this;
        }
        
        public Builder versionIdMarker(String versionIdMarker) {
            this.versionIdMarker = versionIdMarker;
            return this;
        }
        
        public Builder nextVersionIdMarker(String nextVersionIdMarker) {
            this.nextVersionIdMarker = nextVersionIdMarker;
            return this;
        }
        
        public Builder maxKeys(String maxKeys) {
            this.maxKeys = maxKeys;
            return this;
        }
        
        public Builder isTruncated(boolean isTruncated) {
            this.isTruncated = isTruncated;
            return this;
        }
        
        public Builder versions(VersionOrDeleteMarker[] versions) {
            if (null != versions) {
                this.versions = versions.clone();
            } else {
                this.versions = null;
            }
            return this;
        }
        
        public Builder commonPrefixes(List commonPrefixes) {
            this.commonPrefixes = commonPrefixes;
            return this;
        }
        
        public Builder location(String location) {
            this.location = location;
            return this;
        }
        
        public Builder delimiter(String delimiter) {
            this.delimiter = delimiter;
            return this;
        }
        
        public ListVersionsResult builder() {
            return new ListVersionsResult(this);
        }
    }
    
    /**
     * Obtain the bucket name.
     * 
     * @return Bucket name
     */
    public String getBucketName() {
        return bucketName;
    }

    /**
     * Obtain the object name prefix used for listing versioning objects.
     * 
     * @return Object name prefix used for listing versioning objects
     */
    public String getPrefix() {
        return prefix;
    }

    /**
     * Obtain the start position for listing versioning objects (sorted by
     * object name).
     * 
     * @return Start position for listing objects
     */
    public String getKeyMarker() {
        return keyMarker;
    }

    /**
     * Obtain the start position for listing versioning objects (sorted by
     * version ID).
     * 
     * @return Start position for listing objects
     */
    public String getVersionIdMarker() {
        return versionIdMarker;
    }

    /**
     * Obtain the maximum number of versioning objects to be listed.
     * 
     * @return Maximum number of versioning objects to be listed
     */
    public String getMaxKeys() {
        return maxKeys;
    }

    /**
     * Check whether the query result list is truncated. Value "true" indicates
     * that the results are incomplete while value "false" indicates that the
     * results are complete.
     * 
     * @return Truncation identifier
     */
    public boolean isTruncated() {
        return isTruncated;
    }

    /**
     * Obtain the versioning object array in the bucket.
     * 
     * @return Versioning object array in the bucket. For details, see
     *         {@link VersionOrDeleteMarker}.
     */
    public VersionOrDeleteMarker[] getVersions() {
        if (null != versions) {
            return versions.clone(); 
        }
        return new VersionOrDeleteMarker[0];
    }

    /**
     * Start position for next listing (sorted by object name)
     * 
     * @return Start position for next listing
     */
    public String getNextKeyMarker() {
        return nextKeyMarker;
    }

    /**
     * Obtain the start position for next listing (sorted by version ID).
     * 
     * @return Start position for next listing
     */
    public String getNextVersionIdMarker() {
        return nextVersionIdMarker;
    }

    /**
     * Obtain the list of prefixes to the names of grouped objects.
     * 
     * @return List of prefixes to the names of grouped objects
     */
    public List getCommonPrefixes() {
        if (commonPrefixes == null) {
            commonPrefixes = new ArrayList();
        }
        return commonPrefixes;
    }

    /**
     * Obtain the bucket location.
     * 
     * @return Bucket location
     */
    public String getLocation() {
        return location;
    }

    /**
     * Obtain the character for grouping object names.
     * 
     * @return Character for grouping object names
     */
    public String getDelimiter() {
        return delimiter;
    }

    @Override
    public String toString() {
        return "ListVersionsResult [bucketName=" + bucketName + ", prefix=" + prefix + ", keyMarker=" + keyMarker
                + ", nextKeyMarker=" + nextKeyMarker + ", versionIdMarker=" + versionIdMarker + ", nextVersionIdMarker="
                + nextVersionIdMarker + ", maxKeys=" + maxKeys + ", isTruncated=" + isTruncated + ", versions="
                + Arrays.toString(versions) + ", commonPrefixes=" + commonPrefixes + ", location=" + location
                + ", delimiter=" + delimiter + "]";
    }

}