Class GetBucketMetricDataRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetBucketMetricDataRequest.Builder,
GetBucketMetricDataRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The name of the bucket for which to get metric data.builder()
final Instant
endTime()
The timestamp indicating the latest data to be returned.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Statistics property.final BucketMetricName
The metric for which you want to return information.final String
The metric for which you want to return information.final Integer
period()
The granularity, in seconds, of the returned data points.static Class
<? extends GetBucketMetricDataRequest.Builder> final Instant
The timestamp indicating the earliest data to be returned.final List
<MetricStatistic> The statistic for the metric.The statistic for the metric.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final MetricUnit
unit()
The unit for the metric data request.final String
The unit for the metric data request.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
bucketName
The name of the bucket for which to get metric data.
- Returns:
- The name of the bucket for which to get metric data.
-
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
.
If the service returns an enum value that is not available in the current SDK version,
metricName
will returnBucketMetricName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommetricNameAsString()
.- Returns:
- 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
.
-
- See Also:
-
-
metricNameAsString
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
.
If the service returns an enum value that is not available in the current SDK version,
metricName
will returnBucketMetricName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommetricNameAsString()
.- Returns:
- 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
.
-
- See Also:
-
-
startTime
The timestamp indicating the earliest data to be returned.
- Returns:
- The timestamp indicating the earliest data to be returned.
-
endTime
The timestamp indicating the latest data to be returned.
- Returns:
- The timestamp indicating the latest data to be returned.
-
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:
- 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.
-
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasStatistics()
method.- Returns:
- 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.
-
-
-
hasStatistics
public final boolean hasStatistics()For responses, this returns true if the service returned a value for the Statistics property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
statisticsAsStrings
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasStatistics()
method.- Returns:
- 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.
-
-
-
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.If the service returns an enum value that is not available in the current SDK version,
unit
will returnMetricUnit.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromunitAsString()
.- Returns:
- 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. - See Also:
-
unitAsString
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.If the service returns an enum value that is not available in the current SDK version,
unit
will returnMetricUnit.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromunitAsString()
.- Returns:
- 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. - See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetBucketMetricDataRequest.Builder,
GetBucketMetricDataRequest> - Specified by:
toBuilder
in classLightsailRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-