software.amazon.awssdk.services.cognitoidentityprovider.model.CreateUserPoolDomainRequest Maven / Gradle / Ivy
/*
* 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.beans.Transient;
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 CreateUserPoolDomainRequest extends CognitoIdentityProviderRequest implements
ToCopyableBuilder {
private static final SdkField DOMAIN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Domain")
.getter(getter(CreateUserPoolDomainRequest::domain)).setter(setter(Builder::domain))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Domain").build()).build();
private static final SdkField USER_POOL_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("UserPoolId").getter(getter(CreateUserPoolDomainRequest::userPoolId)).setter(setter(Builder::userPoolId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("UserPoolId").build()).build();
private static final SdkField CUSTOM_DOMAIN_CONFIG_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("CustomDomainConfig")
.getter(getter(CreateUserPoolDomainRequest::customDomainConfig)).setter(setter(Builder::customDomainConfig))
.constructor(CustomDomainConfigType::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CustomDomainConfig").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DOMAIN_FIELD,
USER_POOL_ID_FIELD, CUSTOM_DOMAIN_CONFIG_FIELD));
private final String domain;
private final String userPoolId;
private final CustomDomainConfigType customDomainConfig;
private CreateUserPoolDomainRequest(BuilderImpl builder) {
super(builder);
this.domain = builder.domain;
this.userPoolId = builder.userPoolId;
this.customDomainConfig = builder.customDomainConfig;
}
/**
*
* The domain string.
*
*
* @return The domain string.
*/
public final String domain() {
return domain;
}
/**
*
* The user pool ID.
*
*
* @return The user pool ID.
*/
public final String userPoolId() {
return userPoolId;
}
/**
*
* The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
*
*
* Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude
* this parameter and use the Amazon Cognito hosted domain instead.
*
*
* For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.
*
*
* @return The configuration for a custom domain that hosts the sign-up and sign-in webpages for your
* application.
*
* Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can
* exclude this parameter and use the Amazon Cognito hosted domain instead.
*
*
* For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.
*/
public final CustomDomainConfigType customDomainConfig() {
return customDomainConfig;
}
@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 final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(domain());
hashCode = 31 * hashCode + Objects.hashCode(userPoolId());
hashCode = 31 * hashCode + Objects.hashCode(customDomainConfig());
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 CreateUserPoolDomainRequest)) {
return false;
}
CreateUserPoolDomainRequest other = (CreateUserPoolDomainRequest) obj;
return Objects.equals(domain(), other.domain()) && Objects.equals(userPoolId(), other.userPoolId())
&& Objects.equals(customDomainConfig(), other.customDomainConfig());
}
/**
* 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("CreateUserPoolDomainRequest").add("Domain", domain()).add("UserPoolId", userPoolId())
.add("CustomDomainConfig", customDomainConfig()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Domain":
return Optional.ofNullable(clazz.cast(domain()));
case "UserPoolId":
return Optional.ofNullable(clazz.cast(userPoolId()));
case "CustomDomainConfig":
return Optional.ofNullable(clazz.cast(customDomainConfig()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function
*
* Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can
* exclude this parameter and use the Amazon Cognito hosted domain instead.
*
*
* For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder customDomainConfig(CustomDomainConfigType customDomainConfig);
/**
*
* The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.
*
*
* Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude
* this parameter and use the Amazon Cognito hosted domain instead.
*
*
* For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.
*
* This is a convenience that creates an instance of the {@link CustomDomainConfigType.Builder} avoiding the
* need to create one manually via {@link CustomDomainConfigType#builder()}.
*
* When the {@link Consumer} completes, {@link CustomDomainConfigType.Builder#build()} is called immediately and
* its result is passed to {@link #customDomainConfig(CustomDomainConfigType)}.
*
* @param customDomainConfig
* a consumer that will call methods on {@link CustomDomainConfigType.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #customDomainConfig(CustomDomainConfigType)
*/
default Builder customDomainConfig(Consumer customDomainConfig) {
return customDomainConfig(CustomDomainConfigType.builder().applyMutation(customDomainConfig).build());
}
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends CognitoIdentityProviderRequest.BuilderImpl implements Builder {
private String domain;
private String userPoolId;
private CustomDomainConfigType customDomainConfig;
private BuilderImpl() {
}
private BuilderImpl(CreateUserPoolDomainRequest model) {
super(model);
domain(model.domain);
userPoolId(model.userPoolId);
customDomainConfig(model.customDomainConfig);
}
public final String getDomain() {
return domain;
}
public final void setDomain(String domain) {
this.domain = domain;
}
@Override
@Transient
public final Builder domain(String domain) {
this.domain = domain;
return this;
}
public final String getUserPoolId() {
return userPoolId;
}
public final void setUserPoolId(String userPoolId) {
this.userPoolId = userPoolId;
}
@Override
@Transient
public final Builder userPoolId(String userPoolId) {
this.userPoolId = userPoolId;
return this;
}
public final CustomDomainConfigType.Builder getCustomDomainConfig() {
return customDomainConfig != null ? customDomainConfig.toBuilder() : null;
}
public final void setCustomDomainConfig(CustomDomainConfigType.BuilderImpl customDomainConfig) {
this.customDomainConfig = customDomainConfig != null ? customDomainConfig.build() : null;
}
@Override
@Transient
public final Builder customDomainConfig(CustomDomainConfigType customDomainConfig) {
this.customDomainConfig = customDomainConfig;
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 CreateUserPoolDomainRequest build() {
return new CreateUserPoolDomainRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}