Package 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:

SdkPojo, ToCopyableBuilder<GetSshPublicKeyRequest.Builder,GetSshPublicKeyRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetSshPublicKeyRequest.Builder

Method Summary

Modifier and Type	Method	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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends GetSshPublicKeyRequest.Builder>	serializableBuilderClass()
String	sshPublicKeyId()	The unique identifier for the SSH public key.
GetSshPublicKeyRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userName()	The name of the IAM user associated with the SSH public key.

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

userName

public final String userName()

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

This parameter allows (through 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 (through 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 final String sshPublicKeyId()

The unique identifier for the SSH public key.

This parameter allows (through 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 (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

encoding

public final 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 final 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()

Specified by:

toBuilder in interface ToCopyableBuilder<GetSshPublicKeyRequest.Builder,GetSshPublicKeyRequest>

Specified by:

toBuilder in class IamRequest

builder

public static GetSshPublicKeyRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetSshPublicKeyRequest.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