software.amazon.awssdk.services.qbusiness.model.AuthChallengeResponse Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of qbusiness Show documentation
Show all versions of qbusiness Show documentation
The AWS Java SDK for Q Business module holds the client classes that are used for
communicating with Q Business.
/*
* 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.qbusiness.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
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.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Contains details of the authentication information received from a third party authentication server in response to
* an authentication challenge.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AuthChallengeResponse implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField> RESPONSE_MAP_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("responseMap")
.getter(getter(AuthChallengeResponse::responseMap))
.setter(setter(Builder::responseMap))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("responseMap").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(RESPONSE_MAP_FIELD));
private static final long serialVersionUID = 1L;
private final Map responseMap;
private AuthChallengeResponse(BuilderImpl builder) {
this.responseMap = builder.responseMap;
}
/**
* For responses, this returns true if the service returned a value for the ResponseMap property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasResponseMap() {
return responseMap != null && !(responseMap instanceof SdkAutoConstructMap);
}
/**
*
* The mapping of key-value pairs in an authentication challenge response.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasResponseMap} method.
*
*
* @return The mapping of key-value pairs in an authentication challenge response.
*/
public final Map responseMap() {
return responseMap;
}
@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(hasResponseMap() ? responseMap() : null);
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 AuthChallengeResponse)) {
return false;
}
AuthChallengeResponse other = (AuthChallengeResponse) obj;
return hasResponseMap() == other.hasResponseMap() && Objects.equals(responseMap(), other.responseMap());
}
/**
* 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("AuthChallengeResponse").add("ResponseMap", hasResponseMap() ? responseMap() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "responseMap":
return Optional.ofNullable(clazz.cast(responseMap()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((AuthChallengeResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The mapping of key-value pairs in an authentication challenge response.
*
*
* @param responseMap
* The mapping of key-value pairs in an authentication challenge response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder responseMap(Map responseMap);
}
static final class BuilderImpl implements Builder {
private Map responseMap = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(AuthChallengeResponse model) {
responseMap(model.responseMap);
}
public final Map getResponseMap() {
if (responseMap instanceof SdkAutoConstructMap) {
return null;
}
return responseMap;
}
public final void setResponseMap(Map responseMap) {
this.responseMap = AuthorizationResponseMapCopier.copy(responseMap);
}
@Override
public final Builder responseMap(Map responseMap) {
this.responseMap = AuthorizationResponseMapCopier.copy(responseMap);
return this;
}
@Override
public AuthChallengeResponse build() {
return new AuthChallengeResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}