software.amazon.awssdk.services.cognitoidentityprovider.model.ConfirmDeviceRequest Maven / Gradle / Ivy
Show all versions of cognitoidentityprovider 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.cognitoidentityprovider.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;
/**
*
* Confirms the device request.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ConfirmDeviceRequest extends CognitoIdentityProviderRequest implements
ToCopyableBuilder {
private static final SdkField ACCESS_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("AccessToken").getter(getter(ConfirmDeviceRequest::accessToken)).setter(setter(Builder::accessToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AccessToken").build()).build();
private static final SdkField DEVICE_KEY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DeviceKey").getter(getter(ConfirmDeviceRequest::deviceKey)).setter(setter(Builder::deviceKey))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DeviceKey").build()).build();
private static final SdkField DEVICE_SECRET_VERIFIER_CONFIG_FIELD = SdkField
. builder(MarshallingType.SDK_POJO)
.memberName("DeviceSecretVerifierConfig")
.getter(getter(ConfirmDeviceRequest::deviceSecretVerifierConfig))
.setter(setter(Builder::deviceSecretVerifierConfig))
.constructor(DeviceSecretVerifierConfigType::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DeviceSecretVerifierConfig").build())
.build();
private static final SdkField DEVICE_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DeviceName").getter(getter(ConfirmDeviceRequest::deviceName)).setter(setter(Builder::deviceName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DeviceName").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ACCESS_TOKEN_FIELD,
DEVICE_KEY_FIELD, DEVICE_SECRET_VERIFIER_CONFIG_FIELD, DEVICE_NAME_FIELD));
private final String accessToken;
private final String deviceKey;
private final DeviceSecretVerifierConfigType deviceSecretVerifierConfig;
private final String deviceName;
private ConfirmDeviceRequest(BuilderImpl builder) {
super(builder);
this.accessToken = builder.accessToken;
this.deviceKey = builder.deviceKey;
this.deviceSecretVerifierConfig = builder.deviceSecretVerifierConfig;
this.deviceName = builder.deviceName;
}
/**
*
* A valid access token that Amazon Cognito issued to the user whose device you want to confirm.
*
*
* @return A valid access token that Amazon Cognito issued to the user whose device you want to confirm.
*/
public final String accessToken() {
return accessToken;
}
/**
*
* The device key.
*
*
* @return The device key.
*/
public final String deviceKey() {
return deviceKey;
}
/**
*
* The configuration of the device secret verifier.
*
*
* @return The configuration of the device secret verifier.
*/
public final DeviceSecretVerifierConfigType deviceSecretVerifierConfig() {
return deviceSecretVerifierConfig;
}
/**
*
* The device name.
*
*
* @return The device name.
*/
public final String deviceName() {
return deviceName;
}
@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(accessToken());
hashCode = 31 * hashCode + Objects.hashCode(deviceKey());
hashCode = 31 * hashCode + Objects.hashCode(deviceSecretVerifierConfig());
hashCode = 31 * hashCode + Objects.hashCode(deviceName());
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 ConfirmDeviceRequest)) {
return false;
}
ConfirmDeviceRequest other = (ConfirmDeviceRequest) obj;
return Objects.equals(accessToken(), other.accessToken()) && Objects.equals(deviceKey(), other.deviceKey())
&& Objects.equals(deviceSecretVerifierConfig(), other.deviceSecretVerifierConfig())
&& Objects.equals(deviceName(), other.deviceName());
}
/**
* 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("ConfirmDeviceRequest")
.add("AccessToken", accessToken() == null ? null : "*** Sensitive Data Redacted ***")
.add("DeviceKey", deviceKey()).add("DeviceSecretVerifierConfig", deviceSecretVerifierConfig())
.add("DeviceName", deviceName()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "AccessToken":
return Optional.ofNullable(clazz.cast(accessToken()));
case "DeviceKey":
return Optional.ofNullable(clazz.cast(deviceKey()));
case "DeviceSecretVerifierConfig":
return Optional.ofNullable(clazz.cast(deviceSecretVerifierConfig()));
case "DeviceName":
return Optional.ofNullable(clazz.cast(deviceName()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ConfirmDeviceRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends CognitoIdentityProviderRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* A valid access token that Amazon Cognito issued to the user whose device you want to confirm.
*
*
* @param accessToken
* A valid access token that Amazon Cognito issued to the user whose device you want to confirm.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder accessToken(String accessToken);
/**
*
* The device key.
*
*
* @param deviceKey
* The device key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder deviceKey(String deviceKey);
/**
*
* The configuration of the device secret verifier.
*
*
* @param deviceSecretVerifierConfig
* The configuration of the device secret verifier.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder deviceSecretVerifierConfig(DeviceSecretVerifierConfigType deviceSecretVerifierConfig);
/**
*
* The configuration of the device secret verifier.
*
* This is a convenience method that creates an instance of the {@link DeviceSecretVerifierConfigType.Builder}
* avoiding the need to create one manually via {@link DeviceSecretVerifierConfigType#builder()}.
*
*
* When the {@link Consumer} completes, {@link DeviceSecretVerifierConfigType.Builder#build()} is called
* immediately and its result is passed to {@link #deviceSecretVerifierConfig(DeviceSecretVerifierConfigType)}.
*
* @param deviceSecretVerifierConfig
* a consumer that will call methods on {@link DeviceSecretVerifierConfigType.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #deviceSecretVerifierConfig(DeviceSecretVerifierConfigType)
*/
default Builder deviceSecretVerifierConfig(Consumer deviceSecretVerifierConfig) {
return deviceSecretVerifierConfig(DeviceSecretVerifierConfigType.builder().applyMutation(deviceSecretVerifierConfig)
.build());
}
/**
*
* The device name.
*
*
* @param deviceName
* The device name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder deviceName(String deviceName);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends CognitoIdentityProviderRequest.BuilderImpl implements Builder {
private String accessToken;
private String deviceKey;
private DeviceSecretVerifierConfigType deviceSecretVerifierConfig;
private String deviceName;
private BuilderImpl() {
}
private BuilderImpl(ConfirmDeviceRequest model) {
super(model);
accessToken(model.accessToken);
deviceKey(model.deviceKey);
deviceSecretVerifierConfig(model.deviceSecretVerifierConfig);
deviceName(model.deviceName);
}
public final String getAccessToken() {
return accessToken;
}
public final void setAccessToken(String accessToken) {
this.accessToken = accessToken;
}
@Override
public final Builder accessToken(String accessToken) {
this.accessToken = accessToken;
return this;
}
public final String getDeviceKey() {
return deviceKey;
}
public final void setDeviceKey(String deviceKey) {
this.deviceKey = deviceKey;
}
@Override
public final Builder deviceKey(String deviceKey) {
this.deviceKey = deviceKey;
return this;
}
public final DeviceSecretVerifierConfigType.Builder getDeviceSecretVerifierConfig() {
return deviceSecretVerifierConfig != null ? deviceSecretVerifierConfig.toBuilder() : null;
}
public final void setDeviceSecretVerifierConfig(DeviceSecretVerifierConfigType.BuilderImpl deviceSecretVerifierConfig) {
this.deviceSecretVerifierConfig = deviceSecretVerifierConfig != null ? deviceSecretVerifierConfig.build() : null;
}
@Override
public final Builder deviceSecretVerifierConfig(DeviceSecretVerifierConfigType deviceSecretVerifierConfig) {
this.deviceSecretVerifierConfig = deviceSecretVerifierConfig;
return this;
}
public final String getDeviceName() {
return deviceName;
}
public final void setDeviceName(String deviceName) {
this.deviceName = deviceName;
}
@Override
public final Builder deviceName(String deviceName) {
this.deviceName = deviceName;
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 ConfirmDeviceRequest build() {
return new ConfirmDeviceRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}