software.amazon.awssdk.services.rds.model.ModifyDbParameterGroupRequest Maven / Gradle / Ivy
Show all versions of rds 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.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 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;
/**
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ModifyDbParameterGroupRequest extends RdsRequest implements
ToCopyableBuilder {
private static final SdkField DB_PARAMETER_GROUP_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DBParameterGroupName").getter(getter(ModifyDbParameterGroupRequest::dbParameterGroupName))
.setter(setter(Builder::dbParameterGroupName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBParameterGroupName").build())
.build();
private static final SdkField> PARAMETERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Parameters")
.getter(getter(ModifyDbParameterGroupRequest::parameters))
.setter(setter(Builder::parameters))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Parameters").build(),
ListTrait
.builder()
.memberLocationName("Parameter")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Parameter::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("Parameter").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DB_PARAMETER_GROUP_NAME_FIELD,
PARAMETERS_FIELD));
private final String dbParameterGroupName;
private final List parameters;
private ModifyDbParameterGroupRequest(BuilderImpl builder) {
super(builder);
this.dbParameterGroupName = builder.dbParameterGroupName;
this.parameters = builder.parameters;
}
/**
*
* The name of the DB parameter group.
*
*
* Constraints:
*
*
* -
*
* If supplied, must match the name of an existing DBParameterGroup.
*
*
*
*
* @return The name of the DB parameter group.
*
* Constraints:
*
*
* -
*
* If supplied, must match the name of an existing DBParameterGroup.
*
*
*/
public final String dbParameterGroupName() {
return dbParameterGroupName;
}
/**
* For responses, this returns true if the service returned a value for the Parameters 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 hasParameters() {
return parameters != null && !(parameters instanceof SdkAutoConstructList);
}
/**
*
* An array of parameter names, values, and the application methods for the parameter update. At least one parameter
* name, value, and application method must be supplied; later arguments are optional. A maximum of 20 parameters
* can be modified in a single request.
*
*
* Valid Values (for the application method): immediate | pending-reboot
*
*
* You can use the immediate value with dynamic parameters only. You can use the
* pending-reboot value for both dynamic and static parameters.
*
*
* When the application method is immediate, changes to dynamic parameters are applied immediately to
* the DB instances associated with the parameter group.
*
*
* When the application method is pending-reboot, changes to dynamic and static parameters are applied
* after a reboot without failover to the DB instances associated with the parameter group.
*
*
*
* You can't use pending-reboot with dynamic parameters on RDS for SQL Server DB instances. Use
* immediate.
*
*
*
* For more information on modifying DB parameters, see Working with DB
* parameter groups in the Amazon RDS User Guide.
*
*
* 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 #hasParameters} method.
*
*
* @return An array of parameter names, values, and the application methods for the parameter update. At least one
* parameter name, value, and application method must be supplied; later arguments are optional. A maximum
* of 20 parameters can be modified in a single request.
*
* Valid Values (for the application method): immediate | pending-reboot
*
*
* You can use the immediate value with dynamic parameters only. You can use the
* pending-reboot value for both dynamic and static parameters.
*
*
* When the application method is immediate, changes to dynamic parameters are applied
* immediately to the DB instances associated with the parameter group.
*
*
* When the application method is pending-reboot, changes to dynamic and static parameters are
* applied after a reboot without failover to the DB instances associated with the parameter group.
*
*
*
* You can't use pending-reboot with dynamic parameters on RDS for SQL Server DB instances. Use
* immediate.
*
*
*
* For more information on modifying DB parameters, see Working
* with DB parameter groups in the Amazon RDS User Guide.
*/
public final List parameters() {
return parameters;
}
@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(dbParameterGroupName());
hashCode = 31 * hashCode + Objects.hashCode(hasParameters() ? parameters() : 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 ModifyDbParameterGroupRequest)) {
return false;
}
ModifyDbParameterGroupRequest other = (ModifyDbParameterGroupRequest) obj;
return Objects.equals(dbParameterGroupName(), other.dbParameterGroupName()) && hasParameters() == other.hasParameters()
&& Objects.equals(parameters(), other.parameters());
}
/**
* 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("ModifyDbParameterGroupRequest").add("DBParameterGroupName", dbParameterGroupName())
.add("Parameters", hasParameters() ? parameters() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DBParameterGroupName":
return Optional.ofNullable(clazz.cast(dbParameterGroupName()));
case "Parameters":
return Optional.ofNullable(clazz.cast(parameters()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ModifyDbParameterGroupRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends RdsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the DB parameter group.
*
*
* Constraints:
*
*
* -
*
* If supplied, must match the name of an existing DBParameterGroup.
*
*
*
*
* @param dbParameterGroupName
* The name of the DB parameter group.
*
* Constraints:
*
*
* -
*
* If supplied, must match the name of an existing DBParameterGroup.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbParameterGroupName(String dbParameterGroupName);
/**
*
* An array of parameter names, values, and the application methods for the parameter update. At least one
* parameter name, value, and application method must be supplied; later arguments are optional. A maximum of 20
* parameters can be modified in a single request.
*
*
* Valid Values (for the application method): immediate | pending-reboot
*
*
* You can use the immediate value with dynamic parameters only. You can use the
* pending-reboot value for both dynamic and static parameters.
*
*
* When the application method is immediate, changes to dynamic parameters are applied immediately
* to the DB instances associated with the parameter group.
*
*
* When the application method is pending-reboot, changes to dynamic and static parameters are
* applied after a reboot without failover to the DB instances associated with the parameter group.
*
*
*
* You can't use pending-reboot with dynamic parameters on RDS for SQL Server DB instances. Use
* immediate.
*
*
*
* For more information on modifying DB parameters, see Working with
* DB parameter groups in the Amazon RDS User Guide.
*
*
* @param parameters
* An array of parameter names, values, and the application methods for the parameter update. At least
* one parameter name, value, and application method must be supplied; later arguments are optional. A
* maximum of 20 parameters can be modified in a single request.
*
* Valid Values (for the application method): immediate | pending-reboot
*
*
* You can use the immediate value with dynamic parameters only. You can use the
* pending-reboot value for both dynamic and static parameters.
*
*
* When the application method is immediate, changes to dynamic parameters are applied
* immediately to the DB instances associated with the parameter group.
*
*
* When the application method is pending-reboot, changes to dynamic and static parameters
* are applied after a reboot without failover to the DB instances associated with the parameter group.
*
*
*
* You can't use pending-reboot with dynamic parameters on RDS for SQL Server DB instances.
* Use immediate.
*
*
*
* For more information on modifying DB parameters, see Working
* with DB parameter groups in the Amazon RDS User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder parameters(Collection parameters);
/**
*
* An array of parameter names, values, and the application methods for the parameter update. At least one
* parameter name, value, and application method must be supplied; later arguments are optional. A maximum of 20
* parameters can be modified in a single request.
*
*
* Valid Values (for the application method): immediate | pending-reboot
*
*
* You can use the immediate value with dynamic parameters only. You can use the
* pending-reboot value for both dynamic and static parameters.
*
*
* When the application method is immediate, changes to dynamic parameters are applied immediately
* to the DB instances associated with the parameter group.
*
*
* When the application method is pending-reboot, changes to dynamic and static parameters are
* applied after a reboot without failover to the DB instances associated with the parameter group.
*
*
*
* You can't use pending-reboot with dynamic parameters on RDS for SQL Server DB instances. Use
* immediate.
*
*
*
* For more information on modifying DB parameters, see Working with
* DB parameter groups in the Amazon RDS User Guide.
*
*
* @param parameters
* An array of parameter names, values, and the application methods for the parameter update. At least
* one parameter name, value, and application method must be supplied; later arguments are optional. A
* maximum of 20 parameters can be modified in a single request.
*
* Valid Values (for the application method): immediate | pending-reboot
*
*
* You can use the immediate value with dynamic parameters only. You can use the
* pending-reboot value for both dynamic and static parameters.
*
*
* When the application method is immediate, changes to dynamic parameters are applied
* immediately to the DB instances associated with the parameter group.
*
*
* When the application method is pending-reboot, changes to dynamic and static parameters
* are applied after a reboot without failover to the DB instances associated with the parameter group.
*
*
*
* You can't use pending-reboot with dynamic parameters on RDS for SQL Server DB instances.
* Use immediate.
*
*
*
* For more information on modifying DB parameters, see Working
* with DB parameter groups in the Amazon RDS User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder parameters(Parameter... parameters);
/**
*
* An array of parameter names, values, and the application methods for the parameter update. At least one
* parameter name, value, and application method must be supplied; later arguments are optional. A maximum of 20
* parameters can be modified in a single request.
*
*
* Valid Values (for the application method): immediate | pending-reboot
*
*
* You can use the immediate value with dynamic parameters only. You can use the
* pending-reboot value for both dynamic and static parameters.
*
*
* When the application method is immediate, changes to dynamic parameters are applied immediately
* to the DB instances associated with the parameter group.
*
*
* When the application method is pending-reboot, changes to dynamic and static parameters are
* applied after a reboot without failover to the DB instances associated with the parameter group.
*
*
*
* You can't use pending-reboot with dynamic parameters on RDS for SQL Server DB instances. Use
* immediate.
*
*
*
* For more information on modifying DB parameters, see Working with
* DB parameter groups in the Amazon RDS User Guide.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.rds.model.Parameter.Builder} avoiding the need to create one manually
* via {@link software.amazon.awssdk.services.rds.model.Parameter#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.rds.model.Parameter.Builder#build()} is called immediately and its
* result is passed to {@link #parameters(List)}.
*
* @param parameters
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.rds.model.Parameter.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #parameters(java.util.Collection)
*/
Builder parameters(Consumer... parameters);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends RdsRequest.BuilderImpl implements Builder {
private String dbParameterGroupName;
private List parameters = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ModifyDbParameterGroupRequest model) {
super(model);
dbParameterGroupName(model.dbParameterGroupName);
parameters(model.parameters);
}
public final String getDbParameterGroupName() {
return dbParameterGroupName;
}
public final void setDbParameterGroupName(String dbParameterGroupName) {
this.dbParameterGroupName = dbParameterGroupName;
}
@Override
public final Builder dbParameterGroupName(String dbParameterGroupName) {
this.dbParameterGroupName = dbParameterGroupName;
return this;
}
public final List getParameters() {
List result = ParametersListCopier.copyToBuilder(this.parameters);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setParameters(Collection parameters) {
this.parameters = ParametersListCopier.copyFromBuilder(parameters);
}
@Override
public final Builder parameters(Collection parameters) {
this.parameters = ParametersListCopier.copy(parameters);
return this;
}
@Override
@SafeVarargs
public final Builder parameters(Parameter... parameters) {
parameters(Arrays.asList(parameters));
return this;
}
@Override
@SafeVarargs
public final Builder parameters(Consumer... parameters) {
parameters(Stream.of(parameters).map(c -> Parameter.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 ModifyDbParameterGroupRequest build() {
return new ModifyDbParameterGroupRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}