@Generated(value="com.amazonaws:awsjavasdkcodegenerator") public class GetBucketMetricDataRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description 

GetBucketMetricDataRequest() 
Modifier and Type  Method and Description 

GetBucketMetricDataRequest 
clone()
Creates a shallow clone of this object for all fields except the handler context.

boolean 
equals(Object obj) 
String 
getBucketName()
The name of the bucket for which to get metric data.

Date 
getEndTime()
The timestamp indicating the latest data to be returned.

String 
getMetricName()
The metric for which you want to return information.

Integer 
getPeriod()
The granularity, in seconds, of the returned data points.

Date 
getStartTime()
The timestamp indicating the earliest data to be returned.

List<String> 
getStatistics()
The statistic for the metric.

String 
getUnit()
The unit for the metric data request.

int 
hashCode() 
void 
setBucketName(String bucketName)
The name of the bucket for which to get metric data.

void 
setEndTime(Date endTime)
The timestamp indicating the latest data to be returned.

void 
setMetricName(String metricName)
The metric for which you want to return information.

void 
setPeriod(Integer period)
The granularity, in seconds, of the returned data points.

void 
setStartTime(Date startTime)
The timestamp indicating the earliest data to be returned.

void 
setStatistics(Collection<String> statistics)
The statistic for the metric.

void 
setUnit(String unit)
The unit for the metric data request.

String 
toString()
Returns a string representation of this object.

GetBucketMetricDataRequest 
withBucketName(String bucketName)
The name of the bucket for which to get metric data.

GetBucketMetricDataRequest 
withEndTime(Date endTime)
The timestamp indicating the latest data to be returned.

GetBucketMetricDataRequest 
withMetricName(BucketMetricName metricName)
The metric for which you want to return information.

GetBucketMetricDataRequest 
withMetricName(String metricName)
The metric for which you want to return information.

GetBucketMetricDataRequest 
withPeriod(Integer period)
The granularity, in seconds, of the returned data points.

GetBucketMetricDataRequest 
withStartTime(Date startTime)
The timestamp indicating the earliest data to be returned.

GetBucketMetricDataRequest 
withStatistics(Collection<String> statistics)
The statistic for the metric.

GetBucketMetricDataRequest 
withStatistics(MetricStatistic... statistics)
The statistic for the metric.

GetBucketMetricDataRequest 
withStatistics(String... statistics)
The statistic for the metric.

GetBucketMetricDataRequest 
withUnit(MetricUnit unit)
The unit for the metric data request.

GetBucketMetricDataRequest 
withUnit(String unit)
The unit for the metric data request.

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setBucketName(String bucketName)
The name of the bucket for which to get metric data.
bucketName
 The name of the bucket for which to get metric data.public String getBucketName()
The name of the bucket for which to get metric data.
public GetBucketMetricDataRequest withBucketName(String bucketName)
The name of the bucket for which to get metric data.
bucketName
 The name of the bucket for which to get metric data.public void setMetricName(String metricName)
The metric for which you want to return information.
Valid bucket metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.
These bucket metrics are reported once per day.
BucketSizeBytes
 The amount of data in bytes stored in a bucket. This value is calculated
by summing the size of all objects in the bucket (including object versions), including the size of all parts for
all incomplete multipart uploads to the bucket.
Statistics: The most useful statistic is Maximum
.
Unit: The published unit is Bytes
.
NumberOfObjects
 The total number of objects stored in a bucket. This value is calculated
by counting all objects in the bucket (including object versions) and the total number of parts for all
incomplete multipart uploads to the bucket.
Statistics: The most useful statistic is Average
.
Unit: The published unit is Count
.
metricName
 The metric for which you want to return information.
Valid bucket metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.
These bucket metrics are reported once per day.
BucketSizeBytes
 The amount of data in bytes stored in a bucket. This value is
calculated by summing the size of all objects in the bucket (including object versions), including the
size of all parts for all incomplete multipart uploads to the bucket.
Statistics: The most useful statistic is Maximum
.
Unit: The published unit is Bytes
.
NumberOfObjects
 The total number of objects stored in a bucket. This value is
calculated by counting all objects in the bucket (including object versions) and the total number of parts
for all incomplete multipart uploads to the bucket.
Statistics: The most useful statistic is Average
.
Unit: The published unit is Count
.
BucketMetricName
public String getMetricName()
The metric for which you want to return information.
Valid bucket metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.
These bucket metrics are reported once per day.
BucketSizeBytes
 The amount of data in bytes stored in a bucket. This value is calculated
by summing the size of all objects in the bucket (including object versions), including the size of all parts for
all incomplete multipart uploads to the bucket.
Statistics: The most useful statistic is Maximum
.
Unit: The published unit is Bytes
.
NumberOfObjects
 The total number of objects stored in a bucket. This value is calculated
by counting all objects in the bucket (including object versions) and the total number of parts for all
incomplete multipart uploads to the bucket.
Statistics: The most useful statistic is Average
.
Unit: The published unit is Count
.
Valid bucket metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.
These bucket metrics are reported once per day.
BucketSizeBytes
 The amount of data in bytes stored in a bucket. This value is
calculated by summing the size of all objects in the bucket (including object versions), including the
size of all parts for all incomplete multipart uploads to the bucket.
Statistics: The most useful statistic is Maximum
.
Unit: The published unit is Bytes
.
NumberOfObjects
 The total number of objects stored in a bucket. This value is
calculated by counting all objects in the bucket (including object versions) and the total number of
parts for all incomplete multipart uploads to the bucket.
Statistics: The most useful statistic is Average
.
Unit: The published unit is Count
.
BucketMetricName
public GetBucketMetricDataRequest withMetricName(String metricName)
The metric for which you want to return information.
Valid bucket metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.
These bucket metrics are reported once per day.
BucketSizeBytes
 The amount of data in bytes stored in a bucket. This value is calculated
by summing the size of all objects in the bucket (including object versions), including the size of all parts for
all incomplete multipart uploads to the bucket.
Statistics: The most useful statistic is Maximum
.
Unit: The published unit is Bytes
.
NumberOfObjects
 The total number of objects stored in a bucket. This value is calculated
by counting all objects in the bucket (including object versions) and the total number of parts for all
incomplete multipart uploads to the bucket.
Statistics: The most useful statistic is Average
.
Unit: The published unit is Count
.
metricName
 The metric for which you want to return information.
Valid bucket metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.
These bucket metrics are reported once per day.
BucketSizeBytes
 The amount of data in bytes stored in a bucket. This value is
calculated by summing the size of all objects in the bucket (including object versions), including the
size of all parts for all incomplete multipart uploads to the bucket.
Statistics: The most useful statistic is Maximum
.
Unit: The published unit is Bytes
.
NumberOfObjects
 The total number of objects stored in a bucket. This value is
calculated by counting all objects in the bucket (including object versions) and the total number of parts
for all incomplete multipart uploads to the bucket.
Statistics: The most useful statistic is Average
.
Unit: The published unit is Count
.
BucketMetricName
public GetBucketMetricDataRequest withMetricName(BucketMetricName metricName)
The metric for which you want to return information.
Valid bucket metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.
These bucket metrics are reported once per day.
BucketSizeBytes
 The amount of data in bytes stored in a bucket. This value is calculated
by summing the size of all objects in the bucket (including object versions), including the size of all parts for
all incomplete multipart uploads to the bucket.
Statistics: The most useful statistic is Maximum
.
Unit: The published unit is Bytes
.
NumberOfObjects
 The total number of objects stored in a bucket. This value is calculated
by counting all objects in the bucket (including object versions) and the total number of parts for all
incomplete multipart uploads to the bucket.
Statistics: The most useful statistic is Average
.
Unit: The published unit is Count
.
metricName
 The metric for which you want to return information.
Valid bucket metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.
These bucket metrics are reported once per day.
BucketSizeBytes
 The amount of data in bytes stored in a bucket. This value is
calculated by summing the size of all objects in the bucket (including object versions), including the
size of all parts for all incomplete multipart uploads to the bucket.
Statistics: The most useful statistic is Maximum
.
Unit: The published unit is Bytes
.
NumberOfObjects
 The total number of objects stored in a bucket. This value is
calculated by counting all objects in the bucket (including object versions) and the total number of parts
for all incomplete multipart uploads to the bucket.
Statistics: The most useful statistic is Average
.
Unit: The published unit is Count
.
BucketMetricName
public void setStartTime(Date startTime)
The timestamp indicating the earliest data to be returned.
startTime
 The timestamp indicating the earliest data to be returned.public Date getStartTime()
The timestamp indicating the earliest data to be returned.
public GetBucketMetricDataRequest withStartTime(Date startTime)
The timestamp indicating the earliest data to be returned.
startTime
 The timestamp indicating the earliest data to be returned.public void setEndTime(Date endTime)
The timestamp indicating the latest data to be returned.
endTime
 The timestamp indicating the latest data to be returned.public Date getEndTime()
The timestamp indicating the latest data to be returned.
public GetBucketMetricDataRequest withEndTime(Date endTime)
The timestamp indicating the latest data to be returned.
endTime
 The timestamp indicating the latest data to be returned.public void setPeriod(Integer period)
The granularity, in seconds, of the returned data points.
Bucket storage metrics are reported once per day. Therefore, you should specify a period of 86400 seconds, which is the number of seconds in a day.
period
 The granularity, in seconds, of the returned data points. Bucket storage metrics are reported once per day. Therefore, you should specify a period of 86400 seconds, which is the number of seconds in a day.
public Integer getPeriod()
The granularity, in seconds, of the returned data points.
Bucket storage metrics are reported once per day. Therefore, you should specify a period of 86400 seconds, which is the number of seconds in a day.
Bucket storage metrics are reported once per day. Therefore, you should specify a period of 86400 seconds, which is the number of seconds in a day.
public GetBucketMetricDataRequest withPeriod(Integer period)
The granularity, in seconds, of the returned data points.
Bucket storage metrics are reported once per day. Therefore, you should specify a period of 86400 seconds, which is the number of seconds in a day.
period
 The granularity, in seconds, of the returned data points. Bucket storage metrics are reported once per day. Therefore, you should specify a period of 86400 seconds, which is the number of seconds in a day.
public List<String> getStatistics()
The statistic for the metric.
The following statistics are available:
Minimum
 The lowest value observed during the specified period. Use this value to determine low
volumes of activity for your application.
Maximum
 The highest value observed during the specified period. Use this value to determine high
volumes of activity for your application.
Sum
 The sum of all values submitted for the matching metric. You can use this statistic to
determine the total volume of a metric.
Average
 The value of Sum
/ SampleCount
during the specified period. By
comparing this statistic with the Minimum
and Maximum
values, you can determine the
full scope of a metric and how close the average use is to the Minimum
and Maximum
values. This comparison helps you to know when to increase or decrease your resources.
SampleCount
 The count, or number, of data points used for the statistical calculation.
The following statistics are available:
Minimum
 The lowest value observed during the specified period. Use this value to determine
low volumes of activity for your application.
Maximum
 The highest value observed during the specified period. Use this value to
determine high volumes of activity for your application.
Sum
 The sum of all values submitted for the matching metric. You can use this statistic to
determine the total volume of a metric.
Average
 The value of Sum
/ SampleCount
during the specified
period. By comparing this statistic with the Minimum
and Maximum
values, you
can determine the full scope of a metric and how close the average use is to the Minimum
and
Maximum
values. This comparison helps you to know when to increase or decrease your
resources.
SampleCount
 The count, or number, of data points used for the statistical calculation.
MetricStatistic
public void setStatistics(Collection<String> statistics)
The statistic for the metric.
The following statistics are available:
Minimum
 The lowest value observed during the specified period. Use this value to determine low
volumes of activity for your application.
Maximum
 The highest value observed during the specified period. Use this value to determine high
volumes of activity for your application.
Sum
 The sum of all values submitted for the matching metric. You can use this statistic to
determine the total volume of a metric.
Average
 The value of Sum
/ SampleCount
during the specified period. By
comparing this statistic with the Minimum
and Maximum
values, you can determine the
full scope of a metric and how close the average use is to the Minimum
and Maximum
values. This comparison helps you to know when to increase or decrease your resources.
SampleCount
 The count, or number, of data points used for the statistical calculation.
statistics
 The statistic for the metric.
The following statistics are available:
Minimum
 The lowest value observed during the specified period. Use this value to determine
low volumes of activity for your application.
Maximum
 The highest value observed during the specified period. Use this value to determine
high volumes of activity for your application.
Sum
 The sum of all values submitted for the matching metric. You can use this statistic to
determine the total volume of a metric.
Average
 The value of Sum
/ SampleCount
during the specified
period. By comparing this statistic with the Minimum
and Maximum
values, you can
determine the full scope of a metric and how close the average use is to the Minimum
and
Maximum
values. This comparison helps you to know when to increase or decrease your
resources.
SampleCount
 The count, or number, of data points used for the statistical calculation.
MetricStatistic
public GetBucketMetricDataRequest withStatistics(String... statistics)
The statistic for the metric.
The following statistics are available:
Minimum
 The lowest value observed during the specified period. Use this value to determine low
volumes of activity for your application.
Maximum
 The highest value observed during the specified period. Use this value to determine high
volumes of activity for your application.
Sum
 The sum of all values submitted for the matching metric. You can use this statistic to
determine the total volume of a metric.
Average
 The value of Sum
/ SampleCount
during the specified period. By
comparing this statistic with the Minimum
and Maximum
values, you can determine the
full scope of a metric and how close the average use is to the Minimum
and Maximum
values. This comparison helps you to know when to increase or decrease your resources.
SampleCount
 The count, or number, of data points used for the statistical calculation.
NOTE: This method appends the values to the existing list (if any). Use
setStatistics(java.util.Collection)
or withStatistics(java.util.Collection)
if you want to
override the existing values.
statistics
 The statistic for the metric.
The following statistics are available:
Minimum
 The lowest value observed during the specified period. Use this value to determine
low volumes of activity for your application.
Maximum
 The highest value observed during the specified period. Use this value to determine
high volumes of activity for your application.
Sum
 The sum of all values submitted for the matching metric. You can use this statistic to
determine the total volume of a metric.
Average
 The value of Sum
/ SampleCount
during the specified
period. By comparing this statistic with the Minimum
and Maximum
values, you can
determine the full scope of a metric and how close the average use is to the Minimum
and
Maximum
values. This comparison helps you to know when to increase or decrease your
resources.
SampleCount
 The count, or number, of data points used for the statistical calculation.
MetricStatistic
public GetBucketMetricDataRequest withStatistics(Collection<String> statistics)
The statistic for the metric.
The following statistics are available:
Minimum
 The lowest value observed during the specified period. Use this value to determine low
volumes of activity for your application.
Maximum
 The highest value observed during the specified period. Use this value to determine high
volumes of activity for your application.
Sum
 The sum of all values submitted for the matching metric. You can use this statistic to
determine the total volume of a metric.
Average
 The value of Sum
/ SampleCount
during the specified period. By
comparing this statistic with the Minimum
and Maximum
values, you can determine the
full scope of a metric and how close the average use is to the Minimum
and Maximum
values. This comparison helps you to know when to increase or decrease your resources.
SampleCount
 The count, or number, of data points used for the statistical calculation.
statistics
 The statistic for the metric.
The following statistics are available:
Minimum
 The lowest value observed during the specified period. Use this value to determine
low volumes of activity for your application.
Maximum
 The highest value observed during the specified period. Use this value to determine
high volumes of activity for your application.
Sum
 The sum of all values submitted for the matching metric. You can use this statistic to
determine the total volume of a metric.
Average
 The value of Sum
/ SampleCount
during the specified
period. By comparing this statistic with the Minimum
and Maximum
values, you can
determine the full scope of a metric and how close the average use is to the Minimum
and
Maximum
values. This comparison helps you to know when to increase or decrease your
resources.
SampleCount
 The count, or number, of data points used for the statistical calculation.
MetricStatistic
public GetBucketMetricDataRequest withStatistics(MetricStatistic... statistics)
The statistic for the metric.
The following statistics are available:
Minimum
 The lowest value observed during the specified period. Use this value to determine low
volumes of activity for your application.
Maximum
 The highest value observed during the specified period. Use this value to determine high
volumes of activity for your application.
Sum
 The sum of all values submitted for the matching metric. You can use this statistic to
determine the total volume of a metric.
Average
 The value of Sum
/ SampleCount
during the specified period. By
comparing this statistic with the Minimum
and Maximum
values, you can determine the
full scope of a metric and how close the average use is to the Minimum
and Maximum
values. This comparison helps you to know when to increase or decrease your resources.
SampleCount
 The count, or number, of data points used for the statistical calculation.
statistics
 The statistic for the metric.
The following statistics are available:
Minimum
 The lowest value observed during the specified period. Use this value to determine
low volumes of activity for your application.
Maximum
 The highest value observed during the specified period. Use this value to determine
high volumes of activity for your application.
Sum
 The sum of all values submitted for the matching metric. You can use this statistic to
determine the total volume of a metric.
Average
 The value of Sum
/ SampleCount
during the specified
period. By comparing this statistic with the Minimum
and Maximum
values, you can
determine the full scope of a metric and how close the average use is to the Minimum
and
Maximum
values. This comparison helps you to know when to increase or decrease your
resources.
SampleCount
 The count, or number, of data points used for the statistical calculation.
MetricStatistic
public void setUnit(String unit)
The unit for the metric data request.
Valid units depend on the metric data being requested. For the valid units with each available metric, see the
metricName
parameter.
unit
 The unit for the metric data request.
Valid units depend on the metric data being requested. For the valid units with each available metric, see
the metricName
parameter.
MetricUnit
public String getUnit()
The unit for the metric data request.
Valid units depend on the metric data being requested. For the valid units with each available metric, see the
metricName
parameter.
Valid units depend on the metric data being requested. For the valid units with each available metric,
see the metricName
parameter.
MetricUnit
public GetBucketMetricDataRequest withUnit(String unit)
The unit for the metric data request.
Valid units depend on the metric data being requested. For the valid units with each available metric, see the
metricName
parameter.
unit
 The unit for the metric data request.
Valid units depend on the metric data being requested. For the valid units with each available metric, see
the metricName
parameter.
MetricUnit
public GetBucketMetricDataRequest withUnit(MetricUnit unit)
The unit for the metric data request.
Valid units depend on the metric data being requested. For the valid units with each available metric, see the
metricName
parameter.
unit
 The unit for the metric data request.
Valid units depend on the metric data being requested. For the valid units with each available metric, see
the metricName
parameter.
MetricUnit
public String toString()
toString
in class Object
Object.toString()
public GetBucketMetricDataRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()