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("software.amazon.awssdk:codegen") public final class GetPerformanceAnalysisReportRequest extends PiRequest implements ToCopyableBuilder<GetPerformanceAnalysisReportRequest.Builder,GetPerformanceAnalysisReportRequest>

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • toBuilder

      public GetPerformanceAnalysisReportRequest.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<GetPerformanceAnalysisReportRequest.Builder,GetPerformanceAnalysisReportRequest>
      Specified by:
      toBuilder in class PiRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      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 final 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.