org.openmetadata.schema.services.connections.database.MysqlConnection Maven / Gradle / Ivy
package org.openmetadata.schema.services.connections.database;
import java.util.HashMap;
import java.util.Map;
import javax.annotation.processing.Generated;
import javax.validation.Valid;
import javax.validation.constraints.NotNull;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyDescription;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import com.fasterxml.jackson.annotation.JsonValue;
import org.openmetadata.annotations.MaskedField;
/**
* MysqlConnection
*
* Mysql Database Connection Config
*
*/
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({
"type",
"scheme",
"username",
"authType",
"hostPort",
"databaseName",
"databaseSchema",
"sslConfig",
"connectionOptions",
"connectionArguments",
"supportsMetadataExtraction",
"supportsDBTExtraction",
"supportsProfiler",
"supportsQueryComment",
"sampleDataStorageConfig"
})
@Generated("jsonschema2pojo")
public class MysqlConnection {
/**
* Service type.
*
*/
@JsonProperty("type")
@JsonPropertyDescription("Service type.")
private MysqlConnection.MySQLType type = MysqlConnection.MySQLType.fromValue("Mysql");
/**
* SQLAlchemy driver scheme options.
*
*/
@JsonProperty("scheme")
@JsonPropertyDescription("SQLAlchemy driver scheme options.")
private MysqlConnection.MySQLScheme scheme = MysqlConnection.MySQLScheme.fromValue("mysql+pymysql");
/**
* Username
*
* Username to connect to MySQL. This user should have privileges to read all the metadata in Mysql.
* (Required)
*
*/
@JsonProperty("username")
@JsonPropertyDescription("Username to connect to MySQL. This user should have privileges to read all the metadata in Mysql.")
@NotNull
private String username;
/**
* Auth Configuration Type
*
* Choose Auth Config Type.
*
*/
@JsonProperty("authType")
@JsonPropertyDescription("Choose Auth Config Type.")
private Object authType;
/**
* Host and Port
*
* Host and port of the MySQL service.
* (Required)
*
*/
@JsonProperty("hostPort")
@JsonPropertyDescription("Host and port of the MySQL service.")
@NotNull
private String hostPort;
/**
* Database Name
*
* Optional name to give to the database in OpenMetadata. If left blank, we will use default as the database name.
*
*/
@JsonProperty("databaseName")
@JsonPropertyDescription("Optional name to give to the database in OpenMetadata. If left blank, we will use default as the database name.")
private String databaseName;
/**
* Database Schema
*
* Database Schema of the data source. This is optional parameter, if you would like to restrict the metadata reading to a single schema. When left blank, OpenMetadata Ingestion attempts to scan all the schemas.
*
*/
@JsonProperty("databaseSchema")
@JsonPropertyDescription("Database Schema of the data source. This is optional parameter, if you would like to restrict the metadata reading to a single schema. When left blank, OpenMetadata Ingestion attempts to scan all the schemas.")
private String databaseSchema;
/**
* SSL Config
*
* Client SSL configuration
*
*/
@JsonProperty("sslConfig")
@JsonPropertyDescription("Client SSL configuration")
@MaskedField
private Object sslConfig;
/**
* Additional connection options to build the URL that can be sent to service during the connection.
*
*/
@JsonProperty("connectionOptions")
@JsonPropertyDescription("Additional connection options to build the URL that can be sent to service during the connection.")
@Valid
private ConnectionOptions connectionOptions;
/**
* Additional connection arguments such as security or protocol configs that can be sent to service during connection.
*
*/
@JsonProperty("connectionArguments")
@JsonPropertyDescription("Additional connection arguments such as security or protocol configs that can be sent to service during connection.")
@Valid
private ConnectionArguments connectionArguments;
/**
* Supports Metadata Extraction.
*
*/
@JsonProperty("supportsMetadataExtraction")
@JsonPropertyDescription("Supports Metadata Extraction.")
private Boolean supportsMetadataExtraction = true;
/**
* Supports DBT Extraction.
*
*/
@JsonProperty("supportsDBTExtraction")
@JsonPropertyDescription("Supports DBT Extraction.")
private Boolean supportsDBTExtraction = true;
/**
* Supports Profiler
*
*/
@JsonProperty("supportsProfiler")
@JsonPropertyDescription("Supports Profiler")
private Boolean supportsProfiler = true;
/**
* For Database Services using SQLAlchemy, True to enable running a comment for all queries run from OpenMetadata.
*
*/
@JsonProperty("supportsQueryComment")
@JsonPropertyDescription("For Database Services using SQLAlchemy, True to enable running a comment for all queries run from OpenMetadata.")
private Boolean supportsQueryComment = true;
/**
* Storage config to store sample data
*
*/
@JsonProperty("sampleDataStorageConfig")
@JsonPropertyDescription("Storage config to store sample data")
@Valid
private SampleDataStorageConfig sampleDataStorageConfig;
/**
* Service type.
*
*/
@JsonProperty("type")
public MysqlConnection.MySQLType getType() {
return type;
}
/**
* Service type.
*
*/
@JsonProperty("type")
public void setType(MysqlConnection.MySQLType type) {
this.type = type;
}
public MysqlConnection withType(MysqlConnection.MySQLType type) {
this.type = type;
return this;
}
/**
* SQLAlchemy driver scheme options.
*
*/
@JsonProperty("scheme")
public MysqlConnection.MySQLScheme getScheme() {
return scheme;
}
/**
* SQLAlchemy driver scheme options.
*
*/
@JsonProperty("scheme")
public void setScheme(MysqlConnection.MySQLScheme scheme) {
this.scheme = scheme;
}
public MysqlConnection withScheme(MysqlConnection.MySQLScheme scheme) {
this.scheme = scheme;
return this;
}
/**
* Username
*
* Username to connect to MySQL. This user should have privileges to read all the metadata in Mysql.
* (Required)
*
*/
@JsonProperty("username")
public String getUsername() {
return username;
}
/**
* Username
*
* Username to connect to MySQL. This user should have privileges to read all the metadata in Mysql.
* (Required)
*
*/
@JsonProperty("username")
public void setUsername(String username) {
this.username = username;
}
public MysqlConnection withUsername(String username) {
this.username = username;
return this;
}
/**
* Auth Configuration Type
*
* Choose Auth Config Type.
*
*/
@JsonProperty("authType")
public Object getAuthType() {
return authType;
}
/**
* Auth Configuration Type
*
* Choose Auth Config Type.
*
*/
@JsonProperty("authType")
public void setAuthType(Object authType) {
this.authType = authType;
}
public MysqlConnection withAuthType(Object authType) {
this.authType = authType;
return this;
}
/**
* Host and Port
*
* Host and port of the MySQL service.
* (Required)
*
*/
@JsonProperty("hostPort")
public String getHostPort() {
return hostPort;
}
/**
* Host and Port
*
* Host and port of the MySQL service.
* (Required)
*
*/
@JsonProperty("hostPort")
public void setHostPort(String hostPort) {
this.hostPort = hostPort;
}
public MysqlConnection withHostPort(String hostPort) {
this.hostPort = hostPort;
return this;
}
/**
* Database Name
*
* Optional name to give to the database in OpenMetadata. If left blank, we will use default as the database name.
*
*/
@JsonProperty("databaseName")
public String getDatabaseName() {
return databaseName;
}
/**
* Database Name
*
* Optional name to give to the database in OpenMetadata. If left blank, we will use default as the database name.
*
*/
@JsonProperty("databaseName")
public void setDatabaseName(String databaseName) {
this.databaseName = databaseName;
}
public MysqlConnection withDatabaseName(String databaseName) {
this.databaseName = databaseName;
return this;
}
/**
* Database Schema
*
* Database Schema of the data source. This is optional parameter, if you would like to restrict the metadata reading to a single schema. When left blank, OpenMetadata Ingestion attempts to scan all the schemas.
*
*/
@JsonProperty("databaseSchema")
public String getDatabaseSchema() {
return databaseSchema;
}
/**
* Database Schema
*
* Database Schema of the data source. This is optional parameter, if you would like to restrict the metadata reading to a single schema. When left blank, OpenMetadata Ingestion attempts to scan all the schemas.
*
*/
@JsonProperty("databaseSchema")
public void setDatabaseSchema(String databaseSchema) {
this.databaseSchema = databaseSchema;
}
public MysqlConnection withDatabaseSchema(String databaseSchema) {
this.databaseSchema = databaseSchema;
return this;
}
/**
* SSL Config
*
* Client SSL configuration
*
*/
@JsonProperty("sslConfig")
@MaskedField
public Object getSslConfig() {
return sslConfig;
}
/**
* SSL Config
*
* Client SSL configuration
*
*/
@JsonProperty("sslConfig")
@MaskedField
public void setSslConfig(Object sslConfig) {
this.sslConfig = sslConfig;
}
public MysqlConnection withSslConfig(Object sslConfig) {
this.sslConfig = sslConfig;
return this;
}
/**
* Additional connection options to build the URL that can be sent to service during the connection.
*
*/
@JsonProperty("connectionOptions")
public ConnectionOptions getConnectionOptions() {
return connectionOptions;
}
/**
* Additional connection options to build the URL that can be sent to service during the connection.
*
*/
@JsonProperty("connectionOptions")
public void setConnectionOptions(ConnectionOptions connectionOptions) {
this.connectionOptions = connectionOptions;
}
public MysqlConnection withConnectionOptions(ConnectionOptions connectionOptions) {
this.connectionOptions = connectionOptions;
return this;
}
/**
* Additional connection arguments such as security or protocol configs that can be sent to service during connection.
*
*/
@JsonProperty("connectionArguments")
public ConnectionArguments getConnectionArguments() {
return connectionArguments;
}
/**
* Additional connection arguments such as security or protocol configs that can be sent to service during connection.
*
*/
@JsonProperty("connectionArguments")
public void setConnectionArguments(ConnectionArguments connectionArguments) {
this.connectionArguments = connectionArguments;
}
public MysqlConnection withConnectionArguments(ConnectionArguments connectionArguments) {
this.connectionArguments = connectionArguments;
return this;
}
/**
* Supports Metadata Extraction.
*
*/
@JsonProperty("supportsMetadataExtraction")
public Boolean getSupportsMetadataExtraction() {
return supportsMetadataExtraction;
}
/**
* Supports Metadata Extraction.
*
*/
@JsonProperty("supportsMetadataExtraction")
public void setSupportsMetadataExtraction(Boolean supportsMetadataExtraction) {
this.supportsMetadataExtraction = supportsMetadataExtraction;
}
public MysqlConnection withSupportsMetadataExtraction(Boolean supportsMetadataExtraction) {
this.supportsMetadataExtraction = supportsMetadataExtraction;
return this;
}
/**
* Supports DBT Extraction.
*
*/
@JsonProperty("supportsDBTExtraction")
public Boolean getSupportsDBTExtraction() {
return supportsDBTExtraction;
}
/**
* Supports DBT Extraction.
*
*/
@JsonProperty("supportsDBTExtraction")
public void setSupportsDBTExtraction(Boolean supportsDBTExtraction) {
this.supportsDBTExtraction = supportsDBTExtraction;
}
public MysqlConnection withSupportsDBTExtraction(Boolean supportsDBTExtraction) {
this.supportsDBTExtraction = supportsDBTExtraction;
return this;
}
/**
* Supports Profiler
*
*/
@JsonProperty("supportsProfiler")
public Boolean getSupportsProfiler() {
return supportsProfiler;
}
/**
* Supports Profiler
*
*/
@JsonProperty("supportsProfiler")
public void setSupportsProfiler(Boolean supportsProfiler) {
this.supportsProfiler = supportsProfiler;
}
public MysqlConnection withSupportsProfiler(Boolean supportsProfiler) {
this.supportsProfiler = supportsProfiler;
return this;
}
/**
* For Database Services using SQLAlchemy, True to enable running a comment for all queries run from OpenMetadata.
*
*/
@JsonProperty("supportsQueryComment")
public Boolean getSupportsQueryComment() {
return supportsQueryComment;
}
/**
* For Database Services using SQLAlchemy, True to enable running a comment for all queries run from OpenMetadata.
*
*/
@JsonProperty("supportsQueryComment")
public void setSupportsQueryComment(Boolean supportsQueryComment) {
this.supportsQueryComment = supportsQueryComment;
}
public MysqlConnection withSupportsQueryComment(Boolean supportsQueryComment) {
this.supportsQueryComment = supportsQueryComment;
return this;
}
/**
* Storage config to store sample data
*
*/
@JsonProperty("sampleDataStorageConfig")
public SampleDataStorageConfig getSampleDataStorageConfig() {
return sampleDataStorageConfig;
}
/**
* Storage config to store sample data
*
*/
@JsonProperty("sampleDataStorageConfig")
public void setSampleDataStorageConfig(SampleDataStorageConfig sampleDataStorageConfig) {
this.sampleDataStorageConfig = sampleDataStorageConfig;
}
public MysqlConnection withSampleDataStorageConfig(SampleDataStorageConfig sampleDataStorageConfig) {
this.sampleDataStorageConfig = sampleDataStorageConfig;
return this;
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append(MysqlConnection.class.getName()).append('@').append(Integer.toHexString(System.identityHashCode(this))).append('[');
sb.append("type");
sb.append('=');
sb.append(((this.type == null)?"":this.type));
sb.append(',');
sb.append("scheme");
sb.append('=');
sb.append(((this.scheme == null)?"":this.scheme));
sb.append(',');
sb.append("username");
sb.append('=');
sb.append(((this.username == null)?"":this.username));
sb.append(',');
sb.append("authType");
sb.append('=');
sb.append(((this.authType == null)?"":this.authType));
sb.append(',');
sb.append("hostPort");
sb.append('=');
sb.append(((this.hostPort == null)?"":this.hostPort));
sb.append(',');
sb.append("databaseName");
sb.append('=');
sb.append(((this.databaseName == null)?"":this.databaseName));
sb.append(',');
sb.append("databaseSchema");
sb.append('=');
sb.append(((this.databaseSchema == null)?"":this.databaseSchema));
sb.append(',');
sb.append("sslConfig");
sb.append('=');
sb.append(((this.sslConfig == null)?"":this.sslConfig));
sb.append(',');
sb.append("connectionOptions");
sb.append('=');
sb.append(((this.connectionOptions == null)?"":this.connectionOptions));
sb.append(',');
sb.append("connectionArguments");
sb.append('=');
sb.append(((this.connectionArguments == null)?"":this.connectionArguments));
sb.append(',');
sb.append("supportsMetadataExtraction");
sb.append('=');
sb.append(((this.supportsMetadataExtraction == null)?"":this.supportsMetadataExtraction));
sb.append(',');
sb.append("supportsDBTExtraction");
sb.append('=');
sb.append(((this.supportsDBTExtraction == null)?"":this.supportsDBTExtraction));
sb.append(',');
sb.append("supportsProfiler");
sb.append('=');
sb.append(((this.supportsProfiler == null)?"":this.supportsProfiler));
sb.append(',');
sb.append("supportsQueryComment");
sb.append('=');
sb.append(((this.supportsQueryComment == null)?"":this.supportsQueryComment));
sb.append(',');
sb.append("sampleDataStorageConfig");
sb.append('=');
sb.append(((this.sampleDataStorageConfig == null)?"":this.sampleDataStorageConfig));
sb.append(',');
if (sb.charAt((sb.length()- 1)) == ',') {
sb.setCharAt((sb.length()- 1), ']');
} else {
sb.append(']');
}
return sb.toString();
}
@Override
public int hashCode() {
int result = 1;
result = ((result* 31)+((this.databaseSchema == null)? 0 :this.databaseSchema.hashCode()));
result = ((result* 31)+((this.supportsMetadataExtraction == null)? 0 :this.supportsMetadataExtraction.hashCode()));
result = ((result* 31)+((this.scheme == null)? 0 :this.scheme.hashCode()));
result = ((result* 31)+((this.databaseName == null)? 0 :this.databaseName.hashCode()));
result = ((result* 31)+((this.sslConfig == null)? 0 :this.sslConfig.hashCode()));
result = ((result* 31)+((this.supportsProfiler == null)? 0 :this.supportsProfiler.hashCode()));
result = ((result* 31)+((this.sampleDataStorageConfig == null)? 0 :this.sampleDataStorageConfig.hashCode()));
result = ((result* 31)+((this.type == null)? 0 :this.type.hashCode()));
result = ((result* 31)+((this.supportsDBTExtraction == null)? 0 :this.supportsDBTExtraction.hashCode()));
result = ((result* 31)+((this.connectionArguments == null)? 0 :this.connectionArguments.hashCode()));
result = ((result* 31)+((this.connectionOptions == null)? 0 :this.connectionOptions.hashCode()));
result = ((result* 31)+((this.hostPort == null)? 0 :this.hostPort.hashCode()));
result = ((result* 31)+((this.supportsQueryComment == null)? 0 :this.supportsQueryComment.hashCode()));
result = ((result* 31)+((this.authType == null)? 0 :this.authType.hashCode()));
result = ((result* 31)+((this.username == null)? 0 :this.username.hashCode()));
return result;
}
@Override
public boolean equals(Object other) {
if (other == this) {
return true;
}
if ((other instanceof MysqlConnection) == false) {
return false;
}
MysqlConnection rhs = ((MysqlConnection) other);
return ((((((((((((((((this.databaseSchema == rhs.databaseSchema)||((this.databaseSchema!= null)&&this.databaseSchema.equals(rhs.databaseSchema)))&&((this.supportsMetadataExtraction == rhs.supportsMetadataExtraction)||((this.supportsMetadataExtraction!= null)&&this.supportsMetadataExtraction.equals(rhs.supportsMetadataExtraction))))&&((this.scheme == rhs.scheme)||((this.scheme!= null)&&this.scheme.equals(rhs.scheme))))&&((this.databaseName == rhs.databaseName)||((this.databaseName!= null)&&this.databaseName.equals(rhs.databaseName))))&&((this.sslConfig == rhs.sslConfig)||((this.sslConfig!= null)&&this.sslConfig.equals(rhs.sslConfig))))&&((this.supportsProfiler == rhs.supportsProfiler)||((this.supportsProfiler!= null)&&this.supportsProfiler.equals(rhs.supportsProfiler))))&&((this.sampleDataStorageConfig == rhs.sampleDataStorageConfig)||((this.sampleDataStorageConfig!= null)&&this.sampleDataStorageConfig.equals(rhs.sampleDataStorageConfig))))&&((this.type == rhs.type)||((this.type!= null)&&this.type.equals(rhs.type))))&&((this.supportsDBTExtraction == rhs.supportsDBTExtraction)||((this.supportsDBTExtraction!= null)&&this.supportsDBTExtraction.equals(rhs.supportsDBTExtraction))))&&((this.connectionArguments == rhs.connectionArguments)||((this.connectionArguments!= null)&&this.connectionArguments.equals(rhs.connectionArguments))))&&((this.connectionOptions == rhs.connectionOptions)||((this.connectionOptions!= null)&&this.connectionOptions.equals(rhs.connectionOptions))))&&((this.hostPort == rhs.hostPort)||((this.hostPort!= null)&&this.hostPort.equals(rhs.hostPort))))&&((this.supportsQueryComment == rhs.supportsQueryComment)||((this.supportsQueryComment!= null)&&this.supportsQueryComment.equals(rhs.supportsQueryComment))))&&((this.authType == rhs.authType)||((this.authType!= null)&&this.authType.equals(rhs.authType))))&&((this.username == rhs.username)||((this.username!= null)&&this.username.equals(rhs.username))));
}
/**
* SQLAlchemy driver scheme options.
*
*/
@Generated("jsonschema2pojo")
public enum MySQLScheme {
MYSQL_PYMYSQL("mysql+pymysql");
private final String value;
private final static Map CONSTANTS = new HashMap();
static {
for (MysqlConnection.MySQLScheme c: values()) {
CONSTANTS.put(c.value, c);
}
}
MySQLScheme(String value) {
this.value = value;
}
@Override
public String toString() {
return this.value;
}
@JsonValue
public String value() {
return this.value;
}
@JsonCreator
public static MysqlConnection.MySQLScheme fromValue(String value) {
MysqlConnection.MySQLScheme constant = CONSTANTS.get(value);
if (constant == null) {
throw new IllegalArgumentException(value);
} else {
return constant;
}
}
}
/**
* Service type.
*
*/
@Generated("jsonschema2pojo")
public enum MySQLType {
MYSQL("Mysql");
private final String value;
private final static Map CONSTANTS = new HashMap();
static {
for (MysqlConnection.MySQLType c: values()) {
CONSTANTS.put(c.value, c);
}
}
MySQLType(String value) {
this.value = value;
}
@Override
public String toString() {
return this.value;
}
@JsonValue
public String value() {
return this.value;
}
@JsonCreator
public static MysqlConnection.MySQLType fromValue(String value) {
MysqlConnection.MySQLType constant = CONSTANTS.get(value);
if (constant == null) {
throw new IllegalArgumentException(value);
} else {
return constant;
}
}
}
}