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>

  • Method Details

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

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

    • 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 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.