software.amazon.awssdk.services.iam.model.SSHPublicKey Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of iam Show documentation
Show all versions of iam Show documentation
The AWS Java SDK for AWS IAM module holds the client classes that are used for communicating with AWS
Identity and Access Management Service
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.iam.model;
import java.io.Serializable;
import java.time.Instant;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Contains information about an SSH public key.
*
*
* This data type is used as a response element in the GetSSHPublicKey and UploadSSHPublicKey operations.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class SSHPublicKey implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField USER_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("UserName").getter(getter(SSHPublicKey::userName)).setter(setter(Builder::userName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UserName").build()).build();
private static final SdkField SSH_PUBLIC_KEY_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SSHPublicKeyId").getter(getter(SSHPublicKey::sshPublicKeyId)).setter(setter(Builder::sshPublicKeyId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SSHPublicKeyId").build()).build();
private static final SdkField FINGERPRINT_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Fingerprint").getter(getter(SSHPublicKey::fingerprint)).setter(setter(Builder::fingerprint))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Fingerprint").build()).build();
private static final SdkField SSH_PUBLIC_KEY_BODY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SSHPublicKeyBody").getter(getter(SSHPublicKey::sshPublicKeyBody))
.setter(setter(Builder::sshPublicKeyBody))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SSHPublicKeyBody").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Status")
.getter(getter(SSHPublicKey::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Status").build()).build();
private static final SdkField UPLOAD_DATE_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("UploadDate").getter(getter(SSHPublicKey::uploadDate)).setter(setter(Builder::uploadDate))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UploadDate").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(USER_NAME_FIELD,
SSH_PUBLIC_KEY_ID_FIELD, FINGERPRINT_FIELD, SSH_PUBLIC_KEY_BODY_FIELD, STATUS_FIELD, UPLOAD_DATE_FIELD));
private static final long serialVersionUID = 1L;
private final String userName;
private final String sshPublicKeyId;
private final String fingerprint;
private final String sshPublicKeyBody;
private final String status;
private final Instant uploadDate;
private SSHPublicKey(BuilderImpl builder) {
this.userName = builder.userName;
this.sshPublicKeyId = builder.sshPublicKeyId;
this.fingerprint = builder.fingerprint;
this.sshPublicKeyBody = builder.sshPublicKeyBody;
this.status = builder.status;
this.uploadDate = builder.uploadDate;
}
/**
*
* The name of the IAM user associated with the SSH public key.
*
*
* @return The name of the IAM user associated with the SSH public key.
*/
public final String userName() {
return userName;
}
/**
*
* The unique identifier for the SSH public key.
*
*
* @return The unique identifier for the SSH public key.
*/
public final String sshPublicKeyId() {
return sshPublicKeyId;
}
/**
*
* The MD5 message digest of the SSH public key.
*
*
* @return The MD5 message digest of the SSH public key.
*/
public final String fingerprint() {
return fingerprint;
}
/**
*
* The SSH public key.
*
*
* @return The SSH public key.
*/
public final String sshPublicKeyBody() {
return sshPublicKeyBody;
}
/**
*
* The status of the SSH public key. Active means that the key can be used for authentication with an
* CodeCommit repository. Inactive means that the key cannot be used.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link StatusType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return The status of the SSH public key. Active means that the key can be used for authentication
* with an CodeCommit repository. Inactive means that the key cannot be used.
* @see StatusType
*/
public final StatusType status() {
return StatusType.fromValue(status);
}
/**
*
* The status of the SSH public key. Active means that the key can be used for authentication with an
* CodeCommit repository. Inactive means that the key cannot be used.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link StatusType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return The status of the SSH public key. Active means that the key can be used for authentication
* with an CodeCommit repository. Inactive means that the key cannot be used.
* @see StatusType
*/
public final String statusAsString() {
return status;
}
/**
*
* The date and time, in ISO 8601 date-time format, when the SSH public
* key was uploaded.
*
*
* @return The date and time, in ISO 8601 date-time format, when the
* SSH public key was uploaded.
*/
public final Instant uploadDate() {
return uploadDate;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(userName());
hashCode = 31 * hashCode + Objects.hashCode(sshPublicKeyId());
hashCode = 31 * hashCode + Objects.hashCode(fingerprint());
hashCode = 31 * hashCode + Objects.hashCode(sshPublicKeyBody());
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
hashCode = 31 * hashCode + Objects.hashCode(uploadDate());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof SSHPublicKey)) {
return false;
}
SSHPublicKey other = (SSHPublicKey) obj;
return Objects.equals(userName(), other.userName()) && Objects.equals(sshPublicKeyId(), other.sshPublicKeyId())
&& Objects.equals(fingerprint(), other.fingerprint())
&& Objects.equals(sshPublicKeyBody(), other.sshPublicKeyBody())
&& Objects.equals(statusAsString(), other.statusAsString()) && Objects.equals(uploadDate(), other.uploadDate());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("SSHPublicKey").add("UserName", userName()).add("SSHPublicKeyId", sshPublicKeyId())
.add("Fingerprint", fingerprint()).add("SSHPublicKeyBody", sshPublicKeyBody()).add("Status", statusAsString())
.add("UploadDate", uploadDate()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "UserName":
return Optional.ofNullable(clazz.cast(userName()));
case "SSHPublicKeyId":
return Optional.ofNullable(clazz.cast(sshPublicKeyId()));
case "Fingerprint":
return Optional.ofNullable(clazz.cast(fingerprint()));
case "SSHPublicKeyBody":
return Optional.ofNullable(clazz.cast(sshPublicKeyBody()));
case "Status":
return Optional.ofNullable(clazz.cast(statusAsString()));
case "UploadDate":
return Optional.ofNullable(clazz.cast(uploadDate()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((SSHPublicKey) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The name of the IAM user associated with the SSH public key.
*
*
* @param userName
* The name of the IAM user associated with the SSH public key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder userName(String userName);
/**
*
* The unique identifier for the SSH public key.
*
*
* @param sshPublicKeyId
* The unique identifier for the SSH public key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sshPublicKeyId(String sshPublicKeyId);
/**
*
* The MD5 message digest of the SSH public key.
*
*
* @param fingerprint
* The MD5 message digest of the SSH public key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder fingerprint(String fingerprint);
/**
*
* The SSH public key.
*
*
* @param sshPublicKeyBody
* The SSH public key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sshPublicKeyBody(String sshPublicKeyBody);
/**
*
* The status of the SSH public key. Active means that the key can be used for authentication with
* an CodeCommit repository. Inactive means that the key cannot be used.
*
*
* @param status
* The status of the SSH public key. Active means that the key can be used for
* authentication with an CodeCommit repository. Inactive means that the key cannot be used.
* @see StatusType
* @return Returns a reference to this object so that method calls can be chained together.
* @see StatusType
*/
Builder status(String status);
/**
*
* The status of the SSH public key. Active means that the key can be used for authentication with
* an CodeCommit repository. Inactive means that the key cannot be used.
*
*
* @param status
* The status of the SSH public key. Active means that the key can be used for
* authentication with an CodeCommit repository. Inactive means that the key cannot be used.
* @see StatusType
* @return Returns a reference to this object so that method calls can be chained together.
* @see StatusType
*/
Builder status(StatusType status);
/**
*
* The date and time, in ISO 8601 date-time format, when the SSH
* public key was uploaded.
*
*
* @param uploadDate
* The date and time, in ISO 8601 date-time format, when the
* SSH public key was uploaded.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder uploadDate(Instant uploadDate);
}
static final class BuilderImpl implements Builder {
private String userName;
private String sshPublicKeyId;
private String fingerprint;
private String sshPublicKeyBody;
private String status;
private Instant uploadDate;
private BuilderImpl() {
}
private BuilderImpl(SSHPublicKey model) {
userName(model.userName);
sshPublicKeyId(model.sshPublicKeyId);
fingerprint(model.fingerprint);
sshPublicKeyBody(model.sshPublicKeyBody);
status(model.status);
uploadDate(model.uploadDate);
}
public final String getUserName() {
return userName;
}
public final void setUserName(String userName) {
this.userName = userName;
}
@Override
public final Builder userName(String userName) {
this.userName = userName;
return this;
}
public final String getSshPublicKeyId() {
return sshPublicKeyId;
}
public final void setSshPublicKeyId(String sshPublicKeyId) {
this.sshPublicKeyId = sshPublicKeyId;
}
@Override
public final Builder sshPublicKeyId(String sshPublicKeyId) {
this.sshPublicKeyId = sshPublicKeyId;
return this;
}
public final String getFingerprint() {
return fingerprint;
}
public final void setFingerprint(String fingerprint) {
this.fingerprint = fingerprint;
}
@Override
public final Builder fingerprint(String fingerprint) {
this.fingerprint = fingerprint;
return this;
}
public final String getSshPublicKeyBody() {
return sshPublicKeyBody;
}
public final void setSshPublicKeyBody(String sshPublicKeyBody) {
this.sshPublicKeyBody = sshPublicKeyBody;
}
@Override
public final Builder sshPublicKeyBody(String sshPublicKeyBody) {
this.sshPublicKeyBody = sshPublicKeyBody;
return this;
}
public final String getStatus() {
return status;
}
public final void setStatus(String status) {
this.status = status;
}
@Override
public final Builder status(String status) {
this.status = status;
return this;
}
@Override
public final Builder status(StatusType status) {
this.status(status == null ? null : status.toString());
return this;
}
public final Instant getUploadDate() {
return uploadDate;
}
public final void setUploadDate(Instant uploadDate) {
this.uploadDate = uploadDate;
}
@Override
public final Builder uploadDate(Instant uploadDate) {
this.uploadDate = uploadDate;
return this;
}
@Override
public SSHPublicKey build() {
return new SSHPublicKey(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy