Class DescribeKeyPairsRequest
- 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.DescribeKeyPairsRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeKeyPairsRequest.Builder,DescribeKeyPairsRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeKeyPairsRequest extends Ec2Request implements ToCopyableBuilder<DescribeKeyPairsRequest.Builder,DescribeKeyPairsRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DescribeKeyPairsRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DescribeKeyPairsRequest.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)
List<Filter>
filters()
The filters.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasFilters()
For responses, this returns true if the service returned a value for the Filters property.int
hashCode()
boolean
hasKeyNames()
For responses, this returns true if the service returned a value for the KeyNames property.boolean
hasKeyPairIds()
For responses, this returns true if the service returned a value for the KeyPairIds property.Boolean
includePublicKey()
Iftrue
, the public key material is included in the response.List<String>
keyNames()
The key pair names.List<String>
keyPairIds()
The IDs of the key pairs.List<SdkField<?>>
sdkFields()
static Class<? extends DescribeKeyPairsRequest.Builder>
serializableBuilderClass()
DescribeKeyPairsRequest.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
-
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.
-
key-pair-id
- The ID of the key pair. -
fingerprint
- The fingerprint of the key pair. -
key-name
- The name of the key pair. -
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. -
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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter 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.
-
key-pair-id
- The ID of the key pair. -
fingerprint
- The fingerprint of the key pair. -
key-name
- The name of the key pair. -
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. -
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 keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter value.
-
-
-
hasKeyNames
public final boolean hasKeyNames()
For responses, this returns true if the service returned a value for the KeyNames 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.
-
keyNames
public final List<String> keyNames()
The key pair names.
Default: Describes all of your key pairs.
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
hasKeyNames()
method.- Returns:
- The key pair names.
Default: Describes all of your key pairs.
-
hasKeyPairIds
public final boolean hasKeyPairIds()
For responses, this returns true if the service returned a value for the KeyPairIds 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.
-
keyPairIds
public final List<String> keyPairIds()
The IDs of the key pairs.
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
hasKeyPairIds()
method.- Returns:
- The IDs of the key pairs.
-
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
.
-
includePublicKey
public final Boolean includePublicKey()
If
true
, the public key material is included in the response.Default:
false
- Returns:
- If
true
, the public key material is included in the response.Default:
false
-
toBuilder
public DescribeKeyPairsRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeKeyPairsRequest.Builder,DescribeKeyPairsRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static DescribeKeyPairsRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeKeyPairsRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in 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:
getValueForField
in classSdkRequest
-
-