Package software.amazon.awssdk.services.lightsail.model

Class GetInstanceMetricDataResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.lightsail.model.LightsailResponse

software.amazon.awssdk.services.lightsail.model.GetInstanceMetricDataResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetInstanceMetricDataResponse.Builder,GetInstanceMetricDataResponse>

@Generated("software.amazon.awssdk:codegen")
public final class GetInstanceMetricDataResponse
extends LightsailResponse
implements ToCopyableBuilder<GetInstanceMetricDataResponse.Builder,GetInstanceMetricDataResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetInstanceMetricDataResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetInstanceMetricDataResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMetricData()	For responses, this returns true if the service returned a value for the MetricData property.
List<MetricDatapoint>	metricData()	An array of objects that describe the metric data returned.
InstanceMetricName	metricName()	The name of the metric returned.
String	metricNameAsString()	The name of the metric returned.
List<SdkField<?>>	sdkFields()
static Class<? extends GetInstanceMetricDataResponse.Builder>	serializableBuilderClass()
GetInstanceMetricDataResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.lightsail.model.LightsailResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

metricName

public final InstanceMetricName metricName()

The name of the metric returned.

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

Returns:

The name of the metric returned.

See Also:

InstanceMetricName

metricNameAsString

public final String metricNameAsString()

The name of the metric returned.

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

Returns:

The name of the metric returned.

See Also:

InstanceMetricName

hasMetricData

public final boolean hasMetricData()

For responses, this returns true if the service returned a value for the MetricData property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

metricData

public final List<MetricDatapoint> metricData()

An array of objects that describe the metric data returned.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetricData() method.

Returns:

An array of objects that describe the metric data returned.

toBuilder

public GetInstanceMetricDataResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetInstanceMetricDataResponse.Builder,GetInstanceMetricDataResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetInstanceMetricDataResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo