Interface GetBucketMetricDataRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<GetBucketMetricDataRequest.Builder,
,GetBucketMetricDataRequest> LightsailRequest.Builder
,SdkBuilder<GetBucketMetricDataRequest.Builder,
,GetBucketMetricDataRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
GetBucketMetricDataRequest
-
Method Summary
Modifier and TypeMethodDescriptionbucketName
(String bucketName) The name of the bucket for which to get metric data.The timestamp indicating the latest data to be returned.metricName
(String metricName) The metric for which you want to return information.metricName
(BucketMetricName metricName) The metric for which you want to return information.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The granularity, in seconds, of the returned data points.The timestamp indicating the earliest data to be returned.statistics
(Collection<MetricStatistic> statistics) The statistic for the metric.statistics
(MetricStatistic... statistics) The statistic for the metric.statisticsWithStrings
(String... statistics) The statistic for the metric.statisticsWithStrings
(Collection<String> statistics) The statistic for the metric.The unit for the metric data request.unit
(MetricUnit unit) The unit for the metric data request.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.lightsail.model.LightsailRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
bucketName
The name of the bucket for which to get metric data.
- Parameters:
bucketName
- The name of the bucket for which to get metric data.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
.
- Parameters:
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
.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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
.
- Parameters:
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
.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
startTime
The timestamp indicating the earliest data to be returned.
- Parameters:
startTime
- The timestamp indicating the earliest data to be returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endTime
The timestamp indicating the latest data to be returned.
- Parameters:
endTime
- The timestamp indicating the latest data to be returned.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
statisticsWithStrings
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 ofSum
/SampleCount
during the specified period. By comparing this statistic with theMinimum
andMaximum
values, you can determine the full scope of a metric and how close the average use is to theMinimum
andMaximum
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.
- Parameters:
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 ofSum
/SampleCount
during the specified period. By comparing this statistic with theMinimum
andMaximum
values, you can determine the full scope of a metric and how close the average use is to theMinimum
andMaximum
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
statisticsWithStrings
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 ofSum
/SampleCount
during the specified period. By comparing this statistic with theMinimum
andMaximum
values, you can determine the full scope of a metric and how close the average use is to theMinimum
andMaximum
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.
- Parameters:
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 ofSum
/SampleCount
during the specified period. By comparing this statistic with theMinimum
andMaximum
values, you can determine the full scope of a metric and how close the average use is to theMinimum
andMaximum
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 ofSum
/SampleCount
during the specified period. By comparing this statistic with theMinimum
andMaximum
values, you can determine the full scope of a metric and how close the average use is to theMinimum
andMaximum
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.
- Parameters:
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 ofSum
/SampleCount
during the specified period. By comparing this statistic with theMinimum
andMaximum
values, you can determine the full scope of a metric and how close the average use is to theMinimum
andMaximum
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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 ofSum
/SampleCount
during the specified period. By comparing this statistic with theMinimum
andMaximum
values, you can determine the full scope of a metric and how close the average use is to theMinimum
andMaximum
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.
- Parameters:
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 ofSum
/SampleCount
during the specified period. By comparing this statistic with theMinimum
andMaximum
values, you can determine the full scope of a metric and how close the average use is to theMinimum
andMaximum
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
GetBucketMetricDataRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
GetBucketMetricDataRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-