software.amazon.awssdk.services.route53domains.model.UpdateDomainNameserversRequest Maven / Gradle / Ivy
Show all versions of route53domains 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.route53domains.model;
import java.util.Arrays;
import java.util.Collection;
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 java.util.stream.Collectors;
import java.util.stream.Stream;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Replaces the current set of name servers for the domain with the specified set of name servers. If you use Amazon
* Route 53 as your DNS service, specify the four name servers in the delegation set for the hosted zone for the domain.
*
*
* If successful, this operation returns an operation ID that you can use to track the progress and completion of the
* action. If the request is not completed successfully, the domain registrant will be notified by email.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class UpdateDomainNameserversRequest extends Route53DomainsRequest implements
ToCopyableBuilder {
private static final SdkField DOMAIN_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DomainName").getter(getter(UpdateDomainNameserversRequest::domainName))
.setter(setter(Builder::domainName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DomainName").build()).build();
private static final SdkField FI_AUTH_KEY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("FIAuthKey").getter(getter(UpdateDomainNameserversRequest::fiAuthKey)).setter(setter(Builder::fiAuthKey))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FIAuthKey").build()).build();
private static final SdkField> NAMESERVERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Nameservers")
.getter(getter(UpdateDomainNameserversRequest::nameservers))
.setter(setter(Builder::nameservers))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Nameservers").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Nameserver::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DOMAIN_NAME_FIELD,
FI_AUTH_KEY_FIELD, NAMESERVERS_FIELD));
private final String domainName;
private final String fiAuthKey;
private final List nameservers;
private UpdateDomainNameserversRequest(BuilderImpl builder) {
super(builder);
this.domainName = builder.domainName;
this.fiAuthKey = builder.fiAuthKey;
this.nameservers = builder.nameservers;
}
/**
*
* The name of the domain that you want to change name servers for.
*
*
* @return The name of the domain that you want to change name servers for.
*/
public final String domainName() {
return domainName;
}
/**
*
* The authorization key for .fi domains
*
*
* @return The authorization key for .fi domains
* @deprecated
*/
@Deprecated
public final String fiAuthKey() {
return fiAuthKey;
}
/**
* For responses, this returns true if the service returned a value for the Nameservers 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 hasNameservers() {
return nameservers != null && !(nameservers instanceof SdkAutoConstructList);
}
/**
*
* A list of new name servers for the domain.
*
*
* 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 #hasNameservers} method.
*
*
* @return A list of new name servers for the domain.
*/
public final List nameservers() {
return nameservers;
}
@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(domainName());
hashCode = 31 * hashCode + Objects.hashCode(fiAuthKey());
hashCode = 31 * hashCode + Objects.hashCode(hasNameservers() ? nameservers() : null);
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 UpdateDomainNameserversRequest)) {
return false;
}
UpdateDomainNameserversRequest other = (UpdateDomainNameserversRequest) obj;
return Objects.equals(domainName(), other.domainName()) && Objects.equals(fiAuthKey(), other.fiAuthKey())
&& hasNameservers() == other.hasNameservers() && Objects.equals(nameservers(), other.nameservers());
}
/**
* 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("UpdateDomainNameserversRequest").add("DomainName", domainName())
.add("FIAuthKey", fiAuthKey() == null ? null : "*** Sensitive Data Redacted ***")
.add("Nameservers", hasNameservers() ? nameservers() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DomainName":
return Optional.ofNullable(clazz.cast(domainName()));
case "FIAuthKey":
return Optional.ofNullable(clazz.cast(fiAuthKey()));
case "Nameservers":
return Optional.ofNullable(clazz.cast(nameservers()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((UpdateDomainNameserversRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends Route53DomainsRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* The name of the domain that you want to change name servers for.
*
*
* @param domainName
* The name of the domain that you want to change name servers for.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder domainName(String domainName);
/**
*
* The authorization key for .fi domains
*
*
* @param fiAuthKey
* The authorization key for .fi domains
* @return Returns a reference to this object so that method calls can be chained together.
* @deprecated
*/
@Deprecated
Builder fiAuthKey(String fiAuthKey);
/**
*
* A list of new name servers for the domain.
*
*
* @param nameservers
* A list of new name servers for the domain.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nameservers(Collection nameservers);
/**
*
* A list of new name servers for the domain.
*
*
* @param nameservers
* A list of new name servers for the domain.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nameservers(Nameserver... nameservers);
/**
*
* A list of new name servers for the domain.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.route53domains.model.Nameserver.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.route53domains.model.Nameserver#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.route53domains.model.Nameserver.Builder#build()} is called immediately
* and its result is passed to {@link #nameservers(List)}.
*
* @param nameservers
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.route53domains.model.Nameserver.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #nameservers(java.util.Collection)
*/
Builder nameservers(Consumer... nameservers);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends Route53DomainsRequest.BuilderImpl implements Builder {
private String domainName;
private String fiAuthKey;
private List nameservers = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(UpdateDomainNameserversRequest model) {
super(model);
domainName(model.domainName);
fiAuthKey(model.fiAuthKey);
nameservers(model.nameservers);
}
public final String getDomainName() {
return domainName;
}
public final void setDomainName(String domainName) {
this.domainName = domainName;
}
@Override
public final Builder domainName(String domainName) {
this.domainName = domainName;
return this;
}
@Deprecated
public final String getFiAuthKey() {
return fiAuthKey;
}
@Deprecated
public final void setFiAuthKey(String fiAuthKey) {
this.fiAuthKey = fiAuthKey;
}
@Override
@Deprecated
public final Builder fiAuthKey(String fiAuthKey) {
this.fiAuthKey = fiAuthKey;
return this;
}
public final List getNameservers() {
List result = NameserverListCopier.copyToBuilder(this.nameservers);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setNameservers(Collection nameservers) {
this.nameservers = NameserverListCopier.copyFromBuilder(nameservers);
}
@Override
public final Builder nameservers(Collection nameservers) {
this.nameservers = NameserverListCopier.copy(nameservers);
return this;
}
@Override
@SafeVarargs
public final Builder nameservers(Nameserver... nameservers) {
nameservers(Arrays.asList(nameservers));
return this;
}
@Override
@SafeVarargs
public final Builder nameservers(Consumer... nameservers) {
nameservers(Stream.of(nameservers).map(c -> Nameserver.builder().applyMutation(c).build())
.collect(Collectors.toList()));
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 UpdateDomainNameserversRequest build() {
return new UpdateDomainNameserversRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}