Class GetConsolidatedReportRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.wellarchitected.model.WellArchitectedRequest
software.amazon.awssdk.services.wellarchitected.model.GetConsolidatedReportRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetConsolidatedReportRequest.Builder,GetConsolidatedReportRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetConsolidatedReportRequest extends WellArchitectedRequest implements ToCopyableBuilder<GetConsolidatedReportRequest.Builder,GetConsolidatedReportRequest>

  • Method Details

    • format

      public final ReportFormat format()

      The format of the consolidated report.

      For PDF, Base64String is returned. For JSON, Metrics is returned.

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

      Returns:
      The format of the consolidated report.

      For PDF, Base64String is returned. For JSON, Metrics is returned.

      See Also:

    • formatAsString

      public final String formatAsString()

      The format of the consolidated report.

      For PDF, Base64String is returned. For JSON, Metrics is returned.

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

      Returns:
      The format of the consolidated report.

      For PDF, Base64String is returned. For JSON, Metrics is returned.

      See Also:

    • includeSharedResources

      public final Boolean includeSharedResources()

      Set to true to have shared resources included in the report.

      Returns:
      Set to true to have shared resources included in the report.

    • nextToken

      public final String nextToken()
      Returns the value of the NextToken property for this object.
      Returns:
      The value of the NextToken property for this object.

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return for this request.

      Returns:
      The maximum number of results to return for this request.

    • toBuilder

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

    • builder

      public static GetConsolidatedReportRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetConsolidatedReportRequest.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.