software.amazon.awssdk.services.lightsail.model

Interface GetRelationalDatabaseMetricDataRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<GetRelationalDatabaseMetricDataRequest.Builder,GetRelationalDatabaseMetricDataRequest>, LightsailRequest.Builder, SdkBuilder<GetRelationalDatabaseMetricDataRequest.Builder,GetRelationalDatabaseMetricDataRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GetRelationalDatabaseMetricDataRequest

public static interface GetRelationalDatabaseMetricDataRequest.Builder
extends LightsailRequest.Builder, SdkPojo, CopyableBuilder<GetRelationalDatabaseMetricDataRequest.Builder,GetRelationalDatabaseMetricDataRequest>

Method Summary

Modifier and Type	Method and Description
GetRelationalDatabaseMetricDataRequest.Builder	endTime(Instant endTime) The end of the time interval from which to get metric data.
GetRelationalDatabaseMetricDataRequest.Builder	metricName(RelationalDatabaseMetricName metricName) The metric for which you want to return information.
GetRelationalDatabaseMetricDataRequest.Builder	metricName(String metricName) The metric for which you want to return information.
GetRelationalDatabaseMetricDataRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
GetRelationalDatabaseMetricDataRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
GetRelationalDatabaseMetricDataRequest.Builder	period(Integer period) The granularity, in seconds, of the returned data points.
GetRelationalDatabaseMetricDataRequest.Builder	relationalDatabaseName(String relationalDatabaseName) The name of your database from which to get metric data.
GetRelationalDatabaseMetricDataRequest.Builder	startTime(Instant startTime) The start of the time interval from which to get metric data.
GetRelationalDatabaseMetricDataRequest.Builder	statistics(Collection<MetricStatistic> statistics) The statistic for the metric.
GetRelationalDatabaseMetricDataRequest.Builder	statistics(MetricStatistic... statistics) The statistic for the metric.
GetRelationalDatabaseMetricDataRequest.Builder	statisticsWithStrings(Collection<String> statistics) The statistic for the metric.
GetRelationalDatabaseMetricDataRequest.Builder	statisticsWithStrings(String... statistics) The statistic for the metric.
GetRelationalDatabaseMetricDataRequest.Builder	unit(MetricUnit unit) The unit for the metric data request.
GetRelationalDatabaseMetricDataRequest.Builder	unit(String unit) The unit for the metric data request.

Methods inherited from interface software.amazon.awssdk.services.lightsail.model.LightsailRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

relationalDatabaseName

GetRelationalDatabaseMetricDataRequest.Builder relationalDatabaseName(String relationalDatabaseName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

metricName

GetRelationalDatabaseMetricDataRequest.Builder metricName(String metricName)

The metric for which you want to return information.

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

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

  Statistics: The most useful statistics are Maximum and Average.

  Unit: The published unit is Percent.

• DatabaseConnections - The number of database connections in use.

  Statistics: The most useful statistics are Maximum and Sum.

  Unit: The published unit is Count.

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

  Statistics: The most useful statistic is Sum.

  Unit: The published unit is Count.

• FreeStorageSpace - The amount of available storage space.

  Statistics: The most useful statistic is Sum.

  Unit: The published unit is Bytes.

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

  Statistics: The most useful statistic is Average.

  Unit: The published unit is Bytes/Second.

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

  Statistics: The most useful statistic is Average.

  Unit: The published unit is Bytes/Second.

Parameters:

metricName - The metric for which you want to return information.

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

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

  Statistics: The most useful statistics are Maximum and Average.

  Unit: The published unit is Percent.

• DatabaseConnections - The number of database connections in use.

  Statistics: The most useful statistics are Maximum and Sum.

  Unit: The published unit is Count.

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

  Statistics: The most useful statistic is Sum.

  Unit: The published unit is Count.

• FreeStorageSpace - The amount of available storage space.

  Statistics: The most useful statistic is Sum.

  Unit: The published unit is Bytes.

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

  Statistics: The most useful statistic is Average.

  Unit: The published unit is Bytes/Second.

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

  Statistics: The most useful statistic is Average.

  Unit: The published unit is Bytes/Second.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RelationalDatabaseMetricName, RelationalDatabaseMetricName

metricName

GetRelationalDatabaseMetricDataRequest.Builder metricName(RelationalDatabaseMetricName metricName)

The metric for which you want to return information.

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

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

  Statistics: The most useful statistics are Maximum and Average.

  Unit: The published unit is Percent.

• DatabaseConnections - The number of database connections in use.

  Statistics: The most useful statistics are Maximum and Sum.

  Unit: The published unit is Count.

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

  Statistics: The most useful statistic is Sum.

  Unit: The published unit is Count.

• FreeStorageSpace - The amount of available storage space.

  Statistics: The most useful statistic is Sum.

  Unit: The published unit is Bytes.

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

  Statistics: The most useful statistic is Average.

  Unit: The published unit is Bytes/Second.

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

  Statistics: The most useful statistic is Average.

  Unit: The published unit is Bytes/Second.

Parameters:

metricName - The metric for which you want to return information.

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

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

  Statistics: The most useful statistics are Maximum and Average.

  Unit: The published unit is Percent.

• DatabaseConnections - The number of database connections in use.

  Statistics: The most useful statistics are Maximum and Sum.

  Unit: The published unit is Count.

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

  Statistics: The most useful statistic is Sum.

  Unit: The published unit is Count.

• FreeStorageSpace - The amount of available storage space.

  Statistics: The most useful statistic is Sum.

  Unit: The published unit is Bytes.

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

  Statistics: The most useful statistic is Average.

  Unit: The published unit is Bytes/Second.

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

  Statistics: The most useful statistic is Average.

  Unit: The published unit is Bytes/Second.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RelationalDatabaseMetricName, RelationalDatabaseMetricName

period

GetRelationalDatabaseMetricDataRequest.Builder period(Integer period)

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

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

Parameters:

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

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

Returns:

Returns a reference to this object so that method calls can be chained together.

startTime

GetRelationalDatabaseMetricDataRequest.Builder startTime(Instant startTime)

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

Constraints:

• Specified in Coordinated Universal Time (UTC).

• Specified in the Unix time format.

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

Parameters:

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

Constraints:

• Specified in Coordinated Universal Time (UTC).

• Specified in the Unix time format.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

endTime

GetRelationalDatabaseMetricDataRequest.Builder endTime(Instant endTime)

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

Constraints:

• Specified in Coordinated Universal Time (UTC).

• Specified in the Unix time format.

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

Parameters:

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

Constraints:

• Specified in Coordinated Universal Time (UTC).

• Specified in the Unix time format.

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

Returns:

Returns a reference to this object so that method calls can be chained together.

unit

GetRelationalDatabaseMetricDataRequest.Builder unit(String unit)

The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

Parameters:

unit - The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MetricUnit, MetricUnit

unit

GetRelationalDatabaseMetricDataRequest.Builder unit(MetricUnit unit)

The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

Parameters:

unit - The unit for the metric data request. Valid units depend on the metric data being requested. For the valid units with each available metric, see the metricName parameter.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MetricUnit, MetricUnit

statisticsWithStrings

GetRelationalDatabaseMetricDataRequest.Builder statisticsWithStrings(Collection<String> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

statisticsWithStrings

GetRelationalDatabaseMetricDataRequest.Builder statisticsWithStrings(String... 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

statistics

GetRelationalDatabaseMetricDataRequest.Builder statistics(Collection<MetricStatistic> statistics)

The statistic for the metric.

The following statistics are available:

• Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

• Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

• Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.

• Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

• SampleCount - The count, or number, of data points used for the statistical calculation.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

statistics

GetRelationalDatabaseMetricDataRequest.Builder statistics(MetricStatistic... statistics)

The statistic for the metric.

The following statistics are available:

• Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.

• Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.

• Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.

• Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.

• SampleCount - The count, or number, of data points used for the statistical calculation.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

GetRelationalDatabaseMetricDataRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

GetRelationalDatabaseMetricDataRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder