software.amazon.awssdk.services.iam.model.SSHPublicKeyMetadata Maven / Gradle / Ivy
/*
* 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, without the key's body or fingerprint.
*
*
* This data type is used as a response element in the ListSSHPublicKeys operation.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class SSHPublicKeyMetadata implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField USER_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(SSHPublicKeyMetadata::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)
.getter(getter(SSHPublicKeyMetadata::sshPublicKeyId)).setter(setter(Builder::sshPublicKeyId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SSHPublicKeyId").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(SSHPublicKeyMetadata::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)
.getter(getter(SSHPublicKeyMetadata::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, STATUS_FIELD, UPLOAD_DATE_FIELD));
private static final long serialVersionUID = 1L;
private final String userName;
private final String sshPublicKeyId;
private final String status;
private final Instant uploadDate;
private SSHPublicKeyMetadata(BuilderImpl builder) {
this.userName = builder.userName;
this.sshPublicKeyId = builder.sshPublicKeyId;
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 String userName() {
return userName;
}
/**
*
* The unique identifier for the SSH public key.
*
*
* @return The unique identifier for the SSH public key.
*/
public String sshPublicKeyId() {
return sshPublicKeyId;
}
/**
*
* The status of the SSH public key. Active means that the key can be used for authentication with an
* AWS 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 AWS CodeCommit repository. Inactive means that the key cannot be used.
* @see StatusType
*/
public 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
* AWS 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 AWS CodeCommit repository. Inactive means that the key cannot be used.
* @see StatusType
*/
public 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 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 int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(userName());
hashCode = 31 * hashCode + Objects.hashCode(sshPublicKeyId());
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
hashCode = 31 * hashCode + Objects.hashCode(uploadDate());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof SSHPublicKeyMetadata)) {
return false;
}
SSHPublicKeyMetadata other = (SSHPublicKeyMetadata) obj;
return Objects.equals(userName(), other.userName()) && Objects.equals(sshPublicKeyId(), other.sshPublicKeyId())
&& 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 String toString() {
return ToString.builder("SSHPublicKeyMetadata").add("UserName", userName()).add("SSHPublicKeyId", sshPublicKeyId())
.add("Status", statusAsString()).add("UploadDate", uploadDate()).build();
}
public 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 "Status":
return Optional.ofNullable(clazz.cast(statusAsString()));
case "UploadDate":
return Optional.ofNullable(clazz.cast(uploadDate()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((SSHPublicKeyMetadata) 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 status of the SSH public key. Active means that the key can be used for authentication with
* an AWS 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 AWS 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 AWS 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 AWS 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 status;
private Instant uploadDate;
private BuilderImpl() {
}
private BuilderImpl(SSHPublicKeyMetadata model) {
userName(model.userName);
sshPublicKeyId(model.sshPublicKeyId);
status(model.status);
uploadDate(model.uploadDate);
}
public final String getUserName() {
return userName;
}
@Override
public final Builder userName(String userName) {
this.userName = userName;
return this;
}
public final void setUserName(String userName) {
this.userName = userName;
}
public final String getSshPublicKeyId() {
return sshPublicKeyId;
}
@Override
public final Builder sshPublicKeyId(String sshPublicKeyId) {
this.sshPublicKeyId = sshPublicKeyId;
return this;
}
public final void setSshPublicKeyId(String sshPublicKeyId) {
this.sshPublicKeyId = sshPublicKeyId;
}
public final String getStatus() {
return 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 void setStatus(String status) {
this.status = status;
}
public final Instant getUploadDate() {
return uploadDate;
}
@Override
public final Builder uploadDate(Instant uploadDate) {
this.uploadDate = uploadDate;
return this;
}
public final void setUploadDate(Instant uploadDate) {
this.uploadDate = uploadDate;
}
@Override
public SSHPublicKeyMetadata build() {
return new SSHPublicKeyMetadata(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy