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

Class GetRelationalDatabaseMetricDataRequest

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.GetRelationalDatabaseMetricDataRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetRelationalDatabaseMetricDataRequest.Builder,GetRelationalDatabaseMetricDataRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetRelationalDatabaseMetricDataRequest extends LightsailRequest implements ToCopyableBuilder<GetRelationalDatabaseMetricDataRequest.Builder,GetRelationalDatabaseMetricDataRequest>

  • Method Details

    • relationalDatabaseName

      public final String relationalDatabaseName()

      The name of your database from which to get metric data.

      Returns:
      The name of your database from which to get metric data.

    • metricName

      public final RelationalDatabaseMetricName metricName()

      The metric for which you want to return information.

      Valid relational database metric names are listed below, along with the most useful statistics to include in your request, and the published unit value. All relational database metric data is available in 1-minute (60 seconds) granularity.

      • CPUUtilization - The percentage of CPU utilization currently in use on the database.

        Statistics: The most useful statistics are Maximum and Average.

        Unit: The published unit is Percent.

      • DatabaseConnections - The number of database connections in use.

        Statistics: The most useful statistics are Maximum and Sum.

        Unit: The published unit is Count.

      • DiskQueueDepth - The number of outstanding IOs (read/write requests) that are waiting to access the disk.

        Statistics: The most useful statistic is Sum.

        Unit: The published unit is Count.

      • FreeStorageSpace - The amount of available storage space.

        Statistics: The most useful statistic is Sum.

        Unit: The published unit is Bytes.

      • NetworkReceiveThroughput - The incoming (Receive) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.

        Statistics: The most useful statistic is Average.

        Unit: The published unit is Bytes/Second.

      • NetworkTransmitThroughput - The outgoing (Transmit) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.

        Statistics: The most useful statistic is Average.

        Unit: The published unit is Bytes/Second.

      If the service returns an enum value that is not available in the current SDK version, metricName will return RelationalDatabaseMetricName.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 relational database metric names are listed below, along with the most useful statistics to include in your request, and the published unit value. All relational database metric data is available in 1-minute (60 seconds) granularity.

      • CPUUtilization - The percentage of CPU utilization currently in use on the database.

        Statistics: The most useful statistics are Maximum and Average.

        Unit: The published unit is Percent.

      • DatabaseConnections - The number of database connections in use.

        Statistics: The most useful statistics are Maximum and Sum.

        Unit: The published unit is Count.

      • DiskQueueDepth - The number of outstanding IOs (read/write requests) that are waiting to access the disk.

        Statistics: The most useful statistic is Sum.

        Unit: The published unit is Count.

      • FreeStorageSpace - The amount of available storage space.

        Statistics: The most useful statistic is Sum.

        Unit: The published unit is Bytes.

      • NetworkReceiveThroughput - The incoming (Receive) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.

        Statistics: The most useful statistic is Average.

        Unit: The published unit is Bytes/Second.

      • NetworkTransmitThroughput - The outgoing (Transmit) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.

        Statistics: The most useful statistic is Average.

        Unit: The published unit is Bytes/Second.

      See Also:

    • metricNameAsString

      public final String metricNameAsString()

      The metric for which you want to return information.

      Valid relational database metric names are listed below, along with the most useful statistics to include in your request, and the published unit value. All relational database metric data is available in 1-minute (60 seconds) granularity.

      • CPUUtilization - The percentage of CPU utilization currently in use on the database.

        Statistics: The most useful statistics are Maximum and Average.

        Unit: The published unit is Percent.

      • DatabaseConnections - The number of database connections in use.

        Statistics: The most useful statistics are Maximum and Sum.

        Unit: The published unit is Count.

      • DiskQueueDepth - The number of outstanding IOs (read/write requests) that are waiting to access the disk.

        Statistics: The most useful statistic is Sum.

        Unit: The published unit is Count.

      • FreeStorageSpace - The amount of available storage space.

        Statistics: The most useful statistic is Sum.

        Unit: The published unit is Bytes.

      • NetworkReceiveThroughput - The incoming (Receive) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.

        Statistics: The most useful statistic is Average.

        Unit: The published unit is Bytes/Second.

      • NetworkTransmitThroughput - The outgoing (Transmit) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.

        Statistics: The most useful statistic is Average.

        Unit: The published unit is Bytes/Second.

      If the service returns an enum value that is not available in the current SDK version, metricName will return RelationalDatabaseMetricName.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 relational database metric names are listed below, along with the most useful statistics to include in your request, and the published unit value. All relational database metric data is available in 1-minute (60 seconds) granularity.

      • CPUUtilization - The percentage of CPU utilization currently in use on the database.

        Statistics: The most useful statistics are Maximum and Average.

        Unit: The published unit is Percent.

      • DatabaseConnections - The number of database connections in use.

        Statistics: The most useful statistics are Maximum and Sum.

        Unit: The published unit is Count.

      • DiskQueueDepth - The number of outstanding IOs (read/write requests) that are waiting to access the disk.

        Statistics: The most useful statistic is Sum.

        Unit: The published unit is Count.

      • FreeStorageSpace - The amount of available storage space.

        Statistics: The most useful statistic is Sum.

        Unit: The published unit is Bytes.

      • NetworkReceiveThroughput - The incoming (Receive) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.

        Statistics: The most useful statistic is Average.

        Unit: The published unit is Bytes/Second.

      • NetworkTransmitThroughput - The outgoing (Transmit) network traffic on the database, including both customer database traffic and AWS traffic used for monitoring and replication.

        Statistics: The most useful statistic is Average.

        Unit: The published unit is Bytes/Second.

      See Also:

    • period

      public final Integer period()

      The granularity, in seconds, of the returned data points.

      All relational database metric data is available in 1-minute (60 seconds) granularity.

      Returns:
      The granularity, in seconds, of the returned data points.

      All relational database metric data is available in 1-minute (60 seconds) granularity.

    • startTime

      public final Instant startTime()

      The start of the time interval from which to get metric data.

      Constraints:

      • Specified in Coordinated Universal Time (UTC).

      • Specified in the Unix time format.

        For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the start time.

      Returns:
      The start of the time interval from which to get metric data.

      Constraints:

      • Specified in Coordinated Universal Time (UTC).

      • Specified in the Unix time format.

        For example, if you wish to use a start time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the start time.

    • endTime

      public final Instant endTime()

      The end of the time interval from which to get metric data.

      Constraints:

      • Specified in Coordinated Universal Time (UTC).

      • Specified in the Unix time format.

        For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the end time.

      Returns:
      The end of the time interval from which to get metric data.

      Constraints:

      • Specified in Coordinated Universal Time (UTC).

      • Specified in the Unix time format.

        For example, if you wish to use an end time of October 1, 2018, at 8 PM UTC, then you input 1538424000 as the end time.

    • 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:

    • 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 - All values submitted for the matching metric added together. 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 - All values submitted for the matching metric added together. 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 - All values submitted for the matching metric added together. 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 - All values submitted for the matching metric added together. 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.

    • toBuilder

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

    • builder

      public static GetRelationalDatabaseMetricDataRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetRelationalDatabaseMetricDataRequest.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.