Package software.amazon.awssdk.services.quicksight.model

Class DataSourceParameters

java.lang.Object
software.amazon.awssdk.services.quicksight.model.DataSourceParameters
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DataSourceParameters.Builder,DataSourceParameters>
@Generated("software.amazon.awssdk:codegen") public final class DataSourceParameters extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DataSourceParameters.Builder,DataSourceParameters>

The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

See Also:

  • Method Details

    • amazonElasticsearchParameters

      public final AmazonElasticsearchParameters amazonElasticsearchParameters()

      The parameters for OpenSearch.

      Returns:
      The parameters for OpenSearch.

    • athenaParameters

      public final AthenaParameters athenaParameters()

      The parameters for Amazon Athena.

      Returns:
      The parameters for Amazon Athena.

    • auroraParameters

      public final AuroraParameters auroraParameters()

      The parameters for Amazon Aurora MySQL.

      Returns:
      The parameters for Amazon Aurora MySQL.

    • auroraPostgreSqlParameters

      public final AuroraPostgreSqlParameters auroraPostgreSqlParameters()

      The parameters for Amazon Aurora.

      Returns:
      The parameters for Amazon Aurora.

    • awsIotAnalyticsParameters

      public final AwsIotAnalyticsParameters awsIotAnalyticsParameters()

      The parameters for IoT Analytics.

      Returns:
      The parameters for IoT Analytics.

    • jiraParameters

      public final JiraParameters jiraParameters()

      The parameters for Jira.

      Returns:
      The parameters for Jira.

    • mariaDbParameters

      public final MariaDbParameters mariaDbParameters()

      The parameters for MariaDB.

      Returns:
      The parameters for MariaDB.

    • mySqlParameters

      public final MySqlParameters mySqlParameters()

      The parameters for MySQL.

      Returns:
      The parameters for MySQL.

    • oracleParameters

      public final OracleParameters oracleParameters()

      The parameters for Oracle.

      Returns:
      The parameters for Oracle.

    • postgreSqlParameters

      public final PostgreSqlParameters postgreSqlParameters()

      The parameters for PostgreSQL.

      Returns:
      The parameters for PostgreSQL.

    • prestoParameters

      public final PrestoParameters prestoParameters()

      The parameters for Presto.

      Returns:
      The parameters for Presto.

    • rdsParameters

      public final RdsParameters rdsParameters()

      The parameters for Amazon RDS.

      Returns:
      The parameters for Amazon RDS.

    • redshiftParameters

      public final RedshiftParameters redshiftParameters()

      The parameters for Amazon Redshift.

      Returns:
      The parameters for Amazon Redshift.

    • s3Parameters

      public final S3Parameters s3Parameters()

      The parameters for S3.

      Returns:
      The parameters for S3.

    • serviceNowParameters

      public final ServiceNowParameters serviceNowParameters()

      The parameters for ServiceNow.

      Returns:
      The parameters for ServiceNow.

    • snowflakeParameters

      public final SnowflakeParameters snowflakeParameters()

      The parameters for Snowflake.

      Returns:
      The parameters for Snowflake.

    • sparkParameters

      public final SparkParameters sparkParameters()

      The parameters for Spark.

      Returns:
      The parameters for Spark.

    • sqlServerParameters

      public final SqlServerParameters sqlServerParameters()

      The parameters for SQL Server.

      Returns:
      The parameters for SQL Server.

    • teradataParameters

      public final TeradataParameters teradataParameters()

      The parameters for Teradata.

      Returns:
      The parameters for Teradata.

    • twitterParameters

      public final TwitterParameters twitterParameters()

      The parameters for Twitter.

      Returns:
      The parameters for Twitter.

    • amazonOpenSearchParameters

      public final AmazonOpenSearchParameters amazonOpenSearchParameters()

      The parameters for OpenSearch.

      Returns:
      The parameters for OpenSearch.

    • exasolParameters

      public final ExasolParameters exasolParameters()

      The parameters for Exasol.

      Returns:
      The parameters for Exasol.

    • databricksParameters

      public final DatabricksParameters databricksParameters()

      The parameters that are required to connect to a Databricks data source.

      Returns:
      The parameters that are required to connect to a Databricks data source.

    • starburstParameters

      public final StarburstParameters starburstParameters()

      The parameters that are required to connect to a Starburst data source.

      Returns:
      The parameters that are required to connect to a Starburst data source.

    • trinoParameters

      public final TrinoParameters trinoParameters()

      The parameters that are required to connect to a Trino data source.

      Returns:
      The parameters that are required to connect to a Trino data source.

    • bigQueryParameters

      public final BigQueryParameters bigQueryParameters()

      The parameters that are required to connect to a Google BigQuery data source.

      Returns:
      The parameters that are required to connect to a Google BigQuery data source.

    • toBuilder

      public DataSourceParameters.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DataSourceParameters.Builder,DataSourceParameters>
      Returns:
      a builder for type T

    • builder

      public static DataSourceParameters.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DataSourceParameters.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • fromAmazonElasticsearchParameters

      public static DataSourceParameters fromAmazonElasticsearchParameters(AmazonElasticsearchParameters amazonElasticsearchParameters)
      Create an instance of this class with amazonElasticsearchParameters() initialized to the given value.

      The parameters for OpenSearch.

      Parameters:
      amazonElasticsearchParameters - The parameters for OpenSearch.

    • fromAmazonElasticsearchParameters

      public static DataSourceParameters fromAmazonElasticsearchParameters(Consumer<AmazonElasticsearchParameters.Builder> amazonElasticsearchParameters)
      Create an instance of this class with amazonElasticsearchParameters() initialized to the given value.

      The parameters for OpenSearch.

      Parameters:
      amazonElasticsearchParameters - The parameters for OpenSearch.

    • fromAthenaParameters

      public static DataSourceParameters fromAthenaParameters(AthenaParameters athenaParameters)
      Create an instance of this class with athenaParameters() initialized to the given value.

      The parameters for Amazon Athena.

      Parameters:
      athenaParameters - The parameters for Amazon Athena.

    • fromAthenaParameters

      public static DataSourceParameters fromAthenaParameters(Consumer<AthenaParameters.Builder> athenaParameters)
      Create an instance of this class with athenaParameters() initialized to the given value.

      The parameters for Amazon Athena.

      Parameters:
      athenaParameters - The parameters for Amazon Athena.

    • fromAuroraParameters

      public static DataSourceParameters fromAuroraParameters(AuroraParameters auroraParameters)
      Create an instance of this class with auroraParameters() initialized to the given value.

      The parameters for Amazon Aurora MySQL.

      Parameters:
      auroraParameters - The parameters for Amazon Aurora MySQL.

    • fromAuroraParameters

      public static DataSourceParameters fromAuroraParameters(Consumer<AuroraParameters.Builder> auroraParameters)
      Create an instance of this class with auroraParameters() initialized to the given value.

      The parameters for Amazon Aurora MySQL.

      Parameters:
      auroraParameters - The parameters for Amazon Aurora MySQL.

    • fromAuroraPostgreSqlParameters

      public static DataSourceParameters fromAuroraPostgreSqlParameters(AuroraPostgreSqlParameters auroraPostgreSqlParameters)
      Create an instance of this class with auroraPostgreSqlParameters() initialized to the given value.

      The parameters for Amazon Aurora.

      Parameters:
      auroraPostgreSqlParameters - The parameters for Amazon Aurora.

    • fromAuroraPostgreSqlParameters

      public static DataSourceParameters fromAuroraPostgreSqlParameters(Consumer<AuroraPostgreSqlParameters.Builder> auroraPostgreSqlParameters)
      Create an instance of this class with auroraPostgreSqlParameters() initialized to the given value.

      The parameters for Amazon Aurora.

      Parameters:
      auroraPostgreSqlParameters - The parameters for Amazon Aurora.

    • fromAwsIotAnalyticsParameters

      public static DataSourceParameters fromAwsIotAnalyticsParameters(AwsIotAnalyticsParameters awsIotAnalyticsParameters)
      Create an instance of this class with awsIotAnalyticsParameters() initialized to the given value.

      The parameters for IoT Analytics.

      Parameters:
      awsIotAnalyticsParameters - The parameters for IoT Analytics.

    • fromAwsIotAnalyticsParameters

      public static DataSourceParameters fromAwsIotAnalyticsParameters(Consumer<AwsIotAnalyticsParameters.Builder> awsIotAnalyticsParameters)
      Create an instance of this class with awsIotAnalyticsParameters() initialized to the given value.

      The parameters for IoT Analytics.

      Parameters:
      awsIotAnalyticsParameters - The parameters for IoT Analytics.

    • fromJiraParameters

      public static DataSourceParameters fromJiraParameters(JiraParameters jiraParameters)
      Create an instance of this class with jiraParameters() initialized to the given value.

      The parameters for Jira.

      Parameters:
      jiraParameters - The parameters for Jira.

    • fromJiraParameters

      public static DataSourceParameters fromJiraParameters(Consumer<JiraParameters.Builder> jiraParameters)
      Create an instance of this class with jiraParameters() initialized to the given value.

      The parameters for Jira.

      Parameters:
      jiraParameters - The parameters for Jira.

    • fromMariaDbParameters

      public static DataSourceParameters fromMariaDbParameters(MariaDbParameters mariaDbParameters)
      Create an instance of this class with mariaDbParameters() initialized to the given value.

      The parameters for MariaDB.

      Parameters:
      mariaDbParameters - The parameters for MariaDB.

    • fromMariaDbParameters

      public static DataSourceParameters fromMariaDbParameters(Consumer<MariaDbParameters.Builder> mariaDbParameters)
      Create an instance of this class with mariaDbParameters() initialized to the given value.

      The parameters for MariaDB.

      Parameters:
      mariaDbParameters - The parameters for MariaDB.

    • fromMySqlParameters

      public static DataSourceParameters fromMySqlParameters(MySqlParameters mySqlParameters)
      Create an instance of this class with mySqlParameters() initialized to the given value.

      The parameters for MySQL.

      Parameters:
      mySqlParameters - The parameters for MySQL.

    • fromMySqlParameters

      public static DataSourceParameters fromMySqlParameters(Consumer<MySqlParameters.Builder> mySqlParameters)
      Create an instance of this class with mySqlParameters() initialized to the given value.

      The parameters for MySQL.

      Parameters:
      mySqlParameters - The parameters for MySQL.

    • fromOracleParameters

      public static DataSourceParameters fromOracleParameters(OracleParameters oracleParameters)
      Create an instance of this class with oracleParameters() initialized to the given value.

      The parameters for Oracle.

      Parameters:
      oracleParameters - The parameters for Oracle.

    • fromOracleParameters

      public static DataSourceParameters fromOracleParameters(Consumer<OracleParameters.Builder> oracleParameters)
      Create an instance of this class with oracleParameters() initialized to the given value.

      The parameters for Oracle.

      Parameters:
      oracleParameters - The parameters for Oracle.

    • fromPostgreSqlParameters

      public static DataSourceParameters fromPostgreSqlParameters(PostgreSqlParameters postgreSqlParameters)
      Create an instance of this class with postgreSqlParameters() initialized to the given value.

      The parameters for PostgreSQL.

      Parameters:
      postgreSqlParameters - The parameters for PostgreSQL.

    • fromPostgreSqlParameters

      public static DataSourceParameters fromPostgreSqlParameters(Consumer<PostgreSqlParameters.Builder> postgreSqlParameters)
      Create an instance of this class with postgreSqlParameters() initialized to the given value.

      The parameters for PostgreSQL.

      Parameters:
      postgreSqlParameters - The parameters for PostgreSQL.

    • fromPrestoParameters

      public static DataSourceParameters fromPrestoParameters(PrestoParameters prestoParameters)
      Create an instance of this class with prestoParameters() initialized to the given value.

      The parameters for Presto.

      Parameters:
      prestoParameters - The parameters for Presto.

    • fromPrestoParameters

      public static DataSourceParameters fromPrestoParameters(Consumer<PrestoParameters.Builder> prestoParameters)
      Create an instance of this class with prestoParameters() initialized to the given value.

      The parameters for Presto.

      Parameters:
      prestoParameters - The parameters for Presto.

    • fromRdsParameters

      public static DataSourceParameters fromRdsParameters(RdsParameters rdsParameters)
      Create an instance of this class with rdsParameters() initialized to the given value.

      The parameters for Amazon RDS.

      Parameters:
      rdsParameters - The parameters for Amazon RDS.

    • fromRdsParameters

      public static DataSourceParameters fromRdsParameters(Consumer<RdsParameters.Builder> rdsParameters)
      Create an instance of this class with rdsParameters() initialized to the given value.

      The parameters for Amazon RDS.

      Parameters:
      rdsParameters - The parameters for Amazon RDS.

    • fromRedshiftParameters

      public static DataSourceParameters fromRedshiftParameters(RedshiftParameters redshiftParameters)
      Create an instance of this class with redshiftParameters() initialized to the given value.

      The parameters for Amazon Redshift.

      Parameters:
      redshiftParameters - The parameters for Amazon Redshift.

    • fromRedshiftParameters

      public static DataSourceParameters fromRedshiftParameters(Consumer<RedshiftParameters.Builder> redshiftParameters)
      Create an instance of this class with redshiftParameters() initialized to the given value.

      The parameters for Amazon Redshift.

      Parameters:
      redshiftParameters - The parameters for Amazon Redshift.

    • fromS3Parameters

      public static DataSourceParameters fromS3Parameters(S3Parameters s3Parameters)
      Create an instance of this class with s3Parameters() initialized to the given value.

      The parameters for S3.

      Parameters:
      s3Parameters - The parameters for S3.

    • fromS3Parameters

      public static DataSourceParameters fromS3Parameters(Consumer<S3Parameters.Builder> s3Parameters)
      Create an instance of this class with s3Parameters() initialized to the given value.

      The parameters for S3.

      Parameters:
      s3Parameters - The parameters for S3.

    • fromServiceNowParameters

      public static DataSourceParameters fromServiceNowParameters(ServiceNowParameters serviceNowParameters)
      Create an instance of this class with serviceNowParameters() initialized to the given value.

      The parameters for ServiceNow.

      Parameters:
      serviceNowParameters - The parameters for ServiceNow.

    • fromServiceNowParameters

      public static DataSourceParameters fromServiceNowParameters(Consumer<ServiceNowParameters.Builder> serviceNowParameters)
      Create an instance of this class with serviceNowParameters() initialized to the given value.

      The parameters for ServiceNow.

      Parameters:
      serviceNowParameters - The parameters for ServiceNow.

    • fromSnowflakeParameters

      public static DataSourceParameters fromSnowflakeParameters(SnowflakeParameters snowflakeParameters)
      Create an instance of this class with snowflakeParameters() initialized to the given value.

      The parameters for Snowflake.

      Parameters:
      snowflakeParameters - The parameters for Snowflake.

    • fromSnowflakeParameters

      public static DataSourceParameters fromSnowflakeParameters(Consumer<SnowflakeParameters.Builder> snowflakeParameters)
      Create an instance of this class with snowflakeParameters() initialized to the given value.

      The parameters for Snowflake.

      Parameters:
      snowflakeParameters - The parameters for Snowflake.

    • fromSparkParameters

      public static DataSourceParameters fromSparkParameters(SparkParameters sparkParameters)
      Create an instance of this class with sparkParameters() initialized to the given value.

      The parameters for Spark.

      Parameters:
      sparkParameters - The parameters for Spark.

    • fromSparkParameters

      public static DataSourceParameters fromSparkParameters(Consumer<SparkParameters.Builder> sparkParameters)
      Create an instance of this class with sparkParameters() initialized to the given value.

      The parameters for Spark.

      Parameters:
      sparkParameters - The parameters for Spark.

    • fromSqlServerParameters

      public static DataSourceParameters fromSqlServerParameters(SqlServerParameters sqlServerParameters)
      Create an instance of this class with sqlServerParameters() initialized to the given value.

      The parameters for SQL Server.

      Parameters:
      sqlServerParameters - The parameters for SQL Server.

    • fromSqlServerParameters

      public static DataSourceParameters fromSqlServerParameters(Consumer<SqlServerParameters.Builder> sqlServerParameters)
      Create an instance of this class with sqlServerParameters() initialized to the given value.

      The parameters for SQL Server.

      Parameters:
      sqlServerParameters - The parameters for SQL Server.

    • fromTeradataParameters

      public static DataSourceParameters fromTeradataParameters(TeradataParameters teradataParameters)
      Create an instance of this class with teradataParameters() initialized to the given value.

      The parameters for Teradata.

      Parameters:
      teradataParameters - The parameters for Teradata.

    • fromTeradataParameters

      public static DataSourceParameters fromTeradataParameters(Consumer<TeradataParameters.Builder> teradataParameters)
      Create an instance of this class with teradataParameters() initialized to the given value.

      The parameters for Teradata.

      Parameters:
      teradataParameters - The parameters for Teradata.

    • fromTwitterParameters

      public static DataSourceParameters fromTwitterParameters(TwitterParameters twitterParameters)
      Create an instance of this class with twitterParameters() initialized to the given value.

      The parameters for Twitter.

      Parameters:
      twitterParameters - The parameters for Twitter.

    • fromTwitterParameters

      public static DataSourceParameters fromTwitterParameters(Consumer<TwitterParameters.Builder> twitterParameters)
      Create an instance of this class with twitterParameters() initialized to the given value.

      The parameters for Twitter.

      Parameters:
      twitterParameters - The parameters for Twitter.

    • fromAmazonOpenSearchParameters

      public static DataSourceParameters fromAmazonOpenSearchParameters(AmazonOpenSearchParameters amazonOpenSearchParameters)
      Create an instance of this class with amazonOpenSearchParameters() initialized to the given value.

      The parameters for OpenSearch.

      Parameters:
      amazonOpenSearchParameters - The parameters for OpenSearch.

    • fromAmazonOpenSearchParameters

      public static DataSourceParameters fromAmazonOpenSearchParameters(Consumer<AmazonOpenSearchParameters.Builder> amazonOpenSearchParameters)
      Create an instance of this class with amazonOpenSearchParameters() initialized to the given value.

      The parameters for OpenSearch.

      Parameters:
      amazonOpenSearchParameters - The parameters for OpenSearch.

    • fromExasolParameters

      public static DataSourceParameters fromExasolParameters(ExasolParameters exasolParameters)
      Create an instance of this class with exasolParameters() initialized to the given value.

      The parameters for Exasol.

      Parameters:
      exasolParameters - The parameters for Exasol.

    • fromExasolParameters

      public static DataSourceParameters fromExasolParameters(Consumer<ExasolParameters.Builder> exasolParameters)
      Create an instance of this class with exasolParameters() initialized to the given value.

      The parameters for Exasol.

      Parameters:
      exasolParameters - The parameters for Exasol.

    • fromDatabricksParameters

      public static DataSourceParameters fromDatabricksParameters(DatabricksParameters databricksParameters)
      Create an instance of this class with databricksParameters() initialized to the given value.

      The parameters that are required to connect to a Databricks data source.

      Parameters:
      databricksParameters - The parameters that are required to connect to a Databricks data source.

    • fromDatabricksParameters

      public static DataSourceParameters fromDatabricksParameters(Consumer<DatabricksParameters.Builder> databricksParameters)
      Create an instance of this class with databricksParameters() initialized to the given value.

      The parameters that are required to connect to a Databricks data source.

      Parameters:
      databricksParameters - The parameters that are required to connect to a Databricks data source.

    • fromStarburstParameters

      public static DataSourceParameters fromStarburstParameters(StarburstParameters starburstParameters)
      Create an instance of this class with starburstParameters() initialized to the given value.

      The parameters that are required to connect to a Starburst data source.

      Parameters:
      starburstParameters - The parameters that are required to connect to a Starburst data source.

    • fromStarburstParameters

      public static DataSourceParameters fromStarburstParameters(Consumer<StarburstParameters.Builder> starburstParameters)
      Create an instance of this class with starburstParameters() initialized to the given value.

      The parameters that are required to connect to a Starburst data source.

      Parameters:
      starburstParameters - The parameters that are required to connect to a Starburst data source.

    • fromTrinoParameters

      public static DataSourceParameters fromTrinoParameters(TrinoParameters trinoParameters)
      Create an instance of this class with trinoParameters() initialized to the given value.

      The parameters that are required to connect to a Trino data source.

      Parameters:
      trinoParameters - The parameters that are required to connect to a Trino data source.

    • fromTrinoParameters

      public static DataSourceParameters fromTrinoParameters(Consumer<TrinoParameters.Builder> trinoParameters)
      Create an instance of this class with trinoParameters() initialized to the given value.

      The parameters that are required to connect to a Trino data source.

      Parameters:
      trinoParameters - The parameters that are required to connect to a Trino data source.

    • fromBigQueryParameters

      public static DataSourceParameters fromBigQueryParameters(BigQueryParameters bigQueryParameters)
      Create an instance of this class with bigQueryParameters() initialized to the given value.

      The parameters that are required to connect to a Google BigQuery data source.

      Parameters:
      bigQueryParameters - The parameters that are required to connect to a Google BigQuery data source.

    • fromBigQueryParameters

      public static DataSourceParameters fromBigQueryParameters(Consumer<BigQueryParameters.Builder> bigQueryParameters)
      Create an instance of this class with bigQueryParameters() initialized to the given value.

      The parameters that are required to connect to a Google BigQuery data source.

      Parameters:
      bigQueryParameters - The parameters that are required to connect to a Google BigQuery data source.

    • type

      public DataSourceParameters.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be DataSourceParameters.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be DataSourceParameters.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.