org.openmetadata.schema.services.connections.database.PinotDBConnection 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.PasswordField;
/**
* PinotDBConnection
*
* PinotDB Database Connection Config
*
*/
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({
"type",
"scheme",
"username",
"password",
"hostPort",
"pinotControllerHost",
"database",
"connectionOptions",
"connectionArguments",
"supportsMetadataExtraction",
"supportsDBTExtraction",
"supportsProfiler",
"supportsQueryComment",
"sampleDataStorageConfig",
"supportsViewLineageExtraction"
})
@Generated("jsonschema2pojo")
public class PinotDBConnection {
/**
* Service type.
*
*/
@JsonProperty("type")
@JsonPropertyDescription("Service type.")
private PinotDBConnection.PinotDBType type = PinotDBConnection.PinotDBType.fromValue("PinotDB");
/**
* SQLAlchemy driver scheme options.
*
*/
@JsonProperty("scheme")
@JsonPropertyDescription("SQLAlchemy driver scheme options.")
private PinotDBConnection.PinotDBScheme scheme = PinotDBConnection.PinotDBScheme.fromValue("pinot");
/**
* Username
*
* username to connect to the PinotDB. This user should have privileges to read all the metadata in PinotDB.
*
*/
@JsonProperty("username")
@JsonPropertyDescription("username to connect to the PinotDB. This user should have privileges to read all the metadata in PinotDB.")
private String username;
/**
* Password
*
* password to connect to the PinotDB.
*
*/
@JsonProperty("password")
@JsonPropertyDescription("password to connect to the PinotDB.")
@PasswordField
private String password;
/**
* Pinot Broker Host and Port
*
* Host and port of the PinotDB Broker service.
* (Required)
*
*/
@JsonProperty("hostPort")
@JsonPropertyDescription("Host and port of the PinotDB Broker service.")
@NotNull
private String hostPort;
/**
* Pinot Controller Host and Port
*
* Pinot Controller Host and Port of the data source.
* (Required)
*
*/
@JsonProperty("pinotControllerHost")
@JsonPropertyDescription("Pinot Controller Host and Port of the data source.")
@NotNull
private String pinotControllerHost;
/**
* Database
*
* Database of the data source. This is optional parameter, if you would like to restrict the metadata reading to a single database. When left blank, OpenMetadata Ingestion attempts to scan all the databases.
*
*/
@JsonProperty("database")
@JsonPropertyDescription("Database of the data source. This is optional parameter, if you would like to restrict the metadata reading to a single database. When left blank, OpenMetadata Ingestion attempts to scan all the databases.")
private String database;
/**
* 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;
/**
* Supports View Lineage Extraction.
*
*/
@JsonProperty("supportsViewLineageExtraction")
@JsonPropertyDescription("Supports View Lineage Extraction.")
private Boolean supportsViewLineageExtraction = true;
/**
* Service type.
*
*/
@JsonProperty("type")
public PinotDBConnection.PinotDBType getType() {
return type;
}
/**
* Service type.
*
*/
@JsonProperty("type")
public void setType(PinotDBConnection.PinotDBType type) {
this.type = type;
}
public PinotDBConnection withType(PinotDBConnection.PinotDBType type) {
this.type = type;
return this;
}
/**
* SQLAlchemy driver scheme options.
*
*/
@JsonProperty("scheme")
public PinotDBConnection.PinotDBScheme getScheme() {
return scheme;
}
/**
* SQLAlchemy driver scheme options.
*
*/
@JsonProperty("scheme")
public void setScheme(PinotDBConnection.PinotDBScheme scheme) {
this.scheme = scheme;
}
public PinotDBConnection withScheme(PinotDBConnection.PinotDBScheme scheme) {
this.scheme = scheme;
return this;
}
/**
* Username
*
* username to connect to the PinotDB. This user should have privileges to read all the metadata in PinotDB.
*
*/
@JsonProperty("username")
public String getUsername() {
return username;
}
/**
* Username
*
* username to connect to the PinotDB. This user should have privileges to read all the metadata in PinotDB.
*
*/
@JsonProperty("username")
public void setUsername(String username) {
this.username = username;
}
public PinotDBConnection withUsername(String username) {
this.username = username;
return this;
}
/**
* Password
*
* password to connect to the PinotDB.
*
*/
@JsonProperty("password")
@PasswordField
public String getPassword() {
return password;
}
/**
* Password
*
* password to connect to the PinotDB.
*
*/
@JsonProperty("password")
@PasswordField
public void setPassword(String password) {
this.password = password;
}
public PinotDBConnection withPassword(String password) {
this.password = password;
return this;
}
/**
* Pinot Broker Host and Port
*
* Host and port of the PinotDB Broker service.
* (Required)
*
*/
@JsonProperty("hostPort")
public String getHostPort() {
return hostPort;
}
/**
* Pinot Broker Host and Port
*
* Host and port of the PinotDB Broker service.
* (Required)
*
*/
@JsonProperty("hostPort")
public void setHostPort(String hostPort) {
this.hostPort = hostPort;
}
public PinotDBConnection withHostPort(String hostPort) {
this.hostPort = hostPort;
return this;
}
/**
* Pinot Controller Host and Port
*
* Pinot Controller Host and Port of the data source.
* (Required)
*
*/
@JsonProperty("pinotControllerHost")
public String getPinotControllerHost() {
return pinotControllerHost;
}
/**
* Pinot Controller Host and Port
*
* Pinot Controller Host and Port of the data source.
* (Required)
*
*/
@JsonProperty("pinotControllerHost")
public void setPinotControllerHost(String pinotControllerHost) {
this.pinotControllerHost = pinotControllerHost;
}
public PinotDBConnection withPinotControllerHost(String pinotControllerHost) {
this.pinotControllerHost = pinotControllerHost;
return this;
}
/**
* Database
*
* Database of the data source. This is optional parameter, if you would like to restrict the metadata reading to a single database. When left blank, OpenMetadata Ingestion attempts to scan all the databases.
*
*/
@JsonProperty("database")
public String getDatabase() {
return database;
}
/**
* Database
*
* Database of the data source. This is optional parameter, if you would like to restrict the metadata reading to a single database. When left blank, OpenMetadata Ingestion attempts to scan all the databases.
*
*/
@JsonProperty("database")
public void setDatabase(String database) {
this.database = database;
}
public PinotDBConnection withDatabase(String database) {
this.database = database;
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 PinotDBConnection 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 PinotDBConnection 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 PinotDBConnection 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 PinotDBConnection 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 PinotDBConnection 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 PinotDBConnection 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 PinotDBConnection withSampleDataStorageConfig(SampleDataStorageConfig sampleDataStorageConfig) {
this.sampleDataStorageConfig = sampleDataStorageConfig;
return this;
}
/**
* Supports View Lineage Extraction.
*
*/
@JsonProperty("supportsViewLineageExtraction")
public Boolean getSupportsViewLineageExtraction() {
return supportsViewLineageExtraction;
}
/**
* Supports View Lineage Extraction.
*
*/
@JsonProperty("supportsViewLineageExtraction")
public void setSupportsViewLineageExtraction(Boolean supportsViewLineageExtraction) {
this.supportsViewLineageExtraction = supportsViewLineageExtraction;
}
public PinotDBConnection withSupportsViewLineageExtraction(Boolean supportsViewLineageExtraction) {
this.supportsViewLineageExtraction = supportsViewLineageExtraction;
return this;
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append(PinotDBConnection.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("password");
sb.append('=');
sb.append(((this.password == null)?"":this.password));
sb.append(',');
sb.append("hostPort");
sb.append('=');
sb.append(((this.hostPort == null)?"":this.hostPort));
sb.append(',');
sb.append("pinotControllerHost");
sb.append('=');
sb.append(((this.pinotControllerHost == null)?"":this.pinotControllerHost));
sb.append(',');
sb.append("database");
sb.append('=');
sb.append(((this.database == null)?"":this.database));
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(',');
sb.append("supportsViewLineageExtraction");
sb.append('=');
sb.append(((this.supportsViewLineageExtraction == null)?"":this.supportsViewLineageExtraction));
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.supportsMetadataExtraction == null)? 0 :this.supportsMetadataExtraction.hashCode()));
result = ((result* 31)+((this.pinotControllerHost == null)? 0 :this.pinotControllerHost.hashCode()));
result = ((result* 31)+((this.scheme == null)? 0 :this.scheme.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.password == null)? 0 :this.password.hashCode()));
result = ((result* 31)+((this.database == null)? 0 :this.database.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.supportsViewLineageExtraction == null)? 0 :this.supportsViewLineageExtraction.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 PinotDBConnection) == false) {
return false;
}
PinotDBConnection rhs = ((PinotDBConnection) other);
return ((((((((((((((((this.supportsMetadataExtraction == rhs.supportsMetadataExtraction)||((this.supportsMetadataExtraction!= null)&&this.supportsMetadataExtraction.equals(rhs.supportsMetadataExtraction)))&&((this.pinotControllerHost == rhs.pinotControllerHost)||((this.pinotControllerHost!= null)&&this.pinotControllerHost.equals(rhs.pinotControllerHost))))&&((this.scheme == rhs.scheme)||((this.scheme!= null)&&this.scheme.equals(rhs.scheme))))&&((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.password == rhs.password)||((this.password!= null)&&this.password.equals(rhs.password))))&&((this.database == rhs.database)||((this.database!= null)&&this.database.equals(rhs.database))))&&((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.supportsViewLineageExtraction == rhs.supportsViewLineageExtraction)||((this.supportsViewLineageExtraction!= null)&&this.supportsViewLineageExtraction.equals(rhs.supportsViewLineageExtraction))))&&((this.username == rhs.username)||((this.username!= null)&&this.username.equals(rhs.username))));
}
/**
* SQLAlchemy driver scheme options.
*
*/
@Generated("jsonschema2pojo")
public enum PinotDBScheme {
PINOT("pinot"),
PINOT_HTTP("pinot+http"),
PINOT_HTTPS("pinot+https");
private final String value;
private final static Map CONSTANTS = new HashMap();
static {
for (PinotDBConnection.PinotDBScheme c: values()) {
CONSTANTS.put(c.value, c);
}
}
PinotDBScheme(String value) {
this.value = value;
}
@Override
public String toString() {
return this.value;
}
@JsonValue
public String value() {
return this.value;
}
@JsonCreator
public static PinotDBConnection.PinotDBScheme fromValue(String value) {
PinotDBConnection.PinotDBScheme constant = CONSTANTS.get(value);
if (constant == null) {
throw new IllegalArgumentException(value);
} else {
return constant;
}
}
}
/**
* Service type.
*
*/
@Generated("jsonschema2pojo")
public enum PinotDBType {
PINOT_DB("PinotDB");
private final String value;
private final static Map CONSTANTS = new HashMap();
static {
for (PinotDBConnection.PinotDBType c: values()) {
CONSTANTS.put(c.value, c);
}
}
PinotDBType(String value) {
this.value = value;
}
@Override
public String toString() {
return this.value;
}
@JsonValue
public String value() {
return this.value;
}
@JsonCreator
public static PinotDBConnection.PinotDBType fromValue(String value) {
PinotDBConnection.PinotDBType constant = CONSTANTS.get(value);
if (constant == null) {
throw new IllegalArgumentException(value);
} else {
return constant;
}
}
}
}