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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceImageUsageReport.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<String>accountIds()The IDs of the Amazon Web Services accounts that were specified when the report was created.static ImageUsageReport.Builderbuilder()InstantcreationTime()The date and time when the report was created.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)InstantexpirationTime()The date and time when Amazon EC2 will delete the report (30 days after the report was created).<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAccountIds()For responses, this returns true if the service returned a value for the AccountIds property.inthashCode()booleanhasResourceTypes()For responses, this returns true if the service returned a value for the ResourceTypes property.booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.StringimageId()The ID of the image that was specified when the report was created.StringreportId()The ID of the report.List<ImageUsageResourceType>resourceTypes()The resource types that were specified when the report was created.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends ImageUsageReport.Builder>serializableBuilderClass()Stringstate()The current state of the report.StringstateReason()Provides additional details when the report is in anerrorstate.List<Tag>tags()Any tags assigned to the report.ImageUsageReport.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
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
-
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 theisEmpty()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 theisEmpty()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
errorstate.- Returns:
- Provides additional details when the report is in an
errorstate.
-
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 theisEmpty()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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ImageUsageReport.Builder,ImageUsageReport>
-
builder
public static ImageUsageReport.Builder builder()
-
serializableBuilderClass
public static Class<? extends ImageUsageReport.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-