com.amazonaws.services.kendra.model.SqlConfiguration Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kendra 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.kendra.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Provides the configuration information to use a SQL database.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SqlConfiguration implements Serializable, Cloneable, StructuredPojo {
/**
*
* Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (") when
* making a database query.
*
*
* By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source
* configuration. It does not change the case of identifiers or enclose them in quotes.
*
*
* PostgreSQL internally converts uppercase characters to lower case characters in identifiers unless they are
* quoted. Choosing this option encloses identifiers in quotes so that PostgreSQL does not convert the character's
* case.
*
*
* For MySQL databases, you must enable the ansi_quotes option when you set this field to
* DOUBLE_QUOTES.
*
*/
private String queryIdentifiersEnclosingOption;
/**
*
* Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (") when
* making a database query.
*
*
* By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source
* configuration. It does not change the case of identifiers or enclose them in quotes.
*
*
* PostgreSQL internally converts uppercase characters to lower case characters in identifiers unless they are
* quoted. Choosing this option encloses identifiers in quotes so that PostgreSQL does not convert the character's
* case.
*
*
* For MySQL databases, you must enable the ansi_quotes option when you set this field to
* DOUBLE_QUOTES.
*
*
* @param queryIdentifiersEnclosingOption
* Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (")
* when making a database query.
*
* By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source
* configuration. It does not change the case of identifiers or enclose them in quotes.
*
*
* PostgreSQL internally converts uppercase characters to lower case characters in identifiers unless they
* are quoted. Choosing this option encloses identifiers in quotes so that PostgreSQL does not convert the
* character's case.
*
*
* For MySQL databases, you must enable the ansi_quotes option when you set this field to
* DOUBLE_QUOTES.
* @see QueryIdentifiersEnclosingOption
*/
public void setQueryIdentifiersEnclosingOption(String queryIdentifiersEnclosingOption) {
this.queryIdentifiersEnclosingOption = queryIdentifiersEnclosingOption;
}
/**
*
* Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (") when
* making a database query.
*
*
* By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source
* configuration. It does not change the case of identifiers or enclose them in quotes.
*
*
* PostgreSQL internally converts uppercase characters to lower case characters in identifiers unless they are
* quoted. Choosing this option encloses identifiers in quotes so that PostgreSQL does not convert the character's
* case.
*
*
* For MySQL databases, you must enable the ansi_quotes option when you set this field to
* DOUBLE_QUOTES.
*
*
* @return Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes
* (") when making a database query.
*
* By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source
* configuration. It does not change the case of identifiers or enclose them in quotes.
*
*
* PostgreSQL internally converts uppercase characters to lower case characters in identifiers unless they
* are quoted. Choosing this option encloses identifiers in quotes so that PostgreSQL does not convert the
* character's case.
*
*
* For MySQL databases, you must enable the ansi_quotes option when you set this field to
* DOUBLE_QUOTES.
* @see QueryIdentifiersEnclosingOption
*/
public String getQueryIdentifiersEnclosingOption() {
return this.queryIdentifiersEnclosingOption;
}
/**
*
* Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (") when
* making a database query.
*
*
* By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source
* configuration. It does not change the case of identifiers or enclose them in quotes.
*
*
* PostgreSQL internally converts uppercase characters to lower case characters in identifiers unless they are
* quoted. Choosing this option encloses identifiers in quotes so that PostgreSQL does not convert the character's
* case.
*
*
* For MySQL databases, you must enable the ansi_quotes option when you set this field to
* DOUBLE_QUOTES.
*
*
* @param queryIdentifiersEnclosingOption
* Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (")
* when making a database query.
*
* By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source
* configuration. It does not change the case of identifiers or enclose them in quotes.
*
*
* PostgreSQL internally converts uppercase characters to lower case characters in identifiers unless they
* are quoted. Choosing this option encloses identifiers in quotes so that PostgreSQL does not convert the
* character's case.
*
*
* For MySQL databases, you must enable the ansi_quotes option when you set this field to
* DOUBLE_QUOTES.
* @return Returns a reference to this object so that method calls can be chained together.
* @see QueryIdentifiersEnclosingOption
*/
public SqlConfiguration withQueryIdentifiersEnclosingOption(String queryIdentifiersEnclosingOption) {
setQueryIdentifiersEnclosingOption(queryIdentifiersEnclosingOption);
return this;
}
/**
*
* Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (") when
* making a database query.
*
*
* By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source
* configuration. It does not change the case of identifiers or enclose them in quotes.
*
*
* PostgreSQL internally converts uppercase characters to lower case characters in identifiers unless they are
* quoted. Choosing this option encloses identifiers in quotes so that PostgreSQL does not convert the character's
* case.
*
*
* For MySQL databases, you must enable the ansi_quotes option when you set this field to
* DOUBLE_QUOTES.
*
*
* @param queryIdentifiersEnclosingOption
* Determines whether Amazon Kendra encloses SQL identifiers for tables and column names in double quotes (")
* when making a database query.
*
* By default, Amazon Kendra passes SQL identifiers the way that they are entered into the data source
* configuration. It does not change the case of identifiers or enclose them in quotes.
*
*
* PostgreSQL internally converts uppercase characters to lower case characters in identifiers unless they
* are quoted. Choosing this option encloses identifiers in quotes so that PostgreSQL does not convert the
* character's case.
*
*
* For MySQL databases, you must enable the ansi_quotes option when you set this field to
* DOUBLE_QUOTES.
* @return Returns a reference to this object so that method calls can be chained together.
* @see QueryIdentifiersEnclosingOption
*/
public SqlConfiguration withQueryIdentifiersEnclosingOption(QueryIdentifiersEnclosingOption queryIdentifiersEnclosingOption) {
this.queryIdentifiersEnclosingOption = queryIdentifiersEnclosingOption.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 (getQueryIdentifiersEnclosingOption() != null)
sb.append("QueryIdentifiersEnclosingOption: ").append(getQueryIdentifiersEnclosingOption());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SqlConfiguration == false)
return false;
SqlConfiguration other = (SqlConfiguration) obj;
if (other.getQueryIdentifiersEnclosingOption() == null ^ this.getQueryIdentifiersEnclosingOption() == null)
return false;
if (other.getQueryIdentifiersEnclosingOption() != null
&& other.getQueryIdentifiersEnclosingOption().equals(this.getQueryIdentifiersEnclosingOption()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getQueryIdentifiersEnclosingOption() == null) ? 0 : getQueryIdentifiersEnclosingOption().hashCode());
return hashCode;
}
@Override
public SqlConfiguration clone() {
try {
return (SqlConfiguration) 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.kendra.model.transform.SqlConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}