com.amazonaws.services.lightsail.model.GetInstanceMetricDataRequest Maven / Gradle / Ivy
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.lightsail.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GetInstanceMetricDataRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the instance for which you want to get metrics data.
*
*/
private String instanceName;
/**
*
* 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.
*
*
* -
*
* 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 is Sum.
*
*
* Unit: The published unit is Count.
*
*
*
*/
private String metricName;
/**
*
* 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.
*
*/
private Integer period;
/**
*
* The start time of the time period.
*
*/
private java.util.Date startTime;
/**
*
* The end time of the time period.
*
*/
private java.util.Date endTime;
/**
*
* 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.
*
*/
private String unit;
/**
*
* 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.
*
*
*
*/
private java.util.List statistics;
/**
*
* The name of the instance for which you want to get metrics data.
*
*
* @param instanceName
* The name of the instance for which you want to get metrics data.
*/
public void setInstanceName(String instanceName) {
this.instanceName = instanceName;
}
/**
*
* The name of the instance for which you want to get metrics data.
*
*
* @return The name of the instance for which you want to get metrics data.
*/
public String getInstanceName() {
return this.instanceName;
}
/**
*
* The name of the instance for which you want to get metrics data.
*
*
* @param instanceName
* The name of the instance for which you want to get metrics data.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetInstanceMetricDataRequest withInstanceName(String instanceName) {
setInstanceName(instanceName);
return this;
}
/**
*
* 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.
*
*
* -
*
* 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 is Sum.
*
*
* Unit: The published unit is Count.
*
*
*
*
* @param 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.
*
*
* -
*
* 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 is Sum.
*
*
* Unit: The published unit is Count.
*
*
* @see InstanceMetricName
*/
public void setMetricName(String metricName) {
this.metricName = 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.
*
*
* -
*
* 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 is Sum.
*
*
* Unit: The published unit is Count.
*
*
*
*
* @return 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.
*
*
* -
*
* 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 is Sum.
*
*
* Unit: The published unit is Count.
*
*
* @see InstanceMetricName
*/
public String getMetricName() {
return this.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.
*
*
* -
*
* 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 is Sum.
*
*
* Unit: The published unit is Count.
*
*
*
*
* @param 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.
*
*
* -
*
* 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 is Sum.
*
*
* Unit: The published unit is Count.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see InstanceMetricName
*/
public GetInstanceMetricDataRequest withMetricName(String metricName) {
setMetricName(metricName);
return this;
}
/**
*
* 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.
*
*
* -
*
* 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 is Sum.
*
*
* Unit: The published unit is Count.
*
*
*
*
* @param 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.
*
*
* -
*
* 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 is Sum.
*
*
* Unit: The published unit is Count.
*
*
* @see InstanceMetricName
*/
public void setMetricName(InstanceMetricName metricName) {
withMetricName(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.
*
*
* -
*
* 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 is Sum.
*
*
* Unit: The published unit is Count.
*
*
*
*
* @param 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.
*
*
* -
*
* 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 is Sum.
*
*
* Unit: The published unit is Count.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see InstanceMetricName
*/
public GetInstanceMetricDataRequest withMetricName(InstanceMetricName metricName) {
this.metricName = metricName.toString();
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setPeriod(Integer period) {
this.period = 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.
*
*
* @return 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.
*/
public Integer getPeriod() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetInstanceMetricDataRequest withPeriod(Integer period) {
setPeriod(period);
return this;
}
/**
*
* The start time of the time period.
*
*
* @param startTime
* The start time of the time period.
*/
public void setStartTime(java.util.Date startTime) {
this.startTime = startTime;
}
/**
*
* The start time of the time period.
*
*
* @return The start time of the time period.
*/
public java.util.Date getStartTime() {
return this.startTime;
}
/**
*
* The start time of the time period.
*
*
* @param startTime
* The start time of the time period.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetInstanceMetricDataRequest withStartTime(java.util.Date startTime) {
setStartTime(startTime);
return this;
}
/**
*
* The end time of the time period.
*
*
* @param endTime
* The end time of the time period.
*/
public void setEndTime(java.util.Date endTime) {
this.endTime = endTime;
}
/**
*
* The end time of the time period.
*
*
* @return The end time of the time period.
*/
public java.util.Date getEndTime() {
return this.endTime;
}
/**
*
* The end time of the time period.
*
*
* @param endTime
* The end time of the time period.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetInstanceMetricDataRequest withEndTime(java.util.Date endTime) {
setEndTime(endTime);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @see MetricUnit
*/
public void setUnit(String unit) {
this.unit = 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.
*
*
* @return 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 MetricUnit
*/
public String getUnit() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MetricUnit
*/
public GetInstanceMetricDataRequest withUnit(String unit) {
setUnit(unit);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @see MetricUnit
*/
public void setUnit(MetricUnit unit) {
withUnit(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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see MetricUnit
*/
public GetInstanceMetricDataRequest withUnit(MetricUnit unit) {
this.unit = unit.toString();
return this;
}
/**
*
* 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.
*
*
*
*
* @return 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.
*
*
* @see MetricStatistic
*/
public java.util.List getStatistics() {
return 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.
*
*
*
*
* @param 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.
*
*
* @see MetricStatistic
*/
public void setStatistics(java.util.Collection statistics) {
if (statistics == null) {
this.statistics = null;
return;
}
this.statistics = new java.util.ArrayList(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.
*
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setStatistics(java.util.Collection)} or {@link #withStatistics(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see MetricStatistic
*/
public GetInstanceMetricDataRequest withStatistics(String... statistics) {
if (this.statistics == null) {
setStatistics(new java.util.ArrayList(statistics.length));
}
for (String ele : statistics) {
this.statistics.add(ele);
}
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see MetricStatistic
*/
public GetInstanceMetricDataRequest withStatistics(java.util.Collection statistics) {
setStatistics(statistics);
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see MetricStatistic
*/
public GetInstanceMetricDataRequest withStatistics(MetricStatistic... statistics) {
java.util.ArrayList statisticsCopy = new java.util.ArrayList(statistics.length);
for (MetricStatistic value : statistics) {
statisticsCopy.add(value.toString());
}
if (getStatistics() == null) {
setStatistics(statisticsCopy);
} else {
getStatistics().addAll(statisticsCopy);
}
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getInstanceName() != null)
sb.append("InstanceName: ").append(getInstanceName()).append(",");
if (getMetricName() != null)
sb.append("MetricName: ").append(getMetricName()).append(",");
if (getPeriod() != null)
sb.append("Period: ").append(getPeriod()).append(",");
if (getStartTime() != null)
sb.append("StartTime: ").append(getStartTime()).append(",");
if (getEndTime() != null)
sb.append("EndTime: ").append(getEndTime()).append(",");
if (getUnit() != null)
sb.append("Unit: ").append(getUnit()).append(",");
if (getStatistics() != null)
sb.append("Statistics: ").append(getStatistics());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetInstanceMetricDataRequest == false)
return false;
GetInstanceMetricDataRequest other = (GetInstanceMetricDataRequest) obj;
if (other.getInstanceName() == null ^ this.getInstanceName() == null)
return false;
if (other.getInstanceName() != null && other.getInstanceName().equals(this.getInstanceName()) == false)
return false;
if (other.getMetricName() == null ^ this.getMetricName() == null)
return false;
if (other.getMetricName() != null && other.getMetricName().equals(this.getMetricName()) == false)
return false;
if (other.getPeriod() == null ^ this.getPeriod() == null)
return false;
if (other.getPeriod() != null && other.getPeriod().equals(this.getPeriod()) == false)
return false;
if (other.getStartTime() == null ^ this.getStartTime() == null)
return false;
if (other.getStartTime() != null && other.getStartTime().equals(this.getStartTime()) == false)
return false;
if (other.getEndTime() == null ^ this.getEndTime() == null)
return false;
if (other.getEndTime() != null && other.getEndTime().equals(this.getEndTime()) == false)
return false;
if (other.getUnit() == null ^ this.getUnit() == null)
return false;
if (other.getUnit() != null && other.getUnit().equals(this.getUnit()) == false)
return false;
if (other.getStatistics() == null ^ this.getStatistics() == null)
return false;
if (other.getStatistics() != null && other.getStatistics().equals(this.getStatistics()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getInstanceName() == null) ? 0 : getInstanceName().hashCode());
hashCode = prime * hashCode + ((getMetricName() == null) ? 0 : getMetricName().hashCode());
hashCode = prime * hashCode + ((getPeriod() == null) ? 0 : getPeriod().hashCode());
hashCode = prime * hashCode + ((getStartTime() == null) ? 0 : getStartTime().hashCode());
hashCode = prime * hashCode + ((getEndTime() == null) ? 0 : getEndTime().hashCode());
hashCode = prime * hashCode + ((getUnit() == null) ? 0 : getUnit().hashCode());
hashCode = prime * hashCode + ((getStatistics() == null) ? 0 : getStatistics().hashCode());
return hashCode;
}
@Override
public GetInstanceMetricDataRequest clone() {
return (GetInstanceMetricDataRequest) super.clone();
}
}