public static interface GetBucketMetricDataRequest.Builder extends LightsailRequest.Builder, SdkPojo, CopyableBuilder<GetBucketMetricDataRequest.Builder,GetBucketMetricDataRequest>
Modifier and Type  Method and Description 

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

GetBucketMetricDataRequest.Builder 
endTime(Instant endTime)
The timestamp indicating the latest data to be returned.

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

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

GetBucketMetricDataRequest.Builder 
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.

GetBucketMetricDataRequest.Builder 
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.

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

GetBucketMetricDataRequest.Builder 
startTime(Instant startTime)
The timestamp indicating the earliest data to be returned.

GetBucketMetricDataRequest.Builder 
statistics(Collection<MetricStatistic> statistics)
The statistic for the metric.

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

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

GetBucketMetricDataRequest.Builder 
statisticsWithStrings(String... statistics)
The statistic for the metric.

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

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

build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
GetBucketMetricDataRequest.Builder bucketName(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.GetBucketMetricDataRequest.Builder metricName(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
,
BucketMetricName
GetBucketMetricDataRequest.Builder metricName(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
,
BucketMetricName
GetBucketMetricDataRequest.Builder startTime(Instant startTime)
The timestamp indicating the earliest data to be returned.
startTime
 The timestamp indicating the earliest data to be returned.GetBucketMetricDataRequest.Builder endTime(Instant endTime)
The timestamp indicating the latest data to be returned.
endTime
 The timestamp indicating the latest data to be returned.GetBucketMetricDataRequest.Builder period(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.
GetBucketMetricDataRequest.Builder statisticsWithStrings(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.
GetBucketMetricDataRequest.Builder statisticsWithStrings(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.
GetBucketMetricDataRequest.Builder statistics(Collection<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.
GetBucketMetricDataRequest.Builder statistics(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.
GetBucketMetricDataRequest.Builder unit(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
,
MetricUnit
GetBucketMetricDataRequest.Builder unit(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
,
MetricUnit
GetBucketMetricDataRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
 The override configuration.GetBucketMetricDataRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
 A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.