software.amazon.awssdk.services.iam.model.CreateVirtualMfaDeviceRequest Maven / Gradle / Ivy
Show all versions of iam Show documentation
/*
* Copyright 2014-2019 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 CreateVirtualMfaDeviceRequest extends IamRequest implements
ToCopyableBuilder {
private static final SdkField PATH_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(CreateVirtualMfaDeviceRequest::path)).setter(setter(Builder::path))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Path").build()).build();
private static final SdkField VIRTUAL_MFA_DEVICE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(CreateVirtualMfaDeviceRequest::virtualMFADeviceName)).setter(setter(Builder::virtualMFADeviceName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("VirtualMFADeviceName").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(PATH_FIELD,
VIRTUAL_MFA_DEVICE_NAME_FIELD));
private final String path;
private final String virtualMFADeviceName;
private CreateVirtualMfaDeviceRequest(BuilderImpl builder) {
super(builder);
this.path = builder.path;
this.virtualMFADeviceName = builder.virtualMFADeviceName;
}
/**
*
* The path for the virtual MFA device. For more information about paths, see IAM Identifiers in the IAM
* User Guide.
*
*
* This parameter is optional. If it is not included, it defaults to a slash (/).
*
*
* This parameter allows (through its regex pattern) a string of
* characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward
* slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F),
* including most punctuation characters, digits, and upper and lowercased letters.
*
*
* @return The path for the virtual MFA device. For more information about paths, see IAM Identifiers in the
* IAM User Guide.
*
* This parameter is optional. If it is not included, it defaults to a slash (/).
*
*
* This parameter allows (through its regex pattern) a string
* of characters consisting of either a forward slash (/) by itself or a string that must begin and end with
* forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL
* character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
*/
public String path() {
return path;
}
/**
*
* The name of the virtual MFA device. Use with path to uniquely identify a virtual MFA device.
*
*
* 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: _+=,.@-
*
*
* @return The name of the virtual MFA device. Use with path to uniquely identify a virtual MFA device.
*
* 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: _+=,.@-
*/
public String virtualMFADeviceName() {
return virtualMFADeviceName;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(path());
hashCode = 31 * hashCode + Objects.hashCode(virtualMFADeviceName());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreateVirtualMfaDeviceRequest)) {
return false;
}
CreateVirtualMfaDeviceRequest other = (CreateVirtualMfaDeviceRequest) obj;
return Objects.equals(path(), other.path()) && Objects.equals(virtualMFADeviceName(), other.virtualMFADeviceName());
}
/**
* 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("CreateVirtualMfaDeviceRequest").add("Path", path())
.add("VirtualMFADeviceName", virtualMFADeviceName()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Path":
return Optional.ofNullable(clazz.cast(path()));
case "VirtualMFADeviceName":
return Optional.ofNullable(clazz.cast(virtualMFADeviceName()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function
*
* This parameter is optional. If it is not included, it defaults to a slash (/).
*
*
* This parameter allows (through its regex pattern) a
* string of characters consisting of either a forward slash (/) by itself or a string that must begin
* and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021)
* through the DEL character (\u007F), including most punctuation characters, digits, and upper and
* lowercased letters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder path(String path);
/**
*
* The name of the virtual MFA device. Use with path to uniquely identify a virtual MFA device.
*
*
* 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: _+=,.@-
*
*
* @param virtualMFADeviceName
* The name of the virtual MFA device. Use with path to uniquely identify a virtual MFA device.
*
* 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: _+=,.@-
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder virtualMFADeviceName(String virtualMFADeviceName);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends IamRequest.BuilderImpl implements Builder {
private String path;
private String virtualMFADeviceName;
private BuilderImpl() {
}
private BuilderImpl(CreateVirtualMfaDeviceRequest model) {
super(model);
path(model.path);
virtualMFADeviceName(model.virtualMFADeviceName);
}
public final String getPath() {
return path;
}
@Override
public final Builder path(String path) {
this.path = path;
return this;
}
public final void setPath(String path) {
this.path = path;
}
public final String getVirtualMFADeviceName() {
return virtualMFADeviceName;
}
@Override
public final Builder virtualMFADeviceName(String virtualMFADeviceName) {
this.virtualMFADeviceName = virtualMFADeviceName;
return this;
}
public final void setVirtualMFADeviceName(String virtualMFADeviceName) {
this.virtualMFADeviceName = virtualMFADeviceName;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateVirtualMfaDeviceRequest build() {
return new CreateVirtualMfaDeviceRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}