Package software.amazon.awssdk.services.lightsail.model

Interface GetBucketMetricDataRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<GetBucketMetricDataRequest.Builder,GetBucketMetricDataRequest>, LightsailRequest.Builder, SdkBuilder<GetBucketMetricDataRequest.Builder,GetBucketMetricDataRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GetBucketMetricDataRequest

public static interface GetBucketMetricDataRequest.Builder
extends LightsailRequest.Builder, SdkPojo, CopyableBuilder<GetBucketMetricDataRequest.Builder,GetBucketMetricDataRequest>

Method Summary

Modifier and Type	Method	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(String metricName)	The metric for which you want to return information.
GetBucketMetricDataRequest.Builder	metricName(BucketMetricName metricName)	The metric for which you want to return information.
GetBucketMetricDataRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
GetBucketMetricDataRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
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(String... statistics)	The statistic for the metric.
GetBucketMetricDataRequest.Builder	statisticsWithStrings(Collection<String> statistics)	The statistic for the metric.
GetBucketMetricDataRequest.Builder	unit(String unit)	The unit for the metric data request.
GetBucketMetricDataRequest.Builder	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 Detail

bucketName

GetBucketMetricDataRequest.Builder bucketName(String 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

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.

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:

BucketMetricName, BucketMetricName

metricName

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.

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:

BucketMetricName, BucketMetricName

startTime

GetBucketMetricDataRequest.Builder startTime(Instant 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

GetBucketMetricDataRequest.Builder endTime(Instant 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

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.

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

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.

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 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

statisticsWithStrings

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.

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 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

statistics

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.

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 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

statistics

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.

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 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

unit

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.

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:

MetricUnit, MetricUnit

unit

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.

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:

MetricUnit, MetricUnit

overrideConfiguration

GetBucketMetricDataRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

GetBucketMetricDataRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder