Class GetDeclarativePoliciesReportSummaryResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.ec2.model.Ec2Response
software.amazon.awssdk.services.ec2.model.GetDeclarativePoliciesReportSummaryResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetDeclarativePoliciesReportSummaryResponse.Builder,GetDeclarativePoliciesReportSummaryResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetDeclarativePoliciesReportSummaryResponse extends Ec2Response implements ToCopyableBuilder<GetDeclarativePoliciesReportSummaryResponse.Builder,GetDeclarativePoliciesReportSummaryResponse>

  • Method Details

    • reportId

      public final String reportId()

      The ID of the report.

      Returns:
      The ID of the report.

    • s3Bucket

      public final String s3Bucket()

      The name of the Amazon S3 bucket where the report is located.

      Returns:
      The name of the Amazon S3 bucket where the report is located.

    • s3Prefix

      public final String s3Prefix()

      The prefix for your S3 object.

      Returns:
      The prefix for your S3 object.

    • targetId

      public final String targetId()

      The root ID, organizational unit ID, or account ID.

      Format:

      • For root: r-ab12

      • For OU: ou-ab12-cdef1234

      • For account: 123456789012

      Returns:
      The root ID, organizational unit ID, or account ID.

      Format:

      • For root: r-ab12

      • For OU: ou-ab12-cdef1234

      • For account: 123456789012

    • startTime

      public final Instant startTime()

      The time when the report generation started.

      Returns:
      The time when the report generation started.

    • endTime

      public final Instant endTime()

      The time when the report generation ended.

      Returns:
      The time when the report generation ended.

    • numberOfAccounts

      public final Integer numberOfAccounts()

      The total number of accounts associated with the specified targetId.

      Returns:
      The total number of accounts associated with the specified targetId.

    • numberOfFailedAccounts

      public final Integer numberOfFailedAccounts()

      The number of accounts where attributes could not be retrieved in any Region.

      Returns:
      The number of accounts where attributes could not be retrieved in any Region.

    • hasAttributeSummaries

      public final boolean hasAttributeSummaries()
      For responses, this returns true if the service returned a value for the AttributeSummaries 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.

    • attributeSummaries

      public final List<AttributeSummary> attributeSummaries()

      The attributes described in the 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 hasAttributeSummaries() method.

      Returns:
      The attributes described in the report.

    • toBuilder

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

    • builder

      public static GetDeclarativePoliciesReportSummaryResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetDeclarativePoliciesReportSummaryResponse.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)
      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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.