Class ImageUsageReport

java.lang.Object
software.amazon.awssdk.services.ec2.model.ImageUsageReport
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ImageUsageReport.Builder,ImageUsageReport>
@Generated("software.amazon.awssdk:codegen") public final class ImageUsageReport extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ImageUsageReport.Builder,ImageUsageReport>

The configuration and status of an image usage report.

See Also:

  • Method Details

    • imageId

      public final String imageId()

      The ID of the image that was specified when the report was created.

      Returns:
      The ID of the image that was specified when the report was created.

    • reportId

      public final String reportId()

      The ID of the report.

      Returns:
      The ID of the report.

    • hasResourceTypes

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

    • resourceTypes

      public final List<ImageUsageResourceType> resourceTypes()

      The resource types that were specified when the report was created.

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

      Returns:
      The resource types that were specified when the report was created.

    • hasAccountIds

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

    • accountIds

      public final List<String> accountIds()

      The IDs of the Amazon Web Services accounts that were specified when the report was created.

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

      Returns:
      The IDs of the Amazon Web Services accounts that were specified when the report was created.

    • state

      public final String state()

      The current state of the report. Possible values:

      • available - The report is available to view.

      • pending - The report is being created and not available to view.

      • error - The report could not be created.

      Returns:
      The current state of the report. Possible values:

      • available - The report is available to view.

      • pending - The report is being created and not available to view.

      • error - The report could not be created.

    • stateReason

      public final String stateReason()

      Provides additional details when the report is in an error state.

      Returns:
      Provides additional details when the report is in an error state.

    • creationTime

      public final Instant creationTime()

      The date and time when the report was created.

      Returns:
      The date and time when the report was created.

    • expirationTime

      public final Instant expirationTime()

      The date and time when Amazon EC2 will delete the report (30 days after the report was created).

      Returns:
      The date and time when Amazon EC2 will delete the report (30 days after the report was created).

    • hasTags

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

    • tags

      public final List<Tag> tags()

      Any tags assigned to 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 hasTags() method.

      Returns:
      Any tags assigned to the report.

    • toBuilder

      public ImageUsageReport.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<ImageUsageReport.Builder,ImageUsageReport>
      Returns:
      a builder for type T

    • builder

      public static ImageUsageReport.Builder builder()

    • serializableBuilderClass

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

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