Package software.amazon.awssdk.services.pi.model

Class AnalysisReport

java.lang.Object

software.amazon.awssdk.services.pi.model.AnalysisReport

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AnalysisReport.Builder,AnalysisReport>

@Generated("software.amazon.awssdk:codegen")
public final class AnalysisReport
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AnalysisReport.Builder,AnalysisReport>

Retrieves the summary of the performance analysis report created for a time period.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AnalysisReport.Builder

Method Summary

Modifier and Type	Method	Description
String	analysisReportId()	The name of the analysis report.
static AnalysisReport.Builder	builder()
Instant	createTime()	The time you created the analysis report.
Instant	endTime()	The analysis end time in the report.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInsights()	For responses, this returns true if the service returned a value for the Insights property.
String	identifier()	The unique identifier of the analysis report.
List<Insight>	insights()	The list of identified insights in the analysis report.
List<SdkField<?>>	sdkFields()
static Class<? extends AnalysisReport.Builder>	serializableBuilderClass()
ServiceType	serviceType()	List the tags for the Amazon Web Services service for which Performance Insights returns metrics.
String	serviceTypeAsString()	List the tags for the Amazon Web Services service for which Performance Insights returns metrics.
Instant	startTime()	The analysis start time in the report.
AnalysisStatus	status()	The status of the created analysis report.
String	statusAsString()	The status of the created analysis report.
AnalysisReport.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

analysisReportId

public final String analysisReportId()

The name of the analysis report.

Returns:

The name of the analysis report.

identifier

public final String identifier()

The unique identifier of the analysis report.

Returns:

The unique identifier of the analysis report.

serviceType

public final ServiceType serviceType()

List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:

• RDS

• DOCDB

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

Returns:

List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:

• RDS

• DOCDB

See Also:

ServiceType

serviceTypeAsString

public final String serviceTypeAsString()

List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:

• RDS

• DOCDB

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

Returns:

List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:

• RDS

• DOCDB

See Also:

ServiceType

createTime

public final Instant createTime()

The time you created the analysis report.

Returns:

The time you created the analysis report.

startTime

public final Instant startTime()

The analysis start time in the report.

Returns:

The analysis start time in the report.

endTime

public final Instant endTime()

The analysis end time in the report.

Returns:

The analysis end time in the report.

status

public final AnalysisStatus status()

The status of the created analysis report.

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

Returns:

The status of the created analysis report.

See Also:

AnalysisStatus

statusAsString

public final String statusAsString()

The status of the created analysis report.

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

Returns:

The status of the created analysis report.

See Also:

AnalysisStatus

hasInsights

public final boolean hasInsights()

For responses, this returns true if the service returned a value for the Insights 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.

insights

public final List<Insight> insights()

The list of identified insights in the analysis report.

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 hasInsights() method.

Returns:

The list of identified insights in the analysis report.

toBuilder

public AnalysisReport.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AnalysisReport.Builder,AnalysisReport>

builder

public static AnalysisReport.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo