All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.qcloud.cos.model.ListVersionsRequest Maven / Gradle / Ivy

Go to download

A single bundled dependency that includes all service and dependent JARs with third-party libraries relocated to different namespaces.

There is a newer version: 5.6.228
Show newest version
/*
 * Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 *
 *  http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. This file 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.
 
 * According to cos feature, we modify some class,comment, field name, etc.
 */


package com.qcloud.cos.model;

import java.io.Serializable;

import com.qcloud.cos.internal.CosServiceRequest;

public class ListVersionsRequest extends CosServiceRequest implements Serializable {
    /** The name of the COS bucket whose versions are to be listed. */
    private String bucketName;

    /**
     * Optional parameter restricting the response to keys which begin with the specified prefix.
     * You can use prefixes to separate a bucket into different sets of keys in a way similar to how
     * a file system uses folders.
     */
    private String prefix;

    /**
     * Optional parameter indicating where in the sorted list of all versions in the specified
     * bucket to begin returning results. Results are always ordered first lexicographically (i.e.
     * alphabetically) and then from most recent version to least recent version. If a keyMarker is
     * used without a versionIdMarker, results begin immediately after that key's last version. When
     * a keyMarker is used with a versionIdMarker, results begin immediately after the version with
     * the specified key and version ID.
     * 

* This enables pagination; to get the next page of results use the next key marker and next * version ID marker (from {@link VersionListing#getNextKeyMarker()} and * {@link VersionListing#getNextVersionIdMarker()}) as the markers for the next request to list * versions. Or use the convenience method * {@link COS#listNextBatchOfVersions(VersionListing)} */ private String keyMarker; /** * Optional parameter indicating where in the sorted list of all versions in the specified * bucket to begin returning results. Results are always ordered first lexicographically (i.e. * alphabetically) and then from most recent version to least recent version. A keyMarker must * be specified when specifying a versionIdMarker. Results begin immediately after the version * with the specified key and version ID. *

* This enables pagination; to get the next page of results use the next key marker and next * version ID marker (from {@link VersionListing#getNextKeyMarker()} and * {@link VersionListing#getNextVersionIdMarker()}) as the markers for the next request to list * versions. Or use the convenience method * {@link COS#listNextBatchOfVersions(VersionListing)} */ private String versionIdMarker; /** * Optional parameter that causes keys that contain the same string between the prefix and the * first occurrence of the delimiter to be rolled up into a single result element in the * {@link VersionListing#getCommonPrefixes()} list. These rolled-up keys are not returned * elsewhere in the response. The most commonly used delimiter is "/", which simulates a * hierarchical organization similar to a file system directory structure. */ private String delimiter; /** * Optional parameter indicating the maximum number of results to include in the response. COS * might return fewer than this, but will not return more. Even if maxKeys is not specified, COS * will limit the number of results in the response. */ private Integer maxResults; /** * Optional parameter indicating the encoding method to be applied on the response. An object * key can contain any Unicode character; however, XML 1.0 parser cannot parse some characters, * such as characters with an ASCII value from 0 to 10. For characters that are not supported in * XML 1.0, you can add this parameter to request that COS encode the keys in the response. */ private String encodingType; /** * Constructs a new {@link ListVersionsRequest} object. The caller must populate the fields * before the request is executed. * * @see ListVersionsRequest#ListVersionsRequest(String, String, String, String, String, Integer) */ public ListVersionsRequest() {} /** * Constructs a new {@link ListVersionsRequest} object and initializes all required and optional * fields. * * @param bucketName The name of the bucket whose versions are to be listed. * @param prefix The prefix restricting what keys will be listed. * @param keyMarker The key marker indicating where results should begin. * @param versionIdMarker The version ID marker indicating where results should begin. * @param delimiter The delimiter for condensing common prefixes in returned results. * @param maxResults The maximum number of results to return. * * @see ListVersionsRequest#ListVersionsRequest() */ public ListVersionsRequest(String bucketName, String prefix, String keyMarker, String versionIdMarker, String delimiter, Integer maxResults) { setBucketName(bucketName); setPrefix(prefix); setKeyMarker(keyMarker); setVersionIdMarker(versionIdMarker); setDelimiter(delimiter); setMaxResults(maxResults); } /** * Gets the name of the COS bucket whose versions are to be listed. * * @return The name of the COS bucket whose versions are to be listed. * * @see ListVersionsRequest#setBucketName(String) * @see ListVersionsRequest#withBucketName(String) */ public String getBucketName() { return bucketName; } /** * Sets the name of the COS bucket whose versions are to be listed. * * @param bucketName The name of the COS bucket whose versions are to be listed. * * @see ListVersionsRequest#getBucketName() * @see ListVersionsRequest#withBucketName(String) */ public void setBucketName(String bucketName) { this.bucketName = bucketName; } /** * Sets the name of the COS bucket whose versions are to be listed. Returns this * {@link ListVersionsRequest}, enabling additional method calls to be chained together. * * @param bucketName The name of the COS bucket whose versions are to be listed. * * @return This {@link ListVersionsRequest}, enabling additional method calls to be chained * together. * * @see ListVersionsRequest#getBucketName() * @see ListVersionsRequest#setBucketName(String) */ public ListVersionsRequest withBucketName(String bucketName) { setBucketName(bucketName); return this; } /** * Gets the optional prefix parameter restricting the response to keys that begin with the * specified prefix. Use prefixes to separate a bucket into different sets of keys, similar to * how a file system organizes files into directories. * * @return The optional prefix parameter restricting the response to keys that begin with the * specified prefix. * * @see ListVersionsRequest#setPrefix(String) * @see ListVersionsRequest#withPrefix(String) */ public String getPrefix() { return prefix; } /** * Sets the optional prefix parameter restricting the response to keys that begin with the * specified prefix. * * @param prefix The optional prefix parameter restricting the response to keys that begin with * the specified prefix. * * @see ListVersionsRequest#getPrefix() * @see ListVersionsRequest#withPrefix(String) */ public void setPrefix(String prefix) { this.prefix = prefix; } /** * Sets the optional prefix parameter restricting the response to keys that begin with the * specified prefix. Returns this {@link ListVersionsRequest}, enabling additional method calls * to be chained together. * * @param prefix The optional prefix parameter restricting the response to keys that begin with * the specified prefix. * * @return This {@link ListVersionsRequest}, enabling additional method calls to be chained * together. * * @see ListVersionsRequest#getPrefix() * @see ListVersionsRequest#setPrefix(String) */ public ListVersionsRequest withPrefix(String prefix) { setPrefix(prefix); return this; } /** * Gets the optional keyMarker parameter indicating where in the sorted list of all * versions in the specified bucket to begin returning results. Results are always ordered first * lexicographically (i.e. alphabetically) and then from most recent version to least recent * version. *

* If a keyMarker is used without a version ID marker, results begin immediately * after that key's last version. When a keyMarker is used with a version ID * marker, results begin immediately after the version with the specified key and version ID. *

* * @return The optional keyMarker parameter indicating where in the sorted list of * all versions in the specified bucket to begin returning results. * * @see ListVersionsRequest#setKeyMarker(String) * @see ListVersionsRequest#withKeyMarker(String) */ public String getKeyMarker() { return keyMarker; } /** * Sets the optional keyMarker parameter indicating where in the sorted list of all * versions in the specified bucket to begin returning results. * * @param keyMarker The optional keyMarker parameter indicating where in the sorted * list of all versions in the specified bucket to begin returning results. * * @see ListVersionsRequest#getKeyMarker() * @see ListVersionsRequest#withKeyMarker(String) */ public void setKeyMarker(String keyMarker) { this.keyMarker = keyMarker; } /** * Sets the optional keyMarker parameter indicating where in the sorted list of all * versions in the specified bucket to begin returning results. Returns this * {@link ListVersionsRequest}, enabling additional method calls to be chained together. * * @param keyMarker The optional keyMarker parameter indicating where in the sorted * list of all versions in the specified bucket to begin returning results. * * @return This {@link ListVersionsRequest}, enabling additional method calls to be chained * together. * * @see ListVersionsRequest#getKeyMarker() * @see ListVersionsRequest#setKeyMarker(String) */ public ListVersionsRequest withKeyMarker(String keyMarker) { setKeyMarker(keyMarker); return this; } /** * Gets the optional versionIdMarker parameter indicating where in the sorted list * of all versions in the specified bucket to begin returning results. Results are always * ordered first lexicographically (i.e. alphabetically) and then from most recent version to * least recent version. *

* A key marker must be specified when specifying a versionIdMarker. Results begin * immediately after the version with the specified key and version ID. *

* * @return The optional versionIdMarker parameter indicating where in the sorted * list of all versions in the specified bucket to begin returning results. * * @see ListVersionsRequest#setVersionIdMarker(String) * @see ListVersionsRequest#withVersionIdMarker(String) */ public String getVersionIdMarker() { return versionIdMarker; } /** * Sets the optional versionIdMarker parameter indicating where in the sorted list * of all versions in the specified bucket to begin returning results. * * @param versionIdMarker The optional versionIdMarker parameter indicating where * in the sorted list of all versions in the specified bucket to begin returning results. * * @see ListVersionsRequest#getVersionIdMarker() * @see ListVersionsRequest#withVersionIdMarker(String) */ public void setVersionIdMarker(String versionIdMarker) { this.versionIdMarker = versionIdMarker; } /** * Sets the optional versionIdMarker parameter indicating where in the sorted list * of all versions in the specified bucket to begin returning results. Returns this * {@link ListVersionsRequest}, enabling additional method calls to be chained together. * * @param versionIdMarker The optional versionIdMarker parameter indicating where * in the sorted list of all versions in the specified bucket to begin returning results. * * @return This {@link ListVersionsRequest}, enabling additional method calls to be chained * together. * * @see ListVersionsRequest#getVersionIdMarker() * @see ListVersionsRequest#setVersionIdMarker(String) */ public ListVersionsRequest withVersionIdMarker(String versionIdMarker) { setVersionIdMarker(versionIdMarker); return this; } /** * Gets the optional delimiter parameter that causes keys that contain the same string between * the prefix and the first occurrence of the delimiter to be combined into a single result * element in the {@link VersionListing#getCommonPrefixes()} list. These combined keys are not * returned elsewhere in the response. *

* The most commonly used delimiter is "/", which simulates a hierarchical organization similar * to a file system directory structure. *

* * @return The optional delimiter parameter that causes keys that contain the same string * between the prefix and the first occurrence of the delimiter to be combined into a * single result element in the {@link VersionListing#getCommonPrefixes()} list. * * @see ListVersionsRequest#setDelimiter(String) * @see ListVersionsRequest#withDelimiter(String) */ public String getDelimiter() { return delimiter; } /** * Sets the optional delimiter parameter that causes keys that contain the same string between * the prefix and the first occurrence of the delimiter to be combined into a single result * element in the {@link VersionListing#getCommonPrefixes()} list. * * @param delimiter The optional delimiter parameter that causes keys that contain the same * string between the prefix and the first occurrence of the delimiter to be combined * into a single result element in the {@link VersionListing#getCommonPrefixes()} list. * * @see ListVersionsRequest#getDelimiter() * @see ListVersionsRequest#withDelimiter(String) */ public void setDelimiter(String delimiter) { this.delimiter = delimiter; } /** * Sets the optional delimiter parameter that causes keys that contain the same string between * the prefix and the first occurrence of the delimiter to be combined into a single result * element in the {@link VersionListing#getCommonPrefixes()} list. Returns this * {@link ListVersionsRequest}, enabling additional method calls to be chained together. * * @param delimiter The optional delimiter parameter that causes keys that contain the same * string between the prefix and the first occurrence of the delimiter to be combined * into a single result element in the {@link VersionListing#getCommonPrefixes()} list. * * @return This {@link ListVersionsRequest}, enabling additional method calls to be chained * together. * * @see ListVersionsRequest#getDelimiter() * @see ListVersionsRequest#setDelimiter(String) */ public ListVersionsRequest withDelimiter(String delimiter) { setDelimiter(delimiter); return this; } /** * Gets the optional maxResults parameter indicating the maximum number of results * to include in the response. COS might return fewer than this, but will never return more. * Even if maxResults is not specified, COS will limit the number of results in the * response. * * @return The optional maxResults parameter indicating the maximum number of * results * * @see ListVersionsRequest#setMaxResults(Integer) * @see ListVersionsRequest#withMaxResults(Integer) */ public Integer getMaxResults() { return maxResults; } /** * Sets the optional maxResults parameter indicating the maximum number of results * to include in the response. * * @param maxResults The optional maxResults parameter indicating the maximum * number of results to include in the response. * * @see ListVersionsRequest#getMaxResults() * @see ListVersionsRequest#withMaxResults(Integer) */ public void setMaxResults(Integer maxResults) { this.maxResults = maxResults; } /** * Sets the optional maxResults parameter indicating the maximum number of results * to include in the response. Returns this {@link ListVersionsRequest}, enabling additional * method calls to be chained together. * * @param maxResults The optional maxResults parameter indicating the maximum * number of results to include in the response. * * @return This {@link ListVersionsRequest}, enabling additional method calls to be chained * together. * * @see ListVersionsRequest#getMaxResults() * @see ListVersionsRequest#setMaxResults(Integer) */ public ListVersionsRequest withMaxResults(Integer maxResults) { setMaxResults(maxResults); return this; } /** * Gets the optional encodingType parameter indicating the encoding method to be * applied on the response. * * @return The encoding method to be applied on the response. */ public String getEncodingType() { return encodingType; } /** * Sets the optional encodingType parameter indicating the encoding method to be * applied on the response. An object key can contain any Unicode character; however, XML 1.0 * parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For * characters that are not supported in XML 1.0, you can add this parameter to request that COS * encode the keys in the response. * * @param encodingType The encoding method to be applied on the response. Valid values: null * (not encoded) or "url". */ public void setEncodingType(String encodingType) { this.encodingType = encodingType; } /** * Sets the optional encodingType parameter indicating the encoding method to be * applied on the response. An object key can contain any Unicode character; however, XML 1.0 * parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For * characters that are not supported in XML 1.0, you can add this parameter to request that COS * encode the keys in the response. Returns this {@link ListVersionsRequest}, enabling * additional method calls to be chained together. * * @param encodingType The encoding method to be applied on the response. Valid values: null * (not encoded) or "url". */ public ListVersionsRequest withEncodingType(String encodingType) { setEncodingType(encodingType); return this; } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy