software.amazon.awssdk.services.databasemigration.model.ModifyDataProviderRequest Maven / Gradle / Ivy
Show all versions of databasemigration 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.databasemigration.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 ModifyDataProviderRequest extends DatabaseMigrationRequest implements
ToCopyableBuilder {
private static final SdkField DATA_PROVIDER_IDENTIFIER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DataProviderIdentifier").getter(getter(ModifyDataProviderRequest::dataProviderIdentifier))
.setter(setter(Builder::dataProviderIdentifier))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DataProviderIdentifier").build())
.build();
private static final SdkField DATA_PROVIDER_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("DataProviderName").getter(getter(ModifyDataProviderRequest::dataProviderName))
.setter(setter(Builder::dataProviderName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DataProviderName").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(ModifyDataProviderRequest::description))
.setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField ENGINE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Engine")
.getter(getter(ModifyDataProviderRequest::engine)).setter(setter(Builder::engine))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Engine").build()).build();
private static final SdkField EXACT_SETTINGS_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("ExactSettings").getter(getter(ModifyDataProviderRequest::exactSettings))
.setter(setter(Builder::exactSettings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ExactSettings").build()).build();
private static final SdkField SETTINGS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("Settings")
.getter(getter(ModifyDataProviderRequest::settings)).setter(setter(Builder::settings))
.constructor(DataProviderSettings::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Settings").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(
DATA_PROVIDER_IDENTIFIER_FIELD, DATA_PROVIDER_NAME_FIELD, DESCRIPTION_FIELD, ENGINE_FIELD, EXACT_SETTINGS_FIELD,
SETTINGS_FIELD));
private final String dataProviderIdentifier;
private final String dataProviderName;
private final String description;
private final String engine;
private final Boolean exactSettings;
private final DataProviderSettings settings;
private ModifyDataProviderRequest(BuilderImpl builder) {
super(builder);
this.dataProviderIdentifier = builder.dataProviderIdentifier;
this.dataProviderName = builder.dataProviderName;
this.description = builder.description;
this.engine = builder.engine;
this.exactSettings = builder.exactSettings;
this.settings = builder.settings;
}
/**
*
* The identifier of the data provider. Identifiers must begin with a letter and must contain only ASCII letters,
* digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.
*
*
* @return The identifier of the data provider. Identifiers must begin with a letter and must contain only ASCII
* letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.
*/
public final String dataProviderIdentifier() {
return dataProviderIdentifier;
}
/**
*
* The name of the data provider.
*
*
* @return The name of the data provider.
*/
public final String dataProviderName() {
return dataProviderName;
}
/**
*
* A user-friendly description of the data provider.
*
*
* @return A user-friendly description of the data provider.
*/
public final String description() {
return description;
}
/**
*
* The type of database engine for the data provider. Valid values include "aurora",
* "aurora-postgresql", "mysql", "oracle", "postgres",
* "sqlserver", redshift, mariadb, mongodb, and
* docdb. A value of "aurora" represents Amazon Aurora MySQL-Compatible Edition.
*
*
* @return The type of database engine for the data provider. Valid values include "aurora",
* "aurora-postgresql", "mysql", "oracle", "postgres",
* "sqlserver", redshift, mariadb, mongodb, and
* docdb. A value of "aurora" represents Amazon Aurora MySQL-Compatible Edition.
*/
public final String engine() {
return engine;
}
/**
*
* If this attribute is Y, the current call to ModifyDataProvider replaces all existing data provider
* settings with the exact settings that you specify in this call. If this attribute is N, the current call to
* ModifyDataProvider does two things:
*
*
* -
*
* It replaces any data provider settings that already exist with new values, for settings with the same names.
*
*
* -
*
* It creates new data provider settings that you specify in the call, for settings with different names.
*
*
*
*
* @return If this attribute is Y, the current call to ModifyDataProvider replaces all existing data
* provider settings with the exact settings that you specify in this call. If this attribute is N, the
* current call to ModifyDataProvider does two things:
*
* -
*
* It replaces any data provider settings that already exist with new values, for settings with the same
* names.
*
*
* -
*
* It creates new data provider settings that you specify in the call, for settings with different names.
*
*
*/
public final Boolean exactSettings() {
return exactSettings;
}
/**
*
* The settings in JSON format for a data provider.
*
*
* @return The settings in JSON format for a data provider.
*/
public final DataProviderSettings settings() {
return settings;
}
@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(dataProviderIdentifier());
hashCode = 31 * hashCode + Objects.hashCode(dataProviderName());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(engine());
hashCode = 31 * hashCode + Objects.hashCode(exactSettings());
hashCode = 31 * hashCode + Objects.hashCode(settings());
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 ModifyDataProviderRequest)) {
return false;
}
ModifyDataProviderRequest other = (ModifyDataProviderRequest) obj;
return Objects.equals(dataProviderIdentifier(), other.dataProviderIdentifier())
&& Objects.equals(dataProviderName(), other.dataProviderName())
&& Objects.equals(description(), other.description()) && Objects.equals(engine(), other.engine())
&& Objects.equals(exactSettings(), other.exactSettings()) && Objects.equals(settings(), other.settings());
}
/**
* 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("ModifyDataProviderRequest").add("DataProviderIdentifier", dataProviderIdentifier())
.add("DataProviderName", dataProviderName()).add("Description", description()).add("Engine", engine())
.add("ExactSettings", exactSettings()).add("Settings", settings()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "DataProviderIdentifier":
return Optional.ofNullable(clazz.cast(dataProviderIdentifier()));
case "DataProviderName":
return Optional.ofNullable(clazz.cast(dataProviderName()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "Engine":
return Optional.ofNullable(clazz.cast(engine()));
case "ExactSettings":
return Optional.ofNullable(clazz.cast(exactSettings()));
case "Settings":
return Optional.ofNullable(clazz.cast(settings()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ModifyDataProviderRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends DatabaseMigrationRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* The identifier of the data provider. Identifiers must begin with a letter and must contain only ASCII
* letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.
*
*
* @param dataProviderIdentifier
* The identifier of the data provider. Identifiers must begin with a letter and must contain only ASCII
* letters, digits, and hyphens. They can't end with a hyphen, or contain two consecutive hyphens.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dataProviderIdentifier(String dataProviderIdentifier);
/**
*
* The name of the data provider.
*
*
* @param dataProviderName
* The name of the data provider.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dataProviderName(String dataProviderName);
/**
*
* A user-friendly description of the data provider.
*
*
* @param description
* A user-friendly description of the data provider.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* The type of database engine for the data provider. Valid values include "aurora",
* "aurora-postgresql", "mysql", "oracle", "postgres",
* "sqlserver", redshift, mariadb, mongodb, and
* docdb. A value of "aurora" represents Amazon Aurora MySQL-Compatible Edition.
*
*
* @param engine
* The type of database engine for the data provider. Valid values include "aurora",
* "aurora-postgresql", "mysql", "oracle", "postgres"
* , "sqlserver", redshift, mariadb, mongodb, and
* docdb. A value of "aurora" represents Amazon Aurora MySQL-Compatible
* Edition.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder engine(String engine);
/**
*
* If this attribute is Y, the current call to ModifyDataProvider replaces all existing data
* provider settings with the exact settings that you specify in this call. If this attribute is N, the current
* call to ModifyDataProvider does two things:
*
*
* -
*
* It replaces any data provider settings that already exist with new values, for settings with the same names.
*
*
* -
*
* It creates new data provider settings that you specify in the call, for settings with different names.
*
*
*
*
* @param exactSettings
* If this attribute is Y, the current call to ModifyDataProvider replaces all existing data
* provider settings with the exact settings that you specify in this call. If this attribute is N, the
* current call to ModifyDataProvider does two things:
*
* -
*
* It replaces any data provider settings that already exist with new values, for settings with the same
* names.
*
*
* -
*
* It creates new data provider settings that you specify in the call, for settings with different names.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder exactSettings(Boolean exactSettings);
/**
*
* The settings in JSON format for a data provider.
*
*
* @param settings
* The settings in JSON format for a data provider.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder settings(DataProviderSettings settings);
/**
*
* The settings in JSON format for a data provider.
*
* This is a convenience method that creates an instance of the {@link DataProviderSettings.Builder} avoiding
* the need to create one manually via {@link DataProviderSettings#builder()}.
*
*
* When the {@link Consumer} completes, {@link DataProviderSettings.Builder#build()} is called immediately and
* its result is passed to {@link #settings(DataProviderSettings)}.
*
* @param settings
* a consumer that will call methods on {@link DataProviderSettings.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #settings(DataProviderSettings)
*/
default Builder settings(Consumer settings) {
return settings(DataProviderSettings.builder().applyMutation(settings).build());
}
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends DatabaseMigrationRequest.BuilderImpl implements Builder {
private String dataProviderIdentifier;
private String dataProviderName;
private String description;
private String engine;
private Boolean exactSettings;
private DataProviderSettings settings;
private BuilderImpl() {
}
private BuilderImpl(ModifyDataProviderRequest model) {
super(model);
dataProviderIdentifier(model.dataProviderIdentifier);
dataProviderName(model.dataProviderName);
description(model.description);
engine(model.engine);
exactSettings(model.exactSettings);
settings(model.settings);
}
public final String getDataProviderIdentifier() {
return dataProviderIdentifier;
}
public final void setDataProviderIdentifier(String dataProviderIdentifier) {
this.dataProviderIdentifier = dataProviderIdentifier;
}
@Override
public final Builder dataProviderIdentifier(String dataProviderIdentifier) {
this.dataProviderIdentifier = dataProviderIdentifier;
return this;
}
public final String getDataProviderName() {
return dataProviderName;
}
public final void setDataProviderName(String dataProviderName) {
this.dataProviderName = dataProviderName;
}
@Override
public final Builder dataProviderName(String dataProviderName) {
this.dataProviderName = dataProviderName;
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 String getEngine() {
return engine;
}
public final void setEngine(String engine) {
this.engine = engine;
}
@Override
public final Builder engine(String engine) {
this.engine = engine;
return this;
}
public final Boolean getExactSettings() {
return exactSettings;
}
public final void setExactSettings(Boolean exactSettings) {
this.exactSettings = exactSettings;
}
@Override
public final Builder exactSettings(Boolean exactSettings) {
this.exactSettings = exactSettings;
return this;
}
public final DataProviderSettings.Builder getSettings() {
return settings != null ? settings.toBuilder() : null;
}
public final void setSettings(DataProviderSettings.BuilderImpl settings) {
this.settings = settings != null ? settings.build() : null;
}
@Override
@Transient
public final Builder settings(DataProviderSettings settings) {
this.settings = settings;
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 ModifyDataProviderRequest build() {
return new ModifyDataProviderRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}