software.amazon.awssdk.services.iam.model

Class GetSSHPublicKeyRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iam.model.IAMRequest

software.amazon.awssdk.services.iam.model.GetSSHPublicKeyRequest

All Implemented Interfaces:

ToCopyableBuilder<GetSSHPublicKeyRequest.Builder,GetSSHPublicKeyRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class GetSSHPublicKeyRequest
extends IAMRequest
implements ToCopyableBuilder<GetSSHPublicKeyRequest.Builder,GetSSHPublicKeyRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetSSHPublicKeyRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetSSHPublicKeyRequest.Builder	builder()
EncodingType	encoding() Specifies the public key encoding format to use in the response.
String	encodingAsString() Specifies the public key encoding format to use in the response.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
static Class<? extends GetSSHPublicKeyRequest.Builder>	serializableBuilderClass()
String	sshPublicKeyId() The unique identifier for the SSH public key.
GetSSHPublicKeyRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	userName() The name of the IAM user associated with the SSH public key.

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

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

userName

public String userName()

The name of the IAM user associated with the SSH public key.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

Returns:

The name of the IAM user associated with the SSH public key.

This parameter allows (per its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: =,.@-

sshPublicKeyId

public String sshPublicKeyId()

The unique identifier for the SSH public key.

This parameter allows (per its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

Returns:

The unique identifier for the SSH public key.

This parameter allows (per its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

encoding

public EncodingType encoding()

Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use SSH. To retrieve the public key in PEM format, use PEM.

If the service returns an enum value that is not available in the current SDK version, encoding will return EncodingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encodingAsString().

Returns:

Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use SSH. To retrieve the public key in PEM format, use PEM.

See Also:

EncodingType

encodingAsString

public String encodingAsString()

Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use SSH. To retrieve the public key in PEM format, use PEM.

If the service returns an enum value that is not available in the current SDK version, encoding will return EncodingType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encodingAsString().

Returns:

Specifies the public key encoding format to use in the response. To retrieve the public key in ssh-rsa format, use SSH. To retrieve the public key in PEM format, use PEM.

See Also:

EncodingType

toBuilder

public GetSSHPublicKeyRequest.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<GetSSHPublicKeyRequest.Builder,GetSSHPublicKeyRequest>

Specified by:

toBuilder in class IAMRequest

Returns:

a builder for type T

builder

public static GetSSHPublicKeyRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetSSHPublicKeyRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value