software.amazon.awssdk.services.iam.model.ServiceSpecificCredential 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.HashMap;
import java.util.List;
import java.util.Map;
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 the details of a service-specific credential.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ServiceSpecificCredential implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField CREATE_DATE_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("CreateDate").getter(getter(ServiceSpecificCredential::createDate)).setter(setter(Builder::createDate))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CreateDate").build()).build();
private static final SdkField SERVICE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ServiceName").getter(getter(ServiceSpecificCredential::serviceName))
.setter(setter(Builder::serviceName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ServiceName").build()).build();
private static final SdkField SERVICE_USER_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ServiceUserName").getter(getter(ServiceSpecificCredential::serviceUserName))
.setter(setter(Builder::serviceUserName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ServiceUserName").build()).build();
private static final SdkField SERVICE_PASSWORD_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ServicePassword").getter(getter(ServiceSpecificCredential::servicePassword))
.setter(setter(Builder::servicePassword))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ServicePassword").build()).build();
private static final SdkField SERVICE_SPECIFIC_CREDENTIAL_ID_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ServiceSpecificCredentialId")
.getter(getter(ServiceSpecificCredential::serviceSpecificCredentialId))
.setter(setter(Builder::serviceSpecificCredentialId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ServiceSpecificCredentialId")
.build()).build();
private static final SdkField USER_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("UserName").getter(getter(ServiceSpecificCredential::userName)).setter(setter(Builder::userName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UserName").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Status")
.getter(getter(ServiceSpecificCredential::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Status").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CREATE_DATE_FIELD,
SERVICE_NAME_FIELD, SERVICE_USER_NAME_FIELD, SERVICE_PASSWORD_FIELD, SERVICE_SPECIFIC_CREDENTIAL_ID_FIELD,
USER_NAME_FIELD, STATUS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private static final long serialVersionUID = 1L;
private final Instant createDate;
private final String serviceName;
private final String serviceUserName;
private final String servicePassword;
private final String serviceSpecificCredentialId;
private final String userName;
private final String status;
private ServiceSpecificCredential(BuilderImpl builder) {
this.createDate = builder.createDate;
this.serviceName = builder.serviceName;
this.serviceUserName = builder.serviceUserName;
this.servicePassword = builder.servicePassword;
this.serviceSpecificCredentialId = builder.serviceSpecificCredentialId;
this.userName = builder.userName;
this.status = builder.status;
}
/**
*
* The date and time, in ISO 8601 date-time format, when the
* service-specific credential were created.
*
*
* @return The date and time, in ISO 8601 date-time format, when the
* service-specific credential were created.
*/
public final Instant createDate() {
return createDate;
}
/**
*
* The name of the service associated with the service-specific credential.
*
*
* @return The name of the service associated with the service-specific credential.
*/
public final String serviceName() {
return serviceName;
}
/**
*
* The generated user name for the service-specific credential. This value is generated by combining the IAM user's
* name combined with the ID number of the Amazon Web Services account, as in jane-at-123456789012, for
* example. This value cannot be configured by the user.
*
*
* @return The generated user name for the service-specific credential. This value is generated by combining the IAM
* user's name combined with the ID number of the Amazon Web Services account, as in
* jane-at-123456789012, for example. This value cannot be configured by the user.
*/
public final String serviceUserName() {
return serviceUserName;
}
/**
*
* The generated password for the service-specific credential.
*
*
* @return The generated password for the service-specific credential.
*/
public final String servicePassword() {
return servicePassword;
}
/**
*
* The unique identifier for the service-specific credential.
*
*
* @return The unique identifier for the service-specific credential.
*/
public final String serviceSpecificCredentialId() {
return serviceSpecificCredentialId;
}
/**
*
* The name of the IAM user associated with the service-specific credential.
*
*
* @return The name of the IAM user associated with the service-specific credential.
*/
public final String userName() {
return userName;
}
/**
*
* The status of the service-specific credential. Active means that the key is valid for API calls,
* while Inactive means it is not.
*
*
* 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 service-specific credential. Active means that the key is valid for API
* calls, while Inactive means it is not.
* @see StatusType
*/
public final StatusType status() {
return StatusType.fromValue(status);
}
/**
*
* The status of the service-specific credential. Active means that the key is valid for API calls,
* while Inactive means it is not.
*
*
* 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 service-specific credential. Active means that the key is valid for API
* calls, while Inactive means it is not.
* @see StatusType
*/
public final String statusAsString() {
return status;
}
@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(createDate());
hashCode = 31 * hashCode + Objects.hashCode(serviceName());
hashCode = 31 * hashCode + Objects.hashCode(serviceUserName());
hashCode = 31 * hashCode + Objects.hashCode(servicePassword());
hashCode = 31 * hashCode + Objects.hashCode(serviceSpecificCredentialId());
hashCode = 31 * hashCode + Objects.hashCode(userName());
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
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 ServiceSpecificCredential)) {
return false;
}
ServiceSpecificCredential other = (ServiceSpecificCredential) obj;
return Objects.equals(createDate(), other.createDate()) && Objects.equals(serviceName(), other.serviceName())
&& Objects.equals(serviceUserName(), other.serviceUserName())
&& Objects.equals(servicePassword(), other.servicePassword())
&& Objects.equals(serviceSpecificCredentialId(), other.serviceSpecificCredentialId())
&& Objects.equals(userName(), other.userName()) && Objects.equals(statusAsString(), other.statusAsString());
}
/**
* 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("ServiceSpecificCredential").add("CreateDate", createDate()).add("ServiceName", serviceName())
.add("ServiceUserName", serviceUserName())
.add("ServicePassword", servicePassword() == null ? null : "*** Sensitive Data Redacted ***")
.add("ServiceSpecificCredentialId", serviceSpecificCredentialId()).add("UserName", userName())
.add("Status", statusAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "CreateDate":
return Optional.ofNullable(clazz.cast(createDate()));
case "ServiceName":
return Optional.ofNullable(clazz.cast(serviceName()));
case "ServiceUserName":
return Optional.ofNullable(clazz.cast(serviceUserName()));
case "ServicePassword":
return Optional.ofNullable(clazz.cast(servicePassword()));
case "ServiceSpecificCredentialId":
return Optional.ofNullable(clazz.cast(serviceSpecificCredentialId()));
case "UserName":
return Optional.ofNullable(clazz.cast(userName()));
case "Status":
return Optional.ofNullable(clazz.cast(statusAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("CreateDate", CREATE_DATE_FIELD);
map.put("ServiceName", SERVICE_NAME_FIELD);
map.put("ServiceUserName", SERVICE_USER_NAME_FIELD);
map.put("ServicePassword", SERVICE_PASSWORD_FIELD);
map.put("ServiceSpecificCredentialId", SERVICE_SPECIFIC_CREDENTIAL_ID_FIELD);
map.put("UserName", USER_NAME_FIELD);
map.put("Status", STATUS_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((ServiceSpecificCredential) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The date and time, in ISO 8601 date-time format, when the
* service-specific credential were created.
*
*
* @param createDate
* The date and time, in ISO 8601 date-time format, when the
* service-specific credential were created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder createDate(Instant createDate);
/**
*
* The name of the service associated with the service-specific credential.
*
*
* @param serviceName
* The name of the service associated with the service-specific credential.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder serviceName(String serviceName);
/**
*
* The generated user name for the service-specific credential. This value is generated by combining the IAM
* user's name combined with the ID number of the Amazon Web Services account, as in
* jane-at-123456789012, for example. This value cannot be configured by the user.
*
*
* @param serviceUserName
* The generated user name for the service-specific credential. This value is generated by combining the
* IAM user's name combined with the ID number of the Amazon Web Services account, as in
* jane-at-123456789012, for example. This value cannot be configured by the user.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder serviceUserName(String serviceUserName);
/**
*
* The generated password for the service-specific credential.
*
*
* @param servicePassword
* The generated password for the service-specific credential.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder servicePassword(String servicePassword);
/**
*
* The unique identifier for the service-specific credential.
*
*
* @param serviceSpecificCredentialId
* The unique identifier for the service-specific credential.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder serviceSpecificCredentialId(String serviceSpecificCredentialId);
/**
*
* The name of the IAM user associated with the service-specific credential.
*
*
* @param userName
* The name of the IAM user associated with the service-specific credential.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder userName(String userName);
/**
*
* The status of the service-specific credential. Active means that the key is valid for API calls,
* while Inactive means it is not.
*
*
* @param status
* The status of the service-specific credential. Active means that the key is valid for API
* calls, while Inactive means it is not.
* @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 service-specific credential. Active means that the key is valid for API calls,
* while Inactive means it is not.
*
*
* @param status
* The status of the service-specific credential. Active means that the key is valid for API
* calls, while Inactive means it is not.
* @see StatusType
* @return Returns a reference to this object so that method calls can be chained together.
* @see StatusType
*/
Builder status(StatusType status);
}
static final class BuilderImpl implements Builder {
private Instant createDate;
private String serviceName;
private String serviceUserName;
private String servicePassword;
private String serviceSpecificCredentialId;
private String userName;
private String status;
private BuilderImpl() {
}
private BuilderImpl(ServiceSpecificCredential model) {
createDate(model.createDate);
serviceName(model.serviceName);
serviceUserName(model.serviceUserName);
servicePassword(model.servicePassword);
serviceSpecificCredentialId(model.serviceSpecificCredentialId);
userName(model.userName);
status(model.status);
}
public final Instant getCreateDate() {
return createDate;
}
public final void setCreateDate(Instant createDate) {
this.createDate = createDate;
}
@Override
public final Builder createDate(Instant createDate) {
this.createDate = createDate;
return this;
}
public final String getServiceName() {
return serviceName;
}
public final void setServiceName(String serviceName) {
this.serviceName = serviceName;
}
@Override
public final Builder serviceName(String serviceName) {
this.serviceName = serviceName;
return this;
}
public final String getServiceUserName() {
return serviceUserName;
}
public final void setServiceUserName(String serviceUserName) {
this.serviceUserName = serviceUserName;
}
@Override
public final Builder serviceUserName(String serviceUserName) {
this.serviceUserName = serviceUserName;
return this;
}
public final String getServicePassword() {
return servicePassword;
}
public final void setServicePassword(String servicePassword) {
this.servicePassword = servicePassword;
}
@Override
public final Builder servicePassword(String servicePassword) {
this.servicePassword = servicePassword;
return this;
}
public final String getServiceSpecificCredentialId() {
return serviceSpecificCredentialId;
}
public final void setServiceSpecificCredentialId(String serviceSpecificCredentialId) {
this.serviceSpecificCredentialId = serviceSpecificCredentialId;
}
@Override
public final Builder serviceSpecificCredentialId(String serviceSpecificCredentialId) {
this.serviceSpecificCredentialId = serviceSpecificCredentialId;
return this;
}
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 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;
}
@Override
public ServiceSpecificCredential build() {
return new ServiceSpecificCredential(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy