com.amazonaws.services.databasemigrationservice.model.MongoDbDataProviderSettings Maven / Gradle / Ivy
Show all versions of aws-java-sdk-dms Show documentation
/*
* Copyright 2019-2024 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 com.amazonaws.services.databasemigrationservice.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Provides information that defines a MongoDB data provider.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class MongoDbDataProviderSettings implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the MongoDB server.
*
*/
private String serverName;
/**
*
* The port value for the MongoDB data provider.
*
*/
private Integer port;
/**
*
* The database name on the MongoDB data provider.
*
*/
private String databaseName;
/**
*
* The SSL mode used to connect to the MongoDB data provider. The default value is none.
*
*/
private String sslMode;
/**
*
* The Amazon Resource Name (ARN) of the certificate used for SSL connection.
*
*/
private String certificateArn;
/**
*
* The authentication type for the database connection. Valid values are PASSWORD or NO.
*
*/
private String authType;
/**
*
* The MongoDB database name. This setting isn't used when AuthType is set to "no".
*
*
* The default is "admin".
*
*/
private String authSource;
/**
*
* The authentication method for connecting to the data provider. Valid values are DEFAULT, MONGODB_CR, or
* SCRAM_SHA_1.
*
*/
private String authMechanism;
/**
*
* The name of the MongoDB server.
*
*
* @param serverName
* The name of the MongoDB server.
*/
public void setServerName(String serverName) {
this.serverName = serverName;
}
/**
*
* The name of the MongoDB server.
*
*
* @return The name of the MongoDB server.
*/
public String getServerName() {
return this.serverName;
}
/**
*
* The name of the MongoDB server.
*
*
* @param serverName
* The name of the MongoDB server.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MongoDbDataProviderSettings withServerName(String serverName) {
setServerName(serverName);
return this;
}
/**
*
* The port value for the MongoDB data provider.
*
*
* @param port
* The port value for the MongoDB data provider.
*/
public void setPort(Integer port) {
this.port = port;
}
/**
*
* The port value for the MongoDB data provider.
*
*
* @return The port value for the MongoDB data provider.
*/
public Integer getPort() {
return this.port;
}
/**
*
* The port value for the MongoDB data provider.
*
*
* @param port
* The port value for the MongoDB data provider.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MongoDbDataProviderSettings withPort(Integer port) {
setPort(port);
return this;
}
/**
*
* The database name on the MongoDB data provider.
*
*
* @param databaseName
* The database name on the MongoDB data provider.
*/
public void setDatabaseName(String databaseName) {
this.databaseName = databaseName;
}
/**
*
* The database name on the MongoDB data provider.
*
*
* @return The database name on the MongoDB data provider.
*/
public String getDatabaseName() {
return this.databaseName;
}
/**
*
* The database name on the MongoDB data provider.
*
*
* @param databaseName
* The database name on the MongoDB data provider.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MongoDbDataProviderSettings withDatabaseName(String databaseName) {
setDatabaseName(databaseName);
return this;
}
/**
*
* The SSL mode used to connect to the MongoDB data provider. The default value is none.
*
*
* @param sslMode
* The SSL mode used to connect to the MongoDB data provider. The default value is none.
* @see DmsSslModeValue
*/
public void setSslMode(String sslMode) {
this.sslMode = sslMode;
}
/**
*
* The SSL mode used to connect to the MongoDB data provider. The default value is none.
*
*
* @return The SSL mode used to connect to the MongoDB data provider. The default value is none.
* @see DmsSslModeValue
*/
public String getSslMode() {
return this.sslMode;
}
/**
*
* The SSL mode used to connect to the MongoDB data provider. The default value is none.
*
*
* @param sslMode
* The SSL mode used to connect to the MongoDB data provider. The default value is none.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DmsSslModeValue
*/
public MongoDbDataProviderSettings withSslMode(String sslMode) {
setSslMode(sslMode);
return this;
}
/**
*
* The SSL mode used to connect to the MongoDB data provider. The default value is none.
*
*
* @param sslMode
* The SSL mode used to connect to the MongoDB data provider. The default value is none.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DmsSslModeValue
*/
public MongoDbDataProviderSettings withSslMode(DmsSslModeValue sslMode) {
this.sslMode = sslMode.toString();
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the certificate used for SSL connection.
*
*
* @param certificateArn
* The Amazon Resource Name (ARN) of the certificate used for SSL connection.
*/
public void setCertificateArn(String certificateArn) {
this.certificateArn = certificateArn;
}
/**
*
* The Amazon Resource Name (ARN) of the certificate used for SSL connection.
*
*
* @return The Amazon Resource Name (ARN) of the certificate used for SSL connection.
*/
public String getCertificateArn() {
return this.certificateArn;
}
/**
*
* The Amazon Resource Name (ARN) of the certificate used for SSL connection.
*
*
* @param certificateArn
* The Amazon Resource Name (ARN) of the certificate used for SSL connection.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MongoDbDataProviderSettings withCertificateArn(String certificateArn) {
setCertificateArn(certificateArn);
return this;
}
/**
*
* The authentication type for the database connection. Valid values are PASSWORD or NO.
*
*
* @param authType
* The authentication type for the database connection. Valid values are PASSWORD or NO.
* @see AuthTypeValue
*/
public void setAuthType(String authType) {
this.authType = authType;
}
/**
*
* The authentication type for the database connection. Valid values are PASSWORD or NO.
*
*
* @return The authentication type for the database connection. Valid values are PASSWORD or NO.
* @see AuthTypeValue
*/
public String getAuthType() {
return this.authType;
}
/**
*
* The authentication type for the database connection. Valid values are PASSWORD or NO.
*
*
* @param authType
* The authentication type for the database connection. Valid values are PASSWORD or NO.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AuthTypeValue
*/
public MongoDbDataProviderSettings withAuthType(String authType) {
setAuthType(authType);
return this;
}
/**
*
* The authentication type for the database connection. Valid values are PASSWORD or NO.
*
*
* @param authType
* The authentication type for the database connection. Valid values are PASSWORD or NO.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AuthTypeValue
*/
public MongoDbDataProviderSettings withAuthType(AuthTypeValue authType) {
this.authType = authType.toString();
return this;
}
/**
*
* The MongoDB database name. This setting isn't used when AuthType is set to "no".
*
*
* The default is "admin".
*
*
* @param authSource
* The MongoDB database name. This setting isn't used when AuthType is set to "no".
*
*
* The default is "admin".
*/
public void setAuthSource(String authSource) {
this.authSource = authSource;
}
/**
*
* The MongoDB database name. This setting isn't used when AuthType is set to "no".
*
*
* The default is "admin".
*
*
* @return The MongoDB database name. This setting isn't used when AuthType is set to "no"
* .
*
* The default is "admin".
*/
public String getAuthSource() {
return this.authSource;
}
/**
*
* The MongoDB database name. This setting isn't used when AuthType is set to "no".
*
*
* The default is "admin".
*
*
* @param authSource
* The MongoDB database name. This setting isn't used when AuthType is set to "no".
*
*
* The default is "admin".
* @return Returns a reference to this object so that method calls can be chained together.
*/
public MongoDbDataProviderSettings withAuthSource(String authSource) {
setAuthSource(authSource);
return this;
}
/**
*
* The authentication method for connecting to the data provider. Valid values are DEFAULT, MONGODB_CR, or
* SCRAM_SHA_1.
*
*
* @param authMechanism
* The authentication method for connecting to the data provider. Valid values are DEFAULT, MONGODB_CR, or
* SCRAM_SHA_1.
* @see AuthMechanismValue
*/
public void setAuthMechanism(String authMechanism) {
this.authMechanism = authMechanism;
}
/**
*
* The authentication method for connecting to the data provider. Valid values are DEFAULT, MONGODB_CR, or
* SCRAM_SHA_1.
*
*
* @return The authentication method for connecting to the data provider. Valid values are DEFAULT, MONGODB_CR, or
* SCRAM_SHA_1.
* @see AuthMechanismValue
*/
public String getAuthMechanism() {
return this.authMechanism;
}
/**
*
* The authentication method for connecting to the data provider. Valid values are DEFAULT, MONGODB_CR, or
* SCRAM_SHA_1.
*
*
* @param authMechanism
* The authentication method for connecting to the data provider. Valid values are DEFAULT, MONGODB_CR, or
* SCRAM_SHA_1.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AuthMechanismValue
*/
public MongoDbDataProviderSettings withAuthMechanism(String authMechanism) {
setAuthMechanism(authMechanism);
return this;
}
/**
*
* The authentication method for connecting to the data provider. Valid values are DEFAULT, MONGODB_CR, or
* SCRAM_SHA_1.
*
*
* @param authMechanism
* The authentication method for connecting to the data provider. Valid values are DEFAULT, MONGODB_CR, or
* SCRAM_SHA_1.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AuthMechanismValue
*/
public MongoDbDataProviderSettings withAuthMechanism(AuthMechanismValue authMechanism) {
this.authMechanism = authMechanism.toString();
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getServerName() != null)
sb.append("ServerName: ").append(getServerName()).append(",");
if (getPort() != null)
sb.append("Port: ").append(getPort()).append(",");
if (getDatabaseName() != null)
sb.append("DatabaseName: ").append(getDatabaseName()).append(",");
if (getSslMode() != null)
sb.append("SslMode: ").append(getSslMode()).append(",");
if (getCertificateArn() != null)
sb.append("CertificateArn: ").append(getCertificateArn()).append(",");
if (getAuthType() != null)
sb.append("AuthType: ").append(getAuthType()).append(",");
if (getAuthSource() != null)
sb.append("AuthSource: ").append(getAuthSource()).append(",");
if (getAuthMechanism() != null)
sb.append("AuthMechanism: ").append(getAuthMechanism());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof MongoDbDataProviderSettings == false)
return false;
MongoDbDataProviderSettings other = (MongoDbDataProviderSettings) obj;
if (other.getServerName() == null ^ this.getServerName() == null)
return false;
if (other.getServerName() != null && other.getServerName().equals(this.getServerName()) == false)
return false;
if (other.getPort() == null ^ this.getPort() == null)
return false;
if (other.getPort() != null && other.getPort().equals(this.getPort()) == false)
return false;
if (other.getDatabaseName() == null ^ this.getDatabaseName() == null)
return false;
if (other.getDatabaseName() != null && other.getDatabaseName().equals(this.getDatabaseName()) == false)
return false;
if (other.getSslMode() == null ^ this.getSslMode() == null)
return false;
if (other.getSslMode() != null && other.getSslMode().equals(this.getSslMode()) == false)
return false;
if (other.getCertificateArn() == null ^ this.getCertificateArn() == null)
return false;
if (other.getCertificateArn() != null && other.getCertificateArn().equals(this.getCertificateArn()) == false)
return false;
if (other.getAuthType() == null ^ this.getAuthType() == null)
return false;
if (other.getAuthType() != null && other.getAuthType().equals(this.getAuthType()) == false)
return false;
if (other.getAuthSource() == null ^ this.getAuthSource() == null)
return false;
if (other.getAuthSource() != null && other.getAuthSource().equals(this.getAuthSource()) == false)
return false;
if (other.getAuthMechanism() == null ^ this.getAuthMechanism() == null)
return false;
if (other.getAuthMechanism() != null && other.getAuthMechanism().equals(this.getAuthMechanism()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getServerName() == null) ? 0 : getServerName().hashCode());
hashCode = prime * hashCode + ((getPort() == null) ? 0 : getPort().hashCode());
hashCode = prime * hashCode + ((getDatabaseName() == null) ? 0 : getDatabaseName().hashCode());
hashCode = prime * hashCode + ((getSslMode() == null) ? 0 : getSslMode().hashCode());
hashCode = prime * hashCode + ((getCertificateArn() == null) ? 0 : getCertificateArn().hashCode());
hashCode = prime * hashCode + ((getAuthType() == null) ? 0 : getAuthType().hashCode());
hashCode = prime * hashCode + ((getAuthSource() == null) ? 0 : getAuthSource().hashCode());
hashCode = prime * hashCode + ((getAuthMechanism() == null) ? 0 : getAuthMechanism().hashCode());
return hashCode;
}
@Override
public MongoDbDataProviderSettings clone() {
try {
return (MongoDbDataProviderSettings) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.databasemigrationservice.model.transform.MongoDbDataProviderSettingsMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}