software.amazon.awssdk.services.rds.model.ModifyDbClusterEndpointRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of rds Show documentation
Show all versions of rds Show documentation
The AWS Java SDK for Amazon RDS module holds the client classes that are used for communicating with
Amazon Relational Database Service
/*
* 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.rds.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 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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class ModifyDbClusterEndpointRequest extends RdsRequest implements
ToCopyableBuilder {
private static final SdkField DB_CLUSTER_ENDPOINT_IDENTIFIER_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("DBClusterEndpointIdentifier")
.getter(getter(ModifyDbClusterEndpointRequest::dbClusterEndpointIdentifier))
.setter(setter(Builder::dbClusterEndpointIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBClusterEndpointIdentifier")
.build()).build();
private static final SdkField ENDPOINT_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EndpointType").getter(getter(ModifyDbClusterEndpointRequest::endpointType))
.setter(setter(Builder::endpointType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EndpointType").build()).build();
private static final SdkField> STATIC_MEMBERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("StaticMembers")
.getter(getter(ModifyDbClusterEndpointRequest::staticMembers))
.setter(setter(Builder::staticMembers))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StaticMembers").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> EXCLUDED_MEMBERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("ExcludedMembers")
.getter(getter(ModifyDbClusterEndpointRequest::excludedMembers))
.setter(setter(Builder::excludedMembers))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ExcludedMembers").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(
DB_CLUSTER_ENDPOINT_IDENTIFIER_FIELD, ENDPOINT_TYPE_FIELD, STATIC_MEMBERS_FIELD, EXCLUDED_MEMBERS_FIELD));
private final String dbClusterEndpointIdentifier;
private final String endpointType;
private final List staticMembers;
private final List excludedMembers;
private ModifyDbClusterEndpointRequest(BuilderImpl builder) {
super(builder);
this.dbClusterEndpointIdentifier = builder.dbClusterEndpointIdentifier;
this.endpointType = builder.endpointType;
this.staticMembers = builder.staticMembers;
this.excludedMembers = builder.excludedMembers;
}
/**
*
* The identifier of the endpoint to modify. This parameter is stored as a lowercase string.
*
*
* @return The identifier of the endpoint to modify. This parameter is stored as a lowercase string.
*/
public final String dbClusterEndpointIdentifier() {
return dbClusterEndpointIdentifier;
}
/**
*
* The type of the endpoint. One of: READER, WRITER, ANY.
*
*
* @return The type of the endpoint. One of: READER, WRITER, ANY.
*/
public final String endpointType() {
return endpointType;
}
/**
* For responses, this returns true if the service returned a value for the StaticMembers 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 hasStaticMembers() {
return staticMembers != null && !(staticMembers instanceof SdkAutoConstructList);
}
/**
*
* List of DB instance identifiers that are part of the custom endpoint group.
*
*
* 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 #hasStaticMembers} method.
*
*
* @return List of DB instance identifiers that are part of the custom endpoint group.
*/
public final List staticMembers() {
return staticMembers;
}
/**
* For responses, this returns true if the service returned a value for the ExcludedMembers 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 hasExcludedMembers() {
return excludedMembers != null && !(excludedMembers instanceof SdkAutoConstructList);
}
/**
*
* List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are
* reachable through the custom endpoint. Only relevant if the list of static members is empty.
*
*
* 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 #hasExcludedMembers} method.
*
*
* @return List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible
* instances are reachable through the custom endpoint. Only relevant if the list of static members is
* empty.
*/
public final List excludedMembers() {
return excludedMembers;
}
@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(dbClusterEndpointIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(endpointType());
hashCode = 31 * hashCode + Objects.hashCode(hasStaticMembers() ? staticMembers() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasExcludedMembers() ? excludedMembers() : 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 ModifyDbClusterEndpointRequest)) {
return false;
}
ModifyDbClusterEndpointRequest other = (ModifyDbClusterEndpointRequest) obj;
return Objects.equals(dbClusterEndpointIdentifier(), other.dbClusterEndpointIdentifier())
&& Objects.equals(endpointType(), other.endpointType()) && hasStaticMembers() == other.hasStaticMembers()
&& Objects.equals(staticMembers(), other.staticMembers()) && hasExcludedMembers() == other.hasExcludedMembers()
&& Objects.equals(excludedMembers(), other.excludedMembers());
}
/**
* 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("ModifyDbClusterEndpointRequest")
.add("DBClusterEndpointIdentifier", dbClusterEndpointIdentifier()).add("EndpointType", endpointType())
.add("StaticMembers", hasStaticMembers() ? staticMembers() : null)
.add("ExcludedMembers", hasExcludedMembers() ? excludedMembers() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DBClusterEndpointIdentifier":
return Optional.ofNullable(clazz.cast(dbClusterEndpointIdentifier()));
case "EndpointType":
return Optional.ofNullable(clazz.cast(endpointType()));
case "StaticMembers":
return Optional.ofNullable(clazz.cast(staticMembers()));
case "ExcludedMembers":
return Optional.ofNullable(clazz.cast(excludedMembers()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ModifyDbClusterEndpointRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends RdsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The identifier of the endpoint to modify. This parameter is stored as a lowercase string.
*
*
* @param dbClusterEndpointIdentifier
* The identifier of the endpoint to modify. This parameter is stored as a lowercase string.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbClusterEndpointIdentifier(String dbClusterEndpointIdentifier);
/**
*
* The type of the endpoint. One of: READER, WRITER, ANY.
*
*
* @param endpointType
* The type of the endpoint. One of: READER, WRITER, ANY.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder endpointType(String endpointType);
/**
*
* List of DB instance identifiers that are part of the custom endpoint group.
*
*
* @param staticMembers
* List of DB instance identifiers that are part of the custom endpoint group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder staticMembers(Collection staticMembers);
/**
*
* List of DB instance identifiers that are part of the custom endpoint group.
*
*
* @param staticMembers
* List of DB instance identifiers that are part of the custom endpoint group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder staticMembers(String... staticMembers);
/**
*
* List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances
* are reachable through the custom endpoint. Only relevant if the list of static members is empty.
*
*
* @param excludedMembers
* List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible
* instances are reachable through the custom endpoint. Only relevant if the list of static members is
* empty.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder excludedMembers(Collection excludedMembers);
/**
*
* List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances
* are reachable through the custom endpoint. Only relevant if the list of static members is empty.
*
*
* @param excludedMembers
* List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible
* instances are reachable through the custom endpoint. Only relevant if the list of static members is
* empty.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder excludedMembers(String... excludedMembers);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends RdsRequest.BuilderImpl implements Builder {
private String dbClusterEndpointIdentifier;
private String endpointType;
private List staticMembers = DefaultSdkAutoConstructList.getInstance();
private List excludedMembers = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ModifyDbClusterEndpointRequest model) {
super(model);
dbClusterEndpointIdentifier(model.dbClusterEndpointIdentifier);
endpointType(model.endpointType);
staticMembers(model.staticMembers);
excludedMembers(model.excludedMembers);
}
public final String getDbClusterEndpointIdentifier() {
return dbClusterEndpointIdentifier;
}
public final void setDbClusterEndpointIdentifier(String dbClusterEndpointIdentifier) {
this.dbClusterEndpointIdentifier = dbClusterEndpointIdentifier;
}
@Override
public final Builder dbClusterEndpointIdentifier(String dbClusterEndpointIdentifier) {
this.dbClusterEndpointIdentifier = dbClusterEndpointIdentifier;
return this;
}
public final String getEndpointType() {
return endpointType;
}
public final void setEndpointType(String endpointType) {
this.endpointType = endpointType;
}
@Override
public final Builder endpointType(String endpointType) {
this.endpointType = endpointType;
return this;
}
public final Collection getStaticMembers() {
if (staticMembers instanceof SdkAutoConstructList) {
return null;
}
return staticMembers;
}
public final void setStaticMembers(Collection staticMembers) {
this.staticMembers = StringListCopier.copy(staticMembers);
}
@Override
public final Builder staticMembers(Collection staticMembers) {
this.staticMembers = StringListCopier.copy(staticMembers);
return this;
}
@Override
@SafeVarargs
public final Builder staticMembers(String... staticMembers) {
staticMembers(Arrays.asList(staticMembers));
return this;
}
public final Collection getExcludedMembers() {
if (excludedMembers instanceof SdkAutoConstructList) {
return null;
}
return excludedMembers;
}
public final void setExcludedMembers(Collection excludedMembers) {
this.excludedMembers = StringListCopier.copy(excludedMembers);
}
@Override
public final Builder excludedMembers(Collection excludedMembers) {
this.excludedMembers = StringListCopier.copy(excludedMembers);
return this;
}
@Override
@SafeVarargs
public final Builder excludedMembers(String... excludedMembers) {
excludedMembers(Arrays.asList(excludedMembers));
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 ModifyDbClusterEndpointRequest build() {
return new ModifyDbClusterEndpointRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}