/* * 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 GetContainerServiceMetricDataRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* The name of the container service for which to get metric data. *
*/ private String serviceName; /** ** The metric for which you want to return information. *
** Valid container service metric names are listed below, along with the most useful statistics to include in your * request, and the published unit value. *
*
* CPUUtilization
- The average percentage of compute units that are currently in use across all nodes
* of the container service. This metric identifies the processing power required to run containers on each node of
* the container service.
*
* Statistics: The most useful statistics are Maximum
and Average
.
*
* Unit: The published unit is Percent
.
*
* MemoryUtilization
- The average percentage of available memory that is currently in use across all
* nodes of the container service. This metric identifies the memory required to run containers on each node of the
* container service.
*
* Statistics: The most useful statistics are Maximum
and Average
.
*
* Unit: The published unit is Percent
.
*
* 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 granularity, in seconds, of the returned data points. *
** All container service metric data is available in 5-minute (300 seconds) granularity. *
*/ private Integer period; /** ** 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.
*
* The name of the container service for which to get metric data. *
* * @param serviceName * The name of the container service for which to get metric data. */ public void setServiceName(String serviceName) { this.serviceName = serviceName; } /** ** The name of the container service for which to get metric data. *
* * @return The name of the container service for which to get metric data. */ public String getServiceName() { return this.serviceName; } /** ** The name of the container service for which to get metric data. *
* * @param serviceName * The name of the container service for which to get metric data. * @return Returns a reference to this object so that method calls can be chained together. */ public GetContainerServiceMetricDataRequest withServiceName(String serviceName) { setServiceName(serviceName); return this; } /** ** The metric for which you want to return information. *
** Valid container service metric names are listed below, along with the most useful statistics to include in your * request, and the published unit value. *
*
* CPUUtilization
- The average percentage of compute units that are currently in use across all nodes
* of the container service. This metric identifies the processing power required to run containers on each node of
* the container service.
*
* Statistics: The most useful statistics are Maximum
and Average
.
*
* Unit: The published unit is Percent
.
*
* MemoryUtilization
- The average percentage of available memory that is currently in use across all
* nodes of the container service. This metric identifies the memory required to run containers on each node of the
* container service.
*
* Statistics: The most useful statistics are Maximum
and Average
.
*
* Unit: The published unit is Percent
.
*
* Valid container service metric names are listed below, along with the most useful statistics to include in * your request, and the published unit value. *
*
* CPUUtilization
- The average percentage of compute units that are currently in use across all
* nodes of the container service. This metric identifies the processing power required to run containers on
* each node of the container service.
*
* Statistics: The most useful statistics are Maximum
and Average
.
*
* Unit: The published unit is Percent
.
*
* MemoryUtilization
- The average percentage of available memory that is currently in use
* across all nodes of the container service. This metric identifies the memory required to run containers on
* each node of the container service.
*
* Statistics: The most useful statistics are Maximum
and Average
.
*
* Unit: The published unit is Percent
.
*
* The metric for which you want to return information. *
** Valid container service metric names are listed below, along with the most useful statistics to include in your * request, and the published unit value. *
*
* CPUUtilization
- The average percentage of compute units that are currently in use across all nodes
* of the container service. This metric identifies the processing power required to run containers on each node of
* the container service.
*
* Statistics: The most useful statistics are Maximum
and Average
.
*
* Unit: The published unit is Percent
.
*
* MemoryUtilization
- The average percentage of available memory that is currently in use across all
* nodes of the container service. This metric identifies the memory required to run containers on each node of the
* container service.
*
* Statistics: The most useful statistics are Maximum
and Average
.
*
* Unit: The published unit is Percent
.
*
* Valid container service metric names are listed below, along with the most useful statistics to include * in your request, and the published unit value. *
*
* CPUUtilization
- The average percentage of compute units that are currently in use across
* all nodes of the container service. This metric identifies the processing power required to run
* containers on each node of the container service.
*
* Statistics: The most useful statistics are Maximum
and Average
.
*
* Unit: The published unit is Percent
.
*
* MemoryUtilization
- The average percentage of available memory that is currently in use
* across all nodes of the container service. This metric identifies the memory required to run containers
* on each node of the container service.
*
* Statistics: The most useful statistics are Maximum
and Average
.
*
* Unit: The published unit is Percent
.
*
* The metric for which you want to return information. *
** Valid container service metric names are listed below, along with the most useful statistics to include in your * request, and the published unit value. *
*
* CPUUtilization
- The average percentage of compute units that are currently in use across all nodes
* of the container service. This metric identifies the processing power required to run containers on each node of
* the container service.
*
* Statistics: The most useful statistics are Maximum
and Average
.
*
* Unit: The published unit is Percent
.
*
* MemoryUtilization
- The average percentage of available memory that is currently in use across all
* nodes of the container service. This metric identifies the memory required to run containers on each node of the
* container service.
*
* Statistics: The most useful statistics are Maximum
and Average
.
*
* Unit: The published unit is Percent
.
*
* Valid container service metric names are listed below, along with the most useful statistics to include in * your request, and the published unit value. *
*
* CPUUtilization
- The average percentage of compute units that are currently in use across all
* nodes of the container service. This metric identifies the processing power required to run containers on
* each node of the container service.
*
* Statistics: The most useful statistics are Maximum
and Average
.
*
* Unit: The published unit is Percent
.
*
* MemoryUtilization
- The average percentage of available memory that is currently in use
* across all nodes of the container service. This metric identifies the memory required to run containers on
* each node of the container service.
*
* Statistics: The most useful statistics are Maximum
and Average
.
*
* Unit: The published unit is Percent
.
*
* The metric for which you want to return information. *
** Valid container service metric names are listed below, along with the most useful statistics to include in your * request, and the published unit value. *
*
* CPUUtilization
- The average percentage of compute units that are currently in use across all nodes
* of the container service. This metric identifies the processing power required to run containers on each node of
* the container service.
*
* Statistics: The most useful statistics are Maximum
and Average
.
*
* Unit: The published unit is Percent
.
*
* MemoryUtilization
- The average percentage of available memory that is currently in use across all
* nodes of the container service. This metric identifies the memory required to run containers on each node of the
* container service.
*
* Statistics: The most useful statistics are Maximum
and Average
.
*
* Unit: The published unit is Percent
.
*
* Valid container service metric names are listed below, along with the most useful statistics to include in * your request, and the published unit value. *
*
* CPUUtilization
- The average percentage of compute units that are currently in use across all
* nodes of the container service. This metric identifies the processing power required to run containers on
* each node of the container service.
*
* Statistics: The most useful statistics are Maximum
and Average
.
*
* Unit: The published unit is Percent
.
*
* MemoryUtilization
- The average percentage of available memory that is currently in use
* across all nodes of the container service. This metric identifies the memory required to run containers on
* each node of the container service.
*
* Statistics: The most useful statistics are Maximum
and Average
.
*
* Unit: The published unit is Percent
.
*
* 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 GetContainerServiceMetricDataRequest 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 GetContainerServiceMetricDataRequest withEndTime(java.util.Date endTime) { setEndTime(endTime); return this; } /** ** The granularity, in seconds, of the returned data points. *
** All container service metric data is available in 5-minute (300 seconds) granularity. *
* * @param period * The granularity, in seconds, of the returned data points. ** All container service 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. *
** All container service metric data is available in 5-minute (300 seconds) granularity. *
* * @return The granularity, in seconds, of the returned data points. ** All container service 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. *
** All container service metric data is available in 5-minute (300 seconds) granularity. *
* * @param period * The granularity, in seconds, of the returned data points. ** All container service 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 GetContainerServiceMetricDataRequest withPeriod(Integer period) { setPeriod(period); 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*
* 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.
*