Class GetInstanceMetricDataRequest
- 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("software.amazon.awssdk:codegen") public final class GetInstanceMetricDataRequest extends LightsailRequest implements ToCopyableBuilder<GetInstanceMetricDataRequest.Builder,GetInstanceMetricDataRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceGetInstanceMetricDataRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static GetInstanceMetricDataRequest.Builderbuilder()InstantendTime()The end time of the time period.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasStatistics()For responses, this returns true if the service returned a value for the Statistics property.StringinstanceName()The name of the instance for which you want to get metrics data.InstanceMetricNamemetricName()The metric for which you want to return information.StringmetricNameAsString()The metric for which you want to return information.Integerperiod()The granularity, in seconds, of the returned data points.List<SdkField<?>>sdkFields()static Class<? extends GetInstanceMetricDataRequest.Builder>serializableBuilderClass()InstantstartTime()The start time of the time period.List<MetricStatistic>statistics()The statistic for the metric.List<String>statisticsAsStrings()The statistic for the metric.GetInstanceMetricDataRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.MetricUnitunit()The unit for the metric data request.StringunitAsString()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
statisticsto include in your request, and the publishedunitvalue.-
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'sBurstCapacityPercentagereaches 100%. For more information, see Viewing instance burst capacity in Amazon Lightsail.Statistics: The most useful statistics areMaximumandAverage.Unit: The published unit isPercent. -
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'sBurstCapacityPercentagemetric 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 areMaximumandAverage.Unit: The published unit isSeconds. -
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 areMaximumandAverage.Unit: The published unit isPercent. -
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 isSum.Unit: The published unit isBytes. -
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 isSum.Unit: The published unit isBytes. -
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 isSum.Unit: The published unit isCount. -
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 isSum.Unit: The published unit isCount. -
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 isSum.Unit: The published unit isCount. -
MetadataNoToken- Reports the number of times that the instance metadata service was successfully accessed without a token. This metric determines if there are any processes accessing instance metadata by using Instance Metadata Service Version 1, which doesn't use a token. If all requests use token-backed sessions, such as Instance Metadata Service Version 2, then the value is 0.Statistics: The most useful statistic isSum.Unit: The published unit isCount.
If the service returns an enum value that is not available in the current SDK version,
metricNamewill returnInstanceMetricName.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 instance metric names are listed below, along with the most useful
statisticsto include in your request, and the publishedunitvalue.-
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'sBurstCapacityPercentagereaches 100%. For more information, see Viewing instance burst capacity in Amazon Lightsail.Statistics: The most useful statistics areMaximumandAverage.Unit: The published unit isPercent. -
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'sBurstCapacityPercentagemetric 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 areMaximumandAverage.Unit: The published unit isSeconds. -
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 areMaximumandAverage.Unit: The published unit isPercent. -
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 isSum.Unit: The published unit isBytes. -
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 isSum.Unit: The published unit isBytes. -
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 isSum.Unit: The published unit isCount. -
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 isSum.Unit: The published unit isCount. -
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 isSum.Unit: The published unit isCount. -
MetadataNoToken- Reports the number of times that the instance metadata service was successfully accessed without a token. This metric determines if there are any processes accessing instance metadata by using Instance Metadata Service Version 1, which doesn't use a token. If all requests use token-backed sessions, such as Instance Metadata Service Version 2, then the value is 0.Statistics: The most useful statistic isSum.Unit: The published unit isCount.
-
- 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
statisticsto include in your request, and the publishedunitvalue.-
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'sBurstCapacityPercentagereaches 100%. For more information, see Viewing instance burst capacity in Amazon Lightsail.Statistics: The most useful statistics areMaximumandAverage.Unit: The published unit isPercent. -
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'sBurstCapacityPercentagemetric 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 areMaximumandAverage.Unit: The published unit isSeconds. -
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 areMaximumandAverage.Unit: The published unit isPercent. -
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 isSum.Unit: The published unit isBytes. -
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 isSum.Unit: The published unit isBytes. -
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 isSum.Unit: The published unit isCount. -
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 isSum.Unit: The published unit isCount. -
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 isSum.Unit: The published unit isCount. -
MetadataNoToken- Reports the number of times that the instance metadata service was successfully accessed without a token. This metric determines if there are any processes accessing instance metadata by using Instance Metadata Service Version 1, which doesn't use a token. If all requests use token-backed sessions, such as Instance Metadata Service Version 2, then the value is 0.Statistics: The most useful statistic isSum.Unit: The published unit isCount.
If the service returns an enum value that is not available in the current SDK version,
metricNamewill returnInstanceMetricName.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 instance metric names are listed below, along with the most useful
statisticsto include in your request, and the publishedunitvalue.-
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'sBurstCapacityPercentagereaches 100%. For more information, see Viewing instance burst capacity in Amazon Lightsail.Statistics: The most useful statistics areMaximumandAverage.Unit: The published unit isPercent. -
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'sBurstCapacityPercentagemetric 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 areMaximumandAverage.Unit: The published unit isSeconds. -
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 areMaximumandAverage.Unit: The published unit isPercent. -
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 isSum.Unit: The published unit isBytes. -
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 isSum.Unit: The published unit isBytes. -
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 isSum.Unit: The published unit isCount. -
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 isSum.Unit: The published unit isCount. -
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 isSum.Unit: The published unit isCount. -
MetadataNoToken- Reports the number of times that the instance metadata service was successfully accessed without a token. This metric determines if there are any processes accessing instance metadata by using Instance Metadata Service Version 1, which doesn't use a token. If all requests use token-backed sessions, such as Instance Metadata Service Version 2, then the value is 0.Statistics: The most useful statistic isSum.Unit: The published unit isCount.
-
- See Also:
InstanceMetricName
-
-
period
public final Integer period()
The granularity, in seconds, of the returned data points.
The
StatusCheckFailed,StatusCheckFailed_Instance, andStatusCheckFailed_Systeminstance 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, andStatusCheckFailed_Systeminstance 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
metricNameparameter.If the service returns an enum value that is not available in the current SDK version,
unitwill 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 to specify with each available metric, see the
metricNameparameter. - 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
metricNameparameter.If the service returns an enum value that is not available in the current SDK version,
unitwill 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 to specify with each available metric, see the
metricNameparameter. - 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.
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 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
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 GetInstanceMetricDataRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<GetInstanceMetricDataRequest.Builder,GetInstanceMetricDataRequest>- Specified by:
toBuilderin classLightsailRequest
-
builder
public static GetInstanceMetricDataRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetInstanceMetricDataRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-