Class DescribeImageUsageReportsRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.ec2.model.Ec2Request
-
- software.amazon.awssdk.services.ec2.model.DescribeImageUsageReportsRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<DescribeImageUsageReportsRequest.Builder,DescribeImageUsageReportsRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeImageUsageReportsRequest extends Ec2Request implements ToCopyableBuilder<DescribeImageUsageReportsRequest.Builder,DescribeImageUsageReportsRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDescribeImageUsageReportsRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DescribeImageUsageReportsRequest.Builderbuilder()BooleandryRun()Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)List<Filter>filters()The filters.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasFilters()For responses, this returns true if the service returned a value for the Filters property.inthashCode()booleanhasImageIds()For responses, this returns true if the service returned a value for the ImageIds property.booleanhasReportIds()For responses, this returns true if the service returned a value for the ReportIds property.List<String>imageIds()The IDs of the images for filtering the reports.IntegermaxResults()The maximum number of items to return for this request.StringnextToken()The token returned from a previous paginated request.List<String>reportIds()The IDs of the image usage reports.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends DescribeImageUsageReportsRequest.Builder>serializableBuilderClass()DescribeImageUsageReportsRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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
-
hasImageIds
public final boolean hasImageIds()
For responses, this returns true if the service returned a value for the ImageIds 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.
-
imageIds
public final List<String> imageIds()
The IDs of the images for filtering the reports. If specified, only reports containing these images are returned.
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
hasImageIds()method.- Returns:
- The IDs of the images for filtering the reports. If specified, only reports containing these images are returned.
-
hasReportIds
public final boolean hasReportIds()
For responses, this returns true if the service returned a value for the ReportIds 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.
-
reportIds
public final List<String> reportIds()
The IDs of the image usage reports.
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
hasReportIds()method.- Returns:
- The IDs of the image usage reports.
-
nextToken
public final String nextToken()
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
- Returns:
- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
-
hasFilters
public final boolean hasFilters()
For responses, this returns true if the service returned a value for the Filters 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.
-
filters
public final List<Filter> filters()
The filters.
-
creation-time- The time when the report was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example,2025-11-29T11:04:43.305Z. You can use a wildcard (*), for example,2025-11-29T*, which matches an entire day. -
state- The state of the report (available|pending|error). -
tag:<key>- The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwnerand the valueTeamA, specifytag:Ownerfor the filter name andTeamAfor the filter value. -
tag-key- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
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
hasFilters()method.- Returns:
- The filters.
-
creation-time- The time when the report was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example,2025-11-29T11:04:43.305Z. You can use a wildcard (*), for example,2025-11-29T*, which matches an entire day. -
state- The state of the report (available|pending|error). -
tag:<key>- The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwnerand the valueTeamA, specifytag:Ownerfor the filter name andTeamAfor the filter value. -
tag-key- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
-
-
-
dryRun
public final Boolean dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation. Otherwise, it isUnauthorizedOperation.- Returns:
- Checks whether you have the required permissions for the action, without actually making the request, and
provides an error response. If you have the required permissions, the error response is
DryRunOperation. Otherwise, it isUnauthorizedOperation.
-
maxResults
public final Integer maxResults()
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
- Returns:
- The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
-
toBuilder
public DescribeImageUsageReportsRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<DescribeImageUsageReportsRequest.Builder,DescribeImageUsageReportsRequest>- Specified by:
toBuilderin classEc2Request
-
builder
public static DescribeImageUsageReportsRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeImageUsageReportsRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-