software.amazon.awssdk.services.rds.model.CreateDbParameterGroupRequest 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 CreateDbParameterGroupRequest extends RdsRequest implements
ToCopyableBuilder {
private static final SdkField DB_PARAMETER_GROUP_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DBParameterGroupName").getter(getter(CreateDbParameterGroupRequest::dbParameterGroupName))
.setter(setter(Builder::dbParameterGroupName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBParameterGroupName").build())
.build();
private static final SdkField DB_PARAMETER_GROUP_FAMILY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DBParameterGroupFamily").getter(getter(CreateDbParameterGroupRequest::dbParameterGroupFamily))
.setter(setter(Builder::dbParameterGroupFamily))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DBParameterGroupFamily").build())
.build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(CreateDbParameterGroupRequest::description))
.setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(CreateDbParameterGroupRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
ListTrait
.builder()
.memberLocationName("Tag")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("Tag").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DB_PARAMETER_GROUP_NAME_FIELD,
DB_PARAMETER_GROUP_FAMILY_FIELD, DESCRIPTION_FIELD, TAGS_FIELD));
private final String dbParameterGroupName;
private final String dbParameterGroupFamily;
private final String description;
private final List tags;
private CreateDbParameterGroupRequest(BuilderImpl builder) {
super(builder);
this.dbParameterGroupName = builder.dbParameterGroupName;
this.dbParameterGroupFamily = builder.dbParameterGroupFamily;
this.description = builder.description;
this.tags = builder.tags;
}
/**
*
* The name of the DB parameter group.
*
*
* Constraints:
*
*
* -
*
* Must be 1 to 255 letters, numbers, or hyphens.
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Can't end with a hyphen or contain two consecutive hyphens
*
*
*
*
*
* This value is stored as a lowercase string.
*
*
*
* @return The name of the DB parameter group.
*
* Constraints:
*
*
* -
*
* Must be 1 to 255 letters, numbers, or hyphens.
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Can't end with a hyphen or contain two consecutive hyphens
*
*
*
*
*
* This value is stored as a lowercase string.
*
*/
public final String dbParameterGroupName() {
return dbParameterGroupName;
}
/**
*
* The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter
* group family, and can be applied only to a DB instance running a database engine and engine version compatible
* with that DB parameter group family.
*
*
* To list all of the available parameter group families for a DB engine, use the following command:
*
*
* aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>
*
*
* For example, to list all of the available parameter group families for the MySQL DB engine, use the following
* command:
*
*
* aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql
*
*
*
* The output contains duplicates.
*
*
*
* The following are the valid DB engine values:
*
*
* -
*
* aurora-mysql
*
*
* -
*
* aurora-postgresql
*
*
* -
*
* db2-ae
*
*
* -
*
* db2-se
*
*
* -
*
* mysql
*
*
* -
*
* oracle-ee
*
*
* -
*
* oracle-ee-cdb
*
*
* -
*
* oracle-se2
*
*
* -
*
* oracle-se2-cdb
*
*
* -
*
* postgres
*
*
* -
*
* sqlserver-ee
*
*
* -
*
* sqlserver-se
*
*
* -
*
* sqlserver-ex
*
*
* -
*
* sqlserver-web
*
*
*
*
* @return The DB parameter group family name. A DB parameter group can be associated with one and only one DB
* parameter group family, and can be applied only to a DB instance running a database engine and engine
* version compatible with that DB parameter group family.
*
* To list all of the available parameter group families for a DB engine, use the following command:
*
*
* aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>
*
*
* For example, to list all of the available parameter group families for the MySQL DB engine, use the
* following command:
*
*
* aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql
*
*
*
* The output contains duplicates.
*
*
*
* The following are the valid DB engine values:
*
*
* -
*
* aurora-mysql
*
*
* -
*
* aurora-postgresql
*
*
* -
*
* db2-ae
*
*
* -
*
* db2-se
*
*
* -
*
* mysql
*
*
* -
*
* oracle-ee
*
*
* -
*
* oracle-ee-cdb
*
*
* -
*
* oracle-se2
*
*
* -
*
* oracle-se2-cdb
*
*
* -
*
* postgres
*
*
* -
*
* sqlserver-ee
*
*
* -
*
* sqlserver-se
*
*
* -
*
* sqlserver-ex
*
*
* -
*
* sqlserver-web
*
*
*/
public final String dbParameterGroupFamily() {
return dbParameterGroupFamily;
}
/**
*
* The description for the DB parameter group.
*
*
* @return The description for the DB parameter group.
*/
public final String description() {
return description;
}
/**
* For responses, this returns true if the service returned a value for the Tags 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 hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* Tags to assign to the DB parameter 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 #hasTags} method.
*
*
* @return Tags to assign to the DB parameter group.
*/
public final List tags() {
return tags;
}
@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(dbParameterGroupFamily());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : 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 CreateDbParameterGroupRequest)) {
return false;
}
CreateDbParameterGroupRequest other = (CreateDbParameterGroupRequest) obj;
return Objects.equals(dbParameterGroupName(), other.dbParameterGroupName())
&& Objects.equals(dbParameterGroupFamily(), other.dbParameterGroupFamily())
&& Objects.equals(description(), other.description()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags());
}
/**
* 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("CreateDbParameterGroupRequest").add("DBParameterGroupName", dbParameterGroupName())
.add("DBParameterGroupFamily", dbParameterGroupFamily()).add("Description", description())
.add("Tags", hasTags() ? tags() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DBParameterGroupName":
return Optional.ofNullable(clazz.cast(dbParameterGroupName()));
case "DBParameterGroupFamily":
return Optional.ofNullable(clazz.cast(dbParameterGroupFamily()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateDbParameterGroupRequest) 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:
*
*
* -
*
* Must be 1 to 255 letters, numbers, or hyphens.
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Can't end with a hyphen or contain two consecutive hyphens
*
*
*
*
*
* This value is stored as a lowercase string.
*
*
*
* @param dbParameterGroupName
* The name of the DB parameter group.
*
* Constraints:
*
*
* -
*
* Must be 1 to 255 letters, numbers, or hyphens.
*
*
* -
*
* First character must be a letter
*
*
* -
*
* Can't end with a hyphen or contain two consecutive hyphens
*
*
*
*
*
* This value is stored as a lowercase string.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbParameterGroupName(String dbParameterGroupName);
/**
*
* The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter
* group family, and can be applied only to a DB instance running a database engine and engine version
* compatible with that DB parameter group family.
*
*
* To list all of the available parameter group families for a DB engine, use the following command:
*
*
* aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>
*
*
* For example, to list all of the available parameter group families for the MySQL DB engine, use the following
* command:
*
*
* aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql
*
*
*
* The output contains duplicates.
*
*
*
* The following are the valid DB engine values:
*
*
* -
*
* aurora-mysql
*
*
* -
*
* aurora-postgresql
*
*
* -
*
* db2-ae
*
*
* -
*
* db2-se
*
*
* -
*
* mysql
*
*
* -
*
* oracle-ee
*
*
* -
*
* oracle-ee-cdb
*
*
* -
*
* oracle-se2
*
*
* -
*
* oracle-se2-cdb
*
*
* -
*
* postgres
*
*
* -
*
* sqlserver-ee
*
*
* -
*
* sqlserver-se
*
*
* -
*
* sqlserver-ex
*
*
* -
*
* sqlserver-web
*
*
*
*
* @param dbParameterGroupFamily
* The DB parameter group family name. A DB parameter group can be associated with one and only one DB
* parameter group family, and can be applied only to a DB instance running a database engine and engine
* version compatible with that DB parameter group family.
*
* To list all of the available parameter group families for a DB engine, use the following command:
*
*
* aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>
*
*
* For example, to list all of the available parameter group families for the MySQL DB engine, use the
* following command:
*
*
* aws rds describe-db-engine-versions --query "DBEngineVersions[].DBParameterGroupFamily" --engine mysql
*
*
*
* The output contains duplicates.
*
*
*
* The following are the valid DB engine values:
*
*
* -
*
* aurora-mysql
*
*
* -
*
* aurora-postgresql
*
*
* -
*
* db2-ae
*
*
* -
*
* db2-se
*
*
* -
*
* mysql
*
*
* -
*
* oracle-ee
*
*
* -
*
* oracle-ee-cdb
*
*
* -
*
* oracle-se2
*
*
* -
*
* oracle-se2-cdb
*
*
* -
*
* postgres
*
*
* -
*
* sqlserver-ee
*
*
* -
*
* sqlserver-se
*
*
* -
*
* sqlserver-ex
*
*
* -
*
* sqlserver-web
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dbParameterGroupFamily(String dbParameterGroupFamily);
/**
*
* The description for the DB parameter group.
*
*
* @param description
* The description for the DB parameter group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* Tags to assign to the DB parameter group.
*
*
* @param tags
* Tags to assign to the DB parameter group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* Tags to assign to the DB parameter group.
*
*
* @param tags
* Tags to assign to the DB parameter group.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* Tags to assign to the DB parameter group.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.rds.model.Tag.Builder} avoiding the need to create one manually via
* {@link software.amazon.awssdk.services.rds.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes, {@link software.amazon.awssdk.services.rds.model.Tag.Builder#build()} is
* called immediately and its result is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on {@link software.amazon.awssdk.services.rds.model.Tag.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(java.util.Collection)
*/
Builder tags(Consumer... tags);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends RdsRequest.BuilderImpl implements Builder {
private String dbParameterGroupName;
private String dbParameterGroupFamily;
private String description;
private List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreateDbParameterGroupRequest model) {
super(model);
dbParameterGroupName(model.dbParameterGroupName);
dbParameterGroupFamily(model.dbParameterGroupFamily);
description(model.description);
tags(model.tags);
}
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 String getDbParameterGroupFamily() {
return dbParameterGroupFamily;
}
public final void setDbParameterGroupFamily(String dbParameterGroupFamily) {
this.dbParameterGroupFamily = dbParameterGroupFamily;
}
@Override
public final Builder dbParameterGroupFamily(String dbParameterGroupFamily) {
this.dbParameterGroupFamily = dbParameterGroupFamily;
return this;
}
public final String getDescription() {
return description;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
public final Builder description(String description) {
this.description = description;
return this;
}
public final List getTags() {
List result = TagListCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = TagListCopier.copyFromBuilder(tags);
}
@Override
public final Builder tags(Collection tags) {
this.tags = TagListCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.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 CreateDbParameterGroupRequest build() {
return new CreateDbParameterGroupRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}