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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeImageReferencesRequest.Builder,DescribeImageReferencesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeImageReferencesRequest
extends Ec2Request
implements ToCopyableBuilder<DescribeImageReferencesRequest.Builder,DescribeImageReferencesRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DescribeImageReferencesRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DescribeImageReferencesRequest.Builder`	`builder()`
`Boolean`	`dryRun()`	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasImageIds()`	For responses, this returns true if the service returned a value for the ImageIds property.
`boolean`	`hasResourceTypes()`	For responses, this returns true if the service returned a value for the ResourceTypes property.
`List<String>`	`imageIds()`	The IDs of the images to check for resource references.
`Boolean`	`includeAllResourceTypes()`	Specifies whether to check all supported Amazon Web Services resource types for image references.
`Integer`	`maxResults()`	The maximum number of items to return for this request.
`String`	`nextToken()`	The token returned from a previous paginated request.
`List<ResourceTypeRequest>`	`resourceTypes()`	The Amazon Web Services resource types to check for image references.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeImageReferencesRequest.Builder>`	`serializableBuilderClass()`
`DescribeImageReferencesRequest.Builder`	`toBuilder()`
`String`	`toString()`	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 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.
  - imageIds
```
public final List<String> imageIds()
```
    The IDs of the images to check for resource references.
    
    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 to check for resource references.
  - includeAllResourceTypes
```
public final Boolean includeAllResourceTypes()
```
    Specifies whether to check all supported Amazon Web Services resource types for image references. When specified, default values are applied for ResourceTypeOptions. For the default values, see How AMI reference checks work in the Amazon EC2 User Guide. If you also specify ResourceTypes with ResourceTypeOptions, your specified values override the default values.
    
    Supported resource types: ec2:Instance | ec2:LaunchTemplate | ssm:Parameter | imagebuilder:ImageRecipe | imagebuilder:ContainerRecipe
    
    Either IncludeAllResourceTypes or ResourceTypes must be specified.
    
    Returns:
    
    Specifies whether to check all supported Amazon Web Services resource types for image references. When specified, default values are applied for ResourceTypeOptions. For the default values, see How AMI reference checks work in the Amazon EC2 User Guide. If you also specify ResourceTypes with ResourceTypeOptions, your specified values override the default values.
    
    Supported resource types: ec2:Instance | ec2:LaunchTemplate | ssm:Parameter | imagebuilder:ImageRecipe | imagebuilder:ContainerRecipe
    
    Either IncludeAllResourceTypes or ResourceTypes must be specified.
  - 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<ResourceTypeRequest> resourceTypes()
```
    The Amazon Web Services resource types to check for image references.
    
    Either IncludeAllResourceTypes or ResourceTypes must be specified.
    
    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 Amazon Web Services resource types to check for image references.
    
    Either IncludeAllResourceTypes or ResourceTypes must be specified.
  - 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.
  - 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 is UnauthorizedOperation.
    
    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 is UnauthorizedOperation.
  - 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 DescribeImageReferencesRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeImageReferencesRequest.Builder,DescribeImageReferencesRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static DescribeImageReferencesRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeImageReferencesRequest.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class DescribeImageReferencesRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasImageIds

imageIds

includeAllResourceTypes

hasResourceTypes

resourceTypes

nextToken

dryRun

maxResults

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField