software.amazon.awssdk.services.pi.model

Class GetPerformanceAnalysisReportRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.pi.model.PiRequest

software.amazon.awssdk.services.pi.model.GetPerformanceAnalysisReportRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetPerformanceAnalysisReportRequest.Builder,GetPerformanceAnalysisReportRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetPerformanceAnalysisReportRequest.Builder

Method Summary

Modifier and Type	Method and Description
AcceptLanguage	acceptLanguage() The text language in the report.
String	acceptLanguageAsString() The text language in the report.
String	analysisReportId() A unique identifier of the created analysis report.
static GetPerformanceAnalysisReportRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	identifier() An immutable identifier for a data source that is unique for an Amazon Web Services Region.
List<SdkField<?>>	sdkFields()
static Class<? extends GetPerformanceAnalysisReportRequest.Builder>	serializableBuilderClass()
ServiceType	serviceType() The Amazon Web Services service for which Performance Insights will return metrics.
String	serviceTypeAsString() The Amazon Web Services service for which Performance Insights will return metrics.
TextFormat	textFormat() Indicates the text format in the report.
String	textFormatAsString() Indicates the text format in the report.
GetPerformanceAnalysisReportRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

overrideConfiguration

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

serviceType

public final ServiceType serviceType()

The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS.

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:

The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS.

See Also:

ServiceType

serviceTypeAsString

public final String serviceTypeAsString()

The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS.

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:

The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS.

See Also:

ServiceType

identifier

public final String identifier()

An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is returned as DbiResourceId.

To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

Returns:

An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is returned as DbiResourceId.

To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

analysisReportId

public final String analysisReportId()

A unique identifier of the created analysis report. For example, report-12345678901234567

Returns:

A unique identifier of the created analysis report. For example, report-12345678901234567

textFormat

public final TextFormat textFormat()

Indicates the text format in the report. The options are PLAIN_TEXT or MARKDOWN. The default value is plain text.

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

Returns:

Indicates the text format in the report. The options are PLAIN_TEXT or MARKDOWN . The default value is plain text.

See Also:

TextFormat

textFormatAsString

public final String textFormatAsString()

Indicates the text format in the report. The options are PLAIN_TEXT or MARKDOWN. The default value is plain text.

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

Returns:

Indicates the text format in the report. The options are PLAIN_TEXT or MARKDOWN . The default value is plain text.

See Also:

TextFormat

acceptLanguage

public final AcceptLanguage acceptLanguage()

The text language in the report. The default language is EN_US (English).

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

Returns:

The text language in the report. The default language is EN_US (English).

See Also:

AcceptLanguage

acceptLanguageAsString

public final String acceptLanguageAsString()

The text language in the report. The default language is EN_US (English).

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

Returns:

The text language in the report. The default language is EN_US (English).

See Also:

AcceptLanguage

toBuilder

public GetPerformanceAnalysisReportRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetPerformanceAnalysisReportRequest.Builder,GetPerformanceAnalysisReportRequest>

Specified by:

toBuilder in class PiRequest

builder

public static GetPerformanceAnalysisReportRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo