com.amazonaws.services.s3.model.ListBucketMetricsConfigurationsResult Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-s3 Show documentation
Show all versions of aws-java-sdk-s3 Show documentation
The AWS Java SDK for Amazon S3 module holds the client classes that are used for communicating with Amazon Simple Storage Service
/*
* Copyright 2011-2024 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.
* You may obtain a copy of the License at:
*
* http://aws.amazon.com/apache2.0
*
* 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.
*/
package com.amazonaws.services.s3.model;
import com.amazonaws.services.s3.model.metrics.MetricsConfiguration;
import java.io.Serializable;
import java.util.List;
/**
* Result object to contain the response returned from
* {@link com.amazonaws.services.s3.AmazonS3Client#listBucketMetricsConfigurations(ListBucketMetricsConfigurationsRequest)}
* operation.
*/
public class ListBucketMetricsConfigurationsResult implements Serializable {
/** The list of metrics configurations for a bucket. */
private List metricsConfigurationList;
/**
* Optional parameter which allows list to be continued from a specific point.
* This is the continuationToken that was sent in the current
* {@link ListBucketMetricsConfigurationsRequest}.
*/
private String continuationToken;
/**
* Indicates if this is a complete listing, or if the caller needs to make
* additional requests to Amazon S3 to see the full metrics configuration
* listing for an S3 bucket.
*/
private boolean isTruncated;
/**
* NextContinuationToken is sent when isTruncated is true meaning there are
* more metrics configurations in the bucket that can be listed. The next list requests to Amazon
* S3 can be continued by providing this NextContinuationToken.
*/
private String nextContinuationToken;
/**
* Returns the list of metrics configurations for a bucket.
*/
public List getMetricsConfigurationList() {
return metricsConfigurationList;
}
/**
* Sets the list of metrics configurations.
*/
public void setMetricsConfigurationList(List metricsConfigurationList) {
this.metricsConfigurationList = metricsConfigurationList;
}
/**
* Sets the list of metrics configurations and returns the
* {@link ListBucketMetricsConfigurationsResult} object for method chaining.
*/
public ListBucketMetricsConfigurationsResult withMetricsConfigurationList(List metricsConfigurationList) {
setMetricsConfigurationList(metricsConfigurationList);
return this;
}
/**
* Gets whether or not this metrics configuration listing is complete.
*
* @return The value true if the metrics configuration listing is not complete.
* Returns the value false if otherwise.
* When returning true,
* additional calls to Amazon S3 may be needed in order to
* obtain more results.
*/
public boolean isTruncated() {
return isTruncated;
}
/**
* For internal use only. Sets the truncated property for
* this metrics configuration listing, indicating if this is a complete listing or not and
* whether the caller needs to make additional calls to S3 to get more results.
*
* @param isTruncated
* The value true if the metrics configuration listing is not complete.
* The value false if otherwise.
*/
public void setTruncated(boolean isTruncated) {
this.isTruncated = isTruncated;
}
/**
* For internal use only. Sets the truncated property for
* this metrics configuration listing, indicating if this is a complete listing or not and
* whether the caller needs to make additional calls to S3 to get more results.
*
* @param isTruncated
* The value true if the metrics configuration listing is not complete.
* The value false if otherwise.
*
* @return
* This object for method chaining.
*/
public ListBucketMetricsConfigurationsResult withTruncated(boolean isTruncated) {
setTruncated(isTruncated);
return this;
}
/**
* Gets the optional continuation token. Continuation token allows a list to be
* continued from a specific point. This is the continuationToken that was sent in the current
* {@link ListBucketMetricsConfigurationsRequest}.
*
* @return The optional continuation token associated with this request.
*/
public String getContinuationToken() {
return continuationToken;
}
/**
* Sets the optional continuation token. Continuation token allows a list to be
* continued from a specific point. This is the continuationToken that was sent in the current
* {@link ListBucketMetricsConfigurationsRequest}.
*
* @param continuationToken
* The optional continuation token to associate with this request.
*/
public void setContinuationToken(String continuationToken) {
this.continuationToken = continuationToken;
}
/**
* Sets the optional continuation token. Continuation token allows a list to be
* continued from a specific point. This is the continuationToken that was sent in the current
* {@link ListBucketMetricsConfigurationsRequest}.
*
* @param continuationToken
* The optional continuation token to associate with this request.
*
* @return
* This object for method chaining.
*/
public ListBucketMetricsConfigurationsResult withContinuationToken(String continuationToken) {
setContinuationToken(continuationToken);
return this;
}
/**
* Gets the optional NextContinuationToken.
* NextContinuationToken is sent when isTruncated is true meaning there are
* more keys in the bucket that can be listed. The next list requests to Amazon
* S3 can be continued by providing this NextContinuationToken.
*
* @return The optional NextContinuationToken parameter.
*/
public String getNextContinuationToken() {
return nextContinuationToken;
}
/**
* Sets the optional NextContinuationToken.
* NextContinuationToken is sent when isTruncated is true meaning there are
* more keys in the bucket that can be listed. The next list requests to Amazon
* S3 can be continued by providing this NextContinuationToken.
*
* @param nextContinuationToken
* The optional NextContinuationToken parameter to associate with this request.
*/
public void setNextContinuationToken(String nextContinuationToken) {
this.nextContinuationToken = nextContinuationToken;
}
/**
* Sets the optional NextContinuationToken.
* NextContinuationToken is sent when isTruncated is true meaning there are
* more keys in the bucket that can be listed. The next list requests to Amazon
* S3 can be continued by providing this NextContinuationToken.
*
* @param nextContinuationToken
* The optional NextContinuationToken parameter to associate with this request.
*
* @return
* This object for method chaining.
*/
public ListBucketMetricsConfigurationsResult withNextContinuationToken(String nextContinuationToken) {
setNextContinuationToken(nextContinuationToken);
return this;
}
}