Class GetBucketMetricDataRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.lightsail.model.LightsailRequest
software.amazon.awssdk.services.lightsail.model.GetBucketMetricDataRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetBucketMetricDataRequest.Builder,GetBucketMetricDataRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetBucketMetricDataRequest extends LightsailRequest implements ToCopyableBuilder<GetBucketMetricDataRequest.Builder,GetBucketMetricDataRequest>

  • Method Details

    • bucketName

      public final String 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

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

      If the service returns an enum value that is not available in the current SDK version, metricName will return BucketMetricName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricNameAsString().

      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

      public final String 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 return BucketMetricName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricNameAsString().

      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

      public final Instant startTime()

      The timestamp indicating the earliest data to be returned.

      Returns:
      The timestamp indicating the earliest data to be returned.

    • endTime

      public final Instant endTime()

      The timestamp indicating the latest data to be returned.

      Returns:
      The timestamp indicating the latest data to be returned.

    • period

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

      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

      public final List<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.

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

    • 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 the isEmpty() 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

      public final List<String> 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 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.

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

    • unit

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

      If the service returns an enum value that is not available in the current SDK version, unit will return MetricUnit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from unitAsString().

      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

      public final String 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 return MetricUnit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from unitAsString().

      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

      public GetBucketMetricDataRequest.Builder 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 interface ToCopyableBuilder<GetBucketMetricDataRequest.Builder,GetBucketMetricDataRequest>
      Specified by:
      toBuilder in class LightsailRequest
      Returns:
      a builder for type T

    • builder

      public static GetBucketMetricDataRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetBucketMetricDataRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.