software.amazon.awssdk.services.iam.model.ChangePasswordRequest Maven / Gradle / Ivy
Show all versions of iam Show documentation
/*
* 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.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.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class ChangePasswordRequest extends IamRequest implements
ToCopyableBuilder {
private static final SdkField OLD_PASSWORD_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("OldPassword").getter(getter(ChangePasswordRequest::oldPassword)).setter(setter(Builder::oldPassword))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OldPassword").build()).build();
private static final SdkField NEW_PASSWORD_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NewPassword").getter(getter(ChangePasswordRequest::newPassword)).setter(setter(Builder::newPassword))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NewPassword").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(OLD_PASSWORD_FIELD,
NEW_PASSWORD_FIELD));
private final String oldPassword;
private final String newPassword;
private ChangePasswordRequest(BuilderImpl builder) {
super(builder);
this.oldPassword = builder.oldPassword;
this.newPassword = builder.newPassword;
}
/**
*
* The IAM user's current password.
*
*
* @return The IAM user's current password.
*/
public final String oldPassword() {
return oldPassword;
}
/**
*
* The new password. The new password must conform to the Amazon Web Services account's password policy, if one
* exists.
*
*
* The regex pattern that is used to validate this parameter is a
* string of characters. That string can include almost any printable ASCII character from the space (\u0020
* ) through the end of the ASCII character range (\u00FF). You can also include the tab (
* \u0009), line feed (\u000A), and carriage return (\u000D) characters. Any
* of these characters are valid in a password. However, many tools, such as the Amazon Web Services Management
* Console, might restrict the ability to type certain characters because they have special meaning within that
* tool.
*
*
* @return The new password. The new password must conform to the Amazon Web Services account's password policy, if
* one exists.
*
* The regex pattern that is used to validate this parameter
* is a string of characters. That string can include almost any printable ASCII character from the space (
* \u0020) through the end of the ASCII character range (\u00FF). You can also
* include the tab (\u0009), line feed (\u000A), and carriage return (\u000D
* ) characters. Any of these characters are valid in a password. However, many tools, such as the Amazon
* Web Services Management Console, might restrict the ability to type certain characters because they have
* special meaning within that tool.
*/
public final String newPassword() {
return newPassword;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(oldPassword());
hashCode = 31 * hashCode + Objects.hashCode(newPassword());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ChangePasswordRequest)) {
return false;
}
ChangePasswordRequest other = (ChangePasswordRequest) obj;
return Objects.equals(oldPassword(), other.oldPassword()) && Objects.equals(newPassword(), other.newPassword());
}
/**
* 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("ChangePasswordRequest")
.add("OldPassword", oldPassword() == null ? null : "*** Sensitive Data Redacted ***")
.add("NewPassword", newPassword() == null ? null : "*** Sensitive Data Redacted ***").build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "OldPassword":
return Optional.ofNullable(clazz.cast(oldPassword()));
case "NewPassword":
return Optional.ofNullable(clazz.cast(newPassword()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ChangePasswordRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends IamRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The IAM user's current password.
*
*
* @param oldPassword
* The IAM user's current password.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder oldPassword(String oldPassword);
/**
*
* The new password. The new password must conform to the Amazon Web Services account's password policy, if one
* exists.
*
*
* The regex pattern that is used to validate this parameter is a
* string of characters. That string can include almost any printable ASCII character from the space (
* \u0020) through the end of the ASCII character range (\u00FF). You can also include
* the tab (\u0009), line feed (\u000A), and carriage return (\u000D)
* characters. Any of these characters are valid in a password. However, many tools, such as the Amazon Web
* Services Management Console, might restrict the ability to type certain characters because they have special
* meaning within that tool.
*
*
* @param newPassword
* The new password. The new password must conform to the Amazon Web Services account's password policy,
* if one exists.
*
* The regex pattern that is used to validate this
* parameter is a string of characters. That string can include almost any printable ASCII character from
* the space (\u0020) through the end of the ASCII character range (\u00FF).
* You can also include the tab (\u0009), line feed (\u000A), and carriage
* return (\u000D) characters. Any of these characters are valid in a password. However,
* many tools, such as the Amazon Web Services Management Console, might restrict the ability to type
* certain characters because they have special meaning within that tool.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder newPassword(String newPassword);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends IamRequest.BuilderImpl implements Builder {
private String oldPassword;
private String newPassword;
private BuilderImpl() {
}
private BuilderImpl(ChangePasswordRequest model) {
super(model);
oldPassword(model.oldPassword);
newPassword(model.newPassword);
}
public final String getOldPassword() {
return oldPassword;
}
public final void setOldPassword(String oldPassword) {
this.oldPassword = oldPassword;
}
@Override
public final Builder oldPassword(String oldPassword) {
this.oldPassword = oldPassword;
return this;
}
public final String getNewPassword() {
return newPassword;
}
public final void setNewPassword(String newPassword) {
this.newPassword = newPassword;
}
@Override
public final Builder newPassword(String newPassword) {
this.newPassword = newPassword;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public ChangePasswordRequest build() {
return new ChangePasswordRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}