software.amazon.awssdk.services.lightsail.model

Class GetRelationalDatabaseMetricDataRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.lightsail.model.LightsailRequest

software.amazon.awssdk.services.lightsail.model.GetRelationalDatabaseMetricDataRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetRelationalDatabaseMetricDataRequest.Builder,GetRelationalDatabaseMetricDataRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetRelationalDatabaseMetricDataRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetRelationalDatabaseMetricDataRequest.Builder	builder()
Instant	endTime() The end of the time interval from which to get metric data.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
RelationalDatabaseMetricName	metricName() The name of the metric data to return.
String	metricNameAsString() The name of the metric data to return.
Integer	period() The granularity, in seconds, of the returned data points.
String	relationalDatabaseName() The name of your database from which to get metric data.
List<SdkField<?>>	sdkFields()
static Class<? extends GetRelationalDatabaseMetricDataRequest.Builder>	serializableBuilderClass()
Instant	startTime() The start of the time interval from which to get metric data.
List<MetricStatistic>	statistics() The array of statistics for your metric data request.
List<String>	statisticsAsStrings() The array of statistics for your metric data request.
GetRelationalDatabaseMetricDataRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
MetricUnit	unit() The unit for the metric data request.
String	unitAsString() The unit for the metric data request.

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

relationalDatabaseName

public String relationalDatabaseName()

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

Returns:

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

metricName

public RelationalDatabaseMetricName metricName()

The name of the metric data to return.

If the service returns an enum value that is not available in the current SDK version, metricName will return RelationalDatabaseMetricName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricNameAsString().

Returns:

The name of the metric data to return.

See Also:

RelationalDatabaseMetricName

metricNameAsString

public String metricNameAsString()

The name of the metric data to return.

If the service returns an enum value that is not available in the current SDK version, metricName will return RelationalDatabaseMetricName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricNameAsString().

Returns:

The name of the metric data to return.

See Also:

RelationalDatabaseMetricName

period

public Integer period()

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

Returns:

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

startTime

public Instant startTime()

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

Constraints:

• Specified in Universal Coordinated 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:

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

Constraints:

• Specified in Universal Coordinated 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.

endTime

public Instant endTime()

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

Constraints:

• Specified in Universal Coordinated 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:

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

Constraints:

• Specified in Universal Coordinated 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.

unit

public MetricUnit unit()

The unit for the metric data request.

If the service returns an enum value that is not available in the current SDK version, unit will return MetricUnit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from unitAsString().

Returns:

The unit for the metric data request.

See Also:

MetricUnit

unitAsString

public String unitAsString()

The unit for the metric data request.

If the service returns an enum value that is not available in the current SDK version, unit will return MetricUnit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from unitAsString().

Returns:

The unit for the metric data request.

See Also:

MetricUnit

statistics

public List<MetricStatistic> statistics()

The array of statistics for your metric data request.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The array of statistics for your metric data request.

statisticsAsStrings

public List<String> statisticsAsStrings()

The array of statistics for your metric data request.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The array of statistics for your metric data request.

toBuilder

public GetRelationalDatabaseMetricDataRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetRelationalDatabaseMetricDataRequest.Builder,GetRelationalDatabaseMetricDataRequest>

Specified by:

toBuilder in class LightsailRequest

Returns:

a builder for type T

builder

public static GetRelationalDatabaseMetricDataRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetRelationalDatabaseMetricDataRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.