GetInstanceMetricDataRequest (AWS Java SDK :: Services

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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetInstanceMetricDataRequest.Builder,GetInstanceMetricDataRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetInstanceMetricDataRequest
extends LightsailRequest
implements ToCopyableBuilder<GetInstanceMetricDataRequest.Builder,GetInstanceMetricDataRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetInstanceMetricDataRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GetInstanceMetricDataRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GetInstanceMetricDataRequest.Builder`	`builder()`
`Instant`	`endTime()` The end time of the time period.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasStatistics()` Returns true if the Statistics property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`instanceName()` The name of the instance for which you want to get metrics data.
`InstanceMetricName`	`metricName()` The metric for which you want to return information.
`String`	`metricNameAsString()` The metric for which you want to return information.
`Integer`	`period()` The granularity, in seconds, of the returned data points.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetInstanceMetricDataRequest.Builder>`	`serializableBuilderClass()`
`Instant`	`startTime()` The start time of the time period.
`List<MetricStatistic>`	`statistics()` The statistic for the metric.
`List<String>`	`statisticsAsStrings()` The statistic for the metric.
`GetInstanceMetricDataRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`MetricUnit`	`unit()` The unit for the metric data request.
`String`	`unitAsString()` The unit for the metric data request.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - instanceName
```
public final String instanceName()
```
    The name of the instance for which you want to get metrics data.
    
    Returns:
    
    The name of the instance for which you want to get metrics data.
  - metricName
```
public final InstanceMetricName metricName()
```
    The metric for which you want to return information.
    
    Valid instance metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.
    - BurstCapacityPercentage - The percentage of CPU performance available for your instance to burst above its baseline. Your instance continuously accrues and consumes burst capacity. Burst capacity stops accruing when your instance's BurstCapacityPercentage reaches 100%. For more information, see Viewing instance burst capacity in Amazon Lightsail.
      
      Statistics: The most useful statistics are Maximum and Average.
      
      Unit: The published unit is Percent.
    - BurstCapacityTime - The available amount of time for your instance to burst at 100% CPU utilization. Your instance continuously accrues and consumes burst capacity. Burst capacity time stops accruing when your instance's BurstCapacityPercentage metric reaches 100%.
      
      Burst capacity time is consumed at the full rate only when your instance operates at 100% CPU utilization. For example, if your instance operates at 50% CPU utilization in the burstable zone for a 5-minute period, then it consumes CPU burst capacity minutes at a 50% rate in that period. Your instance consumed 2 minutes and 30 seconds of CPU burst capacity minutes in the 5-minute period. For more information, see Viewing instance burst capacity in Amazon Lightsail.
      
      Statistics: The most useful statistics are Maximum and Average.
      
      Unit: The published unit is Seconds.
    - CPUUtilization - The percentage of allocated compute units that are currently in use on the instance. This metric identifies the processing power to run the applications on the instance. Tools in your operating system can show a lower percentage than Lightsail when the instance is not allocated a full processor core.
      
      Statistics: The most useful statistics are Maximum and Average.
      
      Unit: The published unit is Percent.
    - NetworkIn - The number of bytes received on all network interfaces by the instance. This metric identifies the volume of incoming network traffic to the instance. The number reported is the number of bytes received during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second.
      
      Statistics: The most useful statistic is Sum.
      
      Unit: The published unit is Bytes.
    - NetworkOut - The number of bytes sent out on all network interfaces by the instance. This metric identifies the volume of outgoing network traffic from the instance. The number reported is the number of bytes sent during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second.
      
      Statistics: The most useful statistic is Sum.
      
      Unit: The published unit is Bytes.
    - StatusCheckFailed - Reports whether the instance passed or failed both the instance status check and the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.
      
      Statistics: The most useful statistic is Sum.
      
      Unit: The published unit is Count.
    - StatusCheckFailed_Instance - Reports whether the instance passed or failed the instance status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.
      
      Statistics: The most useful statistic is Sum.
      
      Unit: The published unit is Count.
    - StatusCheckFailed_System - Reports whether the instance passed or failed the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.
      
      Statistics: The most useful statistic is Sum.
      
      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 InstanceMetricName.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 instance metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.
    
    BurstCapacityPercentage - The percentage of CPU performance available for your instance to burst above its baseline. Your instance continuously accrues and consumes burst capacity. Burst capacity stops accruing when your instance's BurstCapacityPercentage reaches 100%. For more information, see Viewing instance burst capacity in Amazon Lightsail.
    
    Statistics: The most useful statistics are Maximum and Average.
    
    Unit: The published unit is Percent.
    
    BurstCapacityTime - The available amount of time for your instance to burst at 100% CPU utilization. Your instance continuously accrues and consumes burst capacity. Burst capacity time stops accruing when your instance's BurstCapacityPercentage metric reaches 100%.
    
    Burst capacity time is consumed at the full rate only when your instance operates at 100% CPU utilization. For example, if your instance operates at 50% CPU utilization in the burstable zone for a 5-minute period, then it consumes CPU burst capacity minutes at a 50% rate in that period. Your instance consumed 2 minutes and 30 seconds of CPU burst capacity minutes in the 5-minute period. For more information, see Viewing instance burst capacity in Amazon Lightsail.
    
    Statistics: The most useful statistics are Maximum and Average.
    
    Unit: The published unit is Seconds.
    
    CPUUtilization - The percentage of allocated compute units that are currently in use on the instance. This metric identifies the processing power to run the applications on the instance. Tools in your operating system can show a lower percentage than Lightsail when the instance is not allocated a full processor core.
    
    Statistics: The most useful statistics are Maximum and Average.
    
    Unit: The published unit is Percent.
    
    NetworkIn - The number of bytes received on all network interfaces by the instance. This metric identifies the volume of incoming network traffic to the instance. The number reported is the number of bytes received during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second.
    
    Statistics: The most useful statistic is Sum.
    
    Unit: The published unit is Bytes.
    
    NetworkOut - The number of bytes sent out on all network interfaces by the instance. This metric identifies the volume of outgoing network traffic from the instance. The number reported is the number of bytes sent during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second.
    
    Statistics: The most useful statistic is Sum.
    
    Unit: The published unit is Bytes.
    
    StatusCheckFailed - Reports whether the instance passed or failed both the instance status check and the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.
    
    Statistics: The most useful statistic is Sum.
    
    Unit: The published unit is Count.
    
    StatusCheckFailed_Instance - Reports whether the instance passed or failed the instance status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.
    
    Statistics: The most useful statistic is Sum.
    
    Unit: The published unit is Count.
    
    StatusCheckFailed_System - Reports whether the instance passed or failed the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.
    
    Statistics: The most useful statistic is Sum.
    
    Unit: The published unit is Count.
    See Also:
    
    InstanceMetricName
  - metricNameAsString
```
public final String metricNameAsString()
```
    The metric for which you want to return information.
    
    Valid instance metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.
    - BurstCapacityPercentage - The percentage of CPU performance available for your instance to burst above its baseline. Your instance continuously accrues and consumes burst capacity. Burst capacity stops accruing when your instance's BurstCapacityPercentage reaches 100%. For more information, see Viewing instance burst capacity in Amazon Lightsail.
      
      Statistics: The most useful statistics are Maximum and Average.
      
      Unit: The published unit is Percent.
    - BurstCapacityTime - The available amount of time for your instance to burst at 100% CPU utilization. Your instance continuously accrues and consumes burst capacity. Burst capacity time stops accruing when your instance's BurstCapacityPercentage metric reaches 100%.
      
      Burst capacity time is consumed at the full rate only when your instance operates at 100% CPU utilization. For example, if your instance operates at 50% CPU utilization in the burstable zone for a 5-minute period, then it consumes CPU burst capacity minutes at a 50% rate in that period. Your instance consumed 2 minutes and 30 seconds of CPU burst capacity minutes in the 5-minute period. For more information, see Viewing instance burst capacity in Amazon Lightsail.
      
      Statistics: The most useful statistics are Maximum and Average.
      
      Unit: The published unit is Seconds.
    - CPUUtilization - The percentage of allocated compute units that are currently in use on the instance. This metric identifies the processing power to run the applications on the instance. Tools in your operating system can show a lower percentage than Lightsail when the instance is not allocated a full processor core.
      
      Statistics: The most useful statistics are Maximum and Average.
      
      Unit: The published unit is Percent.
    - NetworkIn - The number of bytes received on all network interfaces by the instance. This metric identifies the volume of incoming network traffic to the instance. The number reported is the number of bytes received during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second.
      
      Statistics: The most useful statistic is Sum.
      
      Unit: The published unit is Bytes.
    - NetworkOut - The number of bytes sent out on all network interfaces by the instance. This metric identifies the volume of outgoing network traffic from the instance. The number reported is the number of bytes sent during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second.
      
      Statistics: The most useful statistic is Sum.
      
      Unit: The published unit is Bytes.
    - StatusCheckFailed - Reports whether the instance passed or failed both the instance status check and the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.
      
      Statistics: The most useful statistic is Sum.
      
      Unit: The published unit is Count.
    - StatusCheckFailed_Instance - Reports whether the instance passed or failed the instance status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.
      
      Statistics: The most useful statistic is Sum.
      
      Unit: The published unit is Count.
    - StatusCheckFailed_System - Reports whether the instance passed or failed the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.
      
      Statistics: The most useful statistic is Sum.
      
      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 InstanceMetricName.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 instance metric names are listed below, along with the most useful statistics to include in your request, and the published unit value.
    
    BurstCapacityPercentage - The percentage of CPU performance available for your instance to burst above its baseline. Your instance continuously accrues and consumes burst capacity. Burst capacity stops accruing when your instance's BurstCapacityPercentage reaches 100%. For more information, see Viewing instance burst capacity in Amazon Lightsail.
    
    Statistics: The most useful statistics are Maximum and Average.
    
    Unit: The published unit is Percent.
    
    BurstCapacityTime - The available amount of time for your instance to burst at 100% CPU utilization. Your instance continuously accrues and consumes burst capacity. Burst capacity time stops accruing when your instance's BurstCapacityPercentage metric reaches 100%.
    
    Burst capacity time is consumed at the full rate only when your instance operates at 100% CPU utilization. For example, if your instance operates at 50% CPU utilization in the burstable zone for a 5-minute period, then it consumes CPU burst capacity minutes at a 50% rate in that period. Your instance consumed 2 minutes and 30 seconds of CPU burst capacity minutes in the 5-minute period. For more information, see Viewing instance burst capacity in Amazon Lightsail.
    
    Statistics: The most useful statistics are Maximum and Average.
    
    Unit: The published unit is Seconds.
    
    CPUUtilization - The percentage of allocated compute units that are currently in use on the instance. This metric identifies the processing power to run the applications on the instance. Tools in your operating system can show a lower percentage than Lightsail when the instance is not allocated a full processor core.
    
    Statistics: The most useful statistics are Maximum and Average.
    
    Unit: The published unit is Percent.
    
    NetworkIn - The number of bytes received on all network interfaces by the instance. This metric identifies the volume of incoming network traffic to the instance. The number reported is the number of bytes received during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second.
    
    Statistics: The most useful statistic is Sum.
    
    Unit: The published unit is Bytes.
    
    NetworkOut - The number of bytes sent out on all network interfaces by the instance. This metric identifies the volume of outgoing network traffic from the instance. The number reported is the number of bytes sent during the period. Because this metric is reported in 5-minute intervals, divide the reported number by 300 to find Bytes/second.
    
    Statistics: The most useful statistic is Sum.
    
    Unit: The published unit is Bytes.
    
    StatusCheckFailed - Reports whether the instance passed or failed both the instance status check and the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.
    
    Statistics: The most useful statistic is Sum.
    
    Unit: The published unit is Count.
    
    StatusCheckFailed_Instance - Reports whether the instance passed or failed the instance status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.
    
    Statistics: The most useful statistic is Sum.
    
    Unit: The published unit is Count.
    
    StatusCheckFailed_System - Reports whether the instance passed or failed the system status check. This metric can be either 0 (passed) or 1 (failed). This metric data is available in 1-minute (60 seconds) granularity.
    
    Statistics: The most useful statistic is Sum.
    
    Unit: The published unit is Count.
    See Also:
    
    InstanceMetricName
  - period
```
public final Integer period()
```
    The granularity, in seconds, of the returned data points.
    
    The StatusCheckFailed, StatusCheckFailed_Instance, and StatusCheckFailed_System instance metric data is available in 1-minute (60 seconds) granularity. All other instance metric data is available in 5-minute (300 seconds) granularity.
    
    Returns:
    
    The granularity, in seconds, of the returned data points.
    
    The StatusCheckFailed, StatusCheckFailed_Instance, and StatusCheckFailed_System instance metric data is available in 1-minute (60 seconds) granularity. All other instance metric data is available in 5-minute (300 seconds) granularity.
  - startTime
```
public final Instant startTime()
```
    The start time of the time period.
    
    Returns:
    
    The start time of the time period.
  - endTime
```
public final Instant endTime()
```
    The end time of the time period.
    
    Returns:
    
    The end time of the time period.
  - 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 to specify 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 to specify with each available metric, see the metricName parameter.
    
    See Also:
    
    MetricUnit
  - 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 to specify 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 to specify with each available metric, see the metricName parameter.
    
    See Also:
    
    MetricUnit
  - 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.
    
    You can use hasStatistics() to see if a value was sent in this field.
    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()
```
    Returns true if the Statistics property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasStatistics() to see if a value was sent in this field.
    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 GetInstanceMetricDataRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetInstanceMetricDataRequest.Builder,GetInstanceMetricDataRequest>
    
    Specified by:
    
    toBuilder in class LightsailRequest
  - builder
```
public static GetInstanceMetricDataRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetInstanceMetricDataRequest.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class GetInstanceMetricDataRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

instanceName

metricName

metricNameAsString

period

startTime

endTime

unit

unitAsString

statistics

hasStatistics

statisticsAsStrings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields