org.mongodb.awscdk.resources.mongodbatlas.DataSource Maven / Gradle / Ivy
Show all versions of awscdk-resources-mongodbatlas Show documentation
package org.mongodb.awscdk.resources.mongodbatlas;
/**
*/
@javax.annotation.Generated(value = "jsii-pacmak/1.102.0 (build e354887)", date = "2024-09-27T09:31:28.868Z")
@software.amazon.jsii.Jsii(module = org.mongodb.awscdk.resources.mongodbatlas.$Module.class, fqn = "awscdk-resources-mongodbatlas.DataSource")
@software.amazon.jsii.Jsii.Proxy(DataSource.Jsii$Proxy.class)
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public interface DataSource extends software.amazon.jsii.JsiiSerializable {
/**
* Flag that validates the scheme in the specified URLs.
*
* If true, allows insecure HTTP scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If false, allows secure HTTPS scheme only.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.Boolean getAllowInsecure() {
return null;
}
/**
* Human-readable label that identifies the collection in the database.
*
* For creating a wildcard (*) collection, you must omit this parameter.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.String getCollection() {
return null;
}
/**
* Regex pattern to use for creating the wildcard (*) collection.
*
* To learn more about the regex syntax, see Go programming language.( https://pkg.go.dev/regexp ).
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.String getCollectionRegex() {
return null;
}
/**
* Human-readable label that identifies the database, which contains the collection in the cluster.
*
* You must omit this parameter to generate wildcard (*) collections for dynamically generated databases.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.String getDatabase() {
return null;
}
/**
* Regex pattern to use for creating the wildcard (*) collection.
*
* To learn more about the regex syntax, see Go programming language.( https://pkg.go.dev/regexp ).
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.String getDatabaseRegex() {
return null;
}
/**
* File format that MongoDB Cloud uses if it encounters a file without a file extension while searching storeName.Enum: ".avro" ".avro.bz2" ".avro.gz" ".bson" ".bson.bz2" ".bson.gz" ".bsonx" ".csv" ".csv.bz2" ".csv.gz" ".json" ".json.bz2" ".json.gz" ".orc" ".parquet" ".tsv" ".tsv.bz2" ".tsv.gz".
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.String getDefaultFormat() {
return null;
}
/**
* File path that controls how MongoDB Cloud searches for and parses files in the storeName before mapping them to a collection.Specify / to capture all files and folders from the prefix path.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.String getPath() {
return null;
}
/**
* Name for the field that includes the provenance of the documents in the results.
*
* MongoDB Cloud returns different fields in the results for each supported provider.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.String getProvenanceFieldName() {
return null;
}
/**
* Human-readable label that identifies the data store that MongoDB Cloud maps to the collection.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.lang.String getStoreName() {
return null;
}
/**
* URLs of the publicly accessible data files.
*
* You can't specify URLs that require authentication. Atlas Data Lake creates a partition for each URL. If empty or omitted, Data Lake uses the URLs from the store specified in the dataSources.storeName parameter.
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
default @org.jetbrains.annotations.Nullable java.util.List getUrls() {
return null;
}
/**
* @return a {@link Builder} of {@link DataSource}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
static Builder builder() {
return new Builder();
}
/**
* A builder for {@link DataSource}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public static final class Builder implements software.amazon.jsii.Builder {
java.lang.Boolean allowInsecure;
java.lang.String collection;
java.lang.String collectionRegex;
java.lang.String database;
java.lang.String databaseRegex;
java.lang.String defaultFormat;
java.lang.String path;
java.lang.String provenanceFieldName;
java.lang.String storeName;
java.util.List urls;
/**
* Sets the value of {@link DataSource#getAllowInsecure}
* @param allowInsecure Flag that validates the scheme in the specified URLs.
* If true, allows insecure HTTP scheme, doesn't verify the server's certificate chain and hostname, and accepts any certificate with any hostname presented by the server. If false, allows secure HTTPS scheme only.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder allowInsecure(java.lang.Boolean allowInsecure) {
this.allowInsecure = allowInsecure;
return this;
}
/**
* Sets the value of {@link DataSource#getCollection}
* @param collection Human-readable label that identifies the collection in the database.
* For creating a wildcard (*) collection, you must omit this parameter.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder collection(java.lang.String collection) {
this.collection = collection;
return this;
}
/**
* Sets the value of {@link DataSource#getCollectionRegex}
* @param collectionRegex Regex pattern to use for creating the wildcard (*) collection.
* To learn more about the regex syntax, see Go programming language.( https://pkg.go.dev/regexp ).
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder collectionRegex(java.lang.String collectionRegex) {
this.collectionRegex = collectionRegex;
return this;
}
/**
* Sets the value of {@link DataSource#getDatabase}
* @param database Human-readable label that identifies the database, which contains the collection in the cluster.
* You must omit this parameter to generate wildcard (*) collections for dynamically generated databases.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder database(java.lang.String database) {
this.database = database;
return this;
}
/**
* Sets the value of {@link DataSource#getDatabaseRegex}
* @param databaseRegex Regex pattern to use for creating the wildcard (*) collection.
* To learn more about the regex syntax, see Go programming language.( https://pkg.go.dev/regexp ).
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder databaseRegex(java.lang.String databaseRegex) {
this.databaseRegex = databaseRegex;
return this;
}
/**
* Sets the value of {@link DataSource#getDefaultFormat}
* @param defaultFormat File format that MongoDB Cloud uses if it encounters a file without a file extension while searching storeName.Enum: ".avro" ".avro.bz2" ".avro.gz" ".bson" ".bson.bz2" ".bson.gz" ".bsonx" ".csv" ".csv.bz2" ".csv.gz" ".json" ".json.bz2" ".json.gz" ".orc" ".parquet" ".tsv" ".tsv.bz2" ".tsv.gz".
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder defaultFormat(java.lang.String defaultFormat) {
this.defaultFormat = defaultFormat;
return this;
}
/**
* Sets the value of {@link DataSource#getPath}
* @param path File path that controls how MongoDB Cloud searches for and parses files in the storeName before mapping them to a collection.Specify / to capture all files and folders from the prefix path.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder path(java.lang.String path) {
this.path = path;
return this;
}
/**
* Sets the value of {@link DataSource#getProvenanceFieldName}
* @param provenanceFieldName Name for the field that includes the provenance of the documents in the results.
* MongoDB Cloud returns different fields in the results for each supported provider.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder provenanceFieldName(java.lang.String provenanceFieldName) {
this.provenanceFieldName = provenanceFieldName;
return this;
}
/**
* Sets the value of {@link DataSource#getStoreName}
* @param storeName Human-readable label that identifies the data store that MongoDB Cloud maps to the collection.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder storeName(java.lang.String storeName) {
this.storeName = storeName;
return this;
}
/**
* Sets the value of {@link DataSource#getUrls}
* @param urls URLs of the publicly accessible data files.
* You can't specify URLs that require authentication. Atlas Data Lake creates a partition for each URL. If empty or omitted, Data Lake uses the URLs from the store specified in the dataSources.storeName parameter.
* @return {@code this}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
public Builder urls(java.util.List urls) {
this.urls = urls;
return this;
}
/**
* Builds the configured instance.
* @return a new instance of {@link DataSource}
* @throws NullPointerException if any required attribute was not provided
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@Override
public DataSource build() {
return new Jsii$Proxy(this);
}
}
/**
* An implementation for {@link DataSource}
*/
@software.amazon.jsii.Stability(software.amazon.jsii.Stability.Level.Stable)
@software.amazon.jsii.Internal
final class Jsii$Proxy extends software.amazon.jsii.JsiiObject implements DataSource {
private final java.lang.Boolean allowInsecure;
private final java.lang.String collection;
private final java.lang.String collectionRegex;
private final java.lang.String database;
private final java.lang.String databaseRegex;
private final java.lang.String defaultFormat;
private final java.lang.String path;
private final java.lang.String provenanceFieldName;
private final java.lang.String storeName;
private final java.util.List urls;
/**
* Constructor that initializes the object based on values retrieved from the JsiiObject.
* @param objRef Reference to the JSII managed object.
*/
protected Jsii$Proxy(final software.amazon.jsii.JsiiObjectRef objRef) {
super(objRef);
this.allowInsecure = software.amazon.jsii.Kernel.get(this, "allowInsecure", software.amazon.jsii.NativeType.forClass(java.lang.Boolean.class));
this.collection = software.amazon.jsii.Kernel.get(this, "collection", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.collectionRegex = software.amazon.jsii.Kernel.get(this, "collectionRegex", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.database = software.amazon.jsii.Kernel.get(this, "database", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.databaseRegex = software.amazon.jsii.Kernel.get(this, "databaseRegex", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.defaultFormat = software.amazon.jsii.Kernel.get(this, "defaultFormat", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.path = software.amazon.jsii.Kernel.get(this, "path", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.provenanceFieldName = software.amazon.jsii.Kernel.get(this, "provenanceFieldName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.storeName = software.amazon.jsii.Kernel.get(this, "storeName", software.amazon.jsii.NativeType.forClass(java.lang.String.class));
this.urls = software.amazon.jsii.Kernel.get(this, "urls", software.amazon.jsii.NativeType.listOf(software.amazon.jsii.NativeType.forClass(java.lang.String.class)));
}
/**
* Constructor that initializes the object based on literal property values passed by the {@link Builder}.
*/
protected Jsii$Proxy(final Builder builder) {
super(software.amazon.jsii.JsiiObject.InitializationMode.JSII);
this.allowInsecure = builder.allowInsecure;
this.collection = builder.collection;
this.collectionRegex = builder.collectionRegex;
this.database = builder.database;
this.databaseRegex = builder.databaseRegex;
this.defaultFormat = builder.defaultFormat;
this.path = builder.path;
this.provenanceFieldName = builder.provenanceFieldName;
this.storeName = builder.storeName;
this.urls = builder.urls;
}
@Override
public final java.lang.Boolean getAllowInsecure() {
return this.allowInsecure;
}
@Override
public final java.lang.String getCollection() {
return this.collection;
}
@Override
public final java.lang.String getCollectionRegex() {
return this.collectionRegex;
}
@Override
public final java.lang.String getDatabase() {
return this.database;
}
@Override
public final java.lang.String getDatabaseRegex() {
return this.databaseRegex;
}
@Override
public final java.lang.String getDefaultFormat() {
return this.defaultFormat;
}
@Override
public final java.lang.String getPath() {
return this.path;
}
@Override
public final java.lang.String getProvenanceFieldName() {
return this.provenanceFieldName;
}
@Override
public final java.lang.String getStoreName() {
return this.storeName;
}
@Override
public final java.util.List getUrls() {
return this.urls;
}
@Override
@software.amazon.jsii.Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson() {
final com.fasterxml.jackson.databind.ObjectMapper om = software.amazon.jsii.JsiiObjectMapper.INSTANCE;
final com.fasterxml.jackson.databind.node.ObjectNode data = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
if (this.getAllowInsecure() != null) {
data.set("allowInsecure", om.valueToTree(this.getAllowInsecure()));
}
if (this.getCollection() != null) {
data.set("collection", om.valueToTree(this.getCollection()));
}
if (this.getCollectionRegex() != null) {
data.set("collectionRegex", om.valueToTree(this.getCollectionRegex()));
}
if (this.getDatabase() != null) {
data.set("database", om.valueToTree(this.getDatabase()));
}
if (this.getDatabaseRegex() != null) {
data.set("databaseRegex", om.valueToTree(this.getDatabaseRegex()));
}
if (this.getDefaultFormat() != null) {
data.set("defaultFormat", om.valueToTree(this.getDefaultFormat()));
}
if (this.getPath() != null) {
data.set("path", om.valueToTree(this.getPath()));
}
if (this.getProvenanceFieldName() != null) {
data.set("provenanceFieldName", om.valueToTree(this.getProvenanceFieldName()));
}
if (this.getStoreName() != null) {
data.set("storeName", om.valueToTree(this.getStoreName()));
}
if (this.getUrls() != null) {
data.set("urls", om.valueToTree(this.getUrls()));
}
final com.fasterxml.jackson.databind.node.ObjectNode struct = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
struct.set("fqn", om.valueToTree("awscdk-resources-mongodbatlas.DataSource"));
struct.set("data", data);
final com.fasterxml.jackson.databind.node.ObjectNode obj = com.fasterxml.jackson.databind.node.JsonNodeFactory.instance.objectNode();
obj.set("$jsii.struct", struct);
return obj;
}
@Override
public final boolean equals(final Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
DataSource.Jsii$Proxy that = (DataSource.Jsii$Proxy) o;
if (this.allowInsecure != null ? !this.allowInsecure.equals(that.allowInsecure) : that.allowInsecure != null) return false;
if (this.collection != null ? !this.collection.equals(that.collection) : that.collection != null) return false;
if (this.collectionRegex != null ? !this.collectionRegex.equals(that.collectionRegex) : that.collectionRegex != null) return false;
if (this.database != null ? !this.database.equals(that.database) : that.database != null) return false;
if (this.databaseRegex != null ? !this.databaseRegex.equals(that.databaseRegex) : that.databaseRegex != null) return false;
if (this.defaultFormat != null ? !this.defaultFormat.equals(that.defaultFormat) : that.defaultFormat != null) return false;
if (this.path != null ? !this.path.equals(that.path) : that.path != null) return false;
if (this.provenanceFieldName != null ? !this.provenanceFieldName.equals(that.provenanceFieldName) : that.provenanceFieldName != null) return false;
if (this.storeName != null ? !this.storeName.equals(that.storeName) : that.storeName != null) return false;
return this.urls != null ? this.urls.equals(that.urls) : that.urls == null;
}
@Override
public final int hashCode() {
int result = this.allowInsecure != null ? this.allowInsecure.hashCode() : 0;
result = 31 * result + (this.collection != null ? this.collection.hashCode() : 0);
result = 31 * result + (this.collectionRegex != null ? this.collectionRegex.hashCode() : 0);
result = 31 * result + (this.database != null ? this.database.hashCode() : 0);
result = 31 * result + (this.databaseRegex != null ? this.databaseRegex.hashCode() : 0);
result = 31 * result + (this.defaultFormat != null ? this.defaultFormat.hashCode() : 0);
result = 31 * result + (this.path != null ? this.path.hashCode() : 0);
result = 31 * result + (this.provenanceFieldName != null ? this.provenanceFieldName.hashCode() : 0);
result = 31 * result + (this.storeName != null ? this.storeName.hashCode() : 0);
result = 31 * result + (this.urls != null ? this.urls.hashCode() : 0);
return result;
}
}
}