Class RedshiftDataParameters

    • Method Detail

      • secretManagerArn

        public final String secretManagerArn()

        The name or ARN of the secret that enables access to the database. Required when authenticating using Amazon Web Services Secrets Manager.

        Returns:
        The name or ARN of the secret that enables access to the database. Required when authenticating using Amazon Web Services Secrets Manager.
      • database

        public final String database()

        The name of the database. Required when authenticating using temporary credentials.

        Returns:
        The name of the database. Required when authenticating using temporary credentials.
      • dbUser

        public final String dbUser()

        The database user name. Required when authenticating using temporary credentials.

        Returns:
        The database user name. Required when authenticating using temporary credentials.
      • sql

        public final String sql()

        The SQL statement text to run.

        Returns:
        The SQL statement text to run.
      • statementName

        public final String statementName()

        The name of the SQL statement. You can name the SQL statement when you create it to identify the query.

        Returns:
        The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
      • withEvent

        public final Boolean withEvent()

        Indicates whether to send an event back to EventBridge after the SQL statement runs.

        Returns:
        Indicates whether to send an event back to EventBridge after the SQL statement runs.
      • hasSqls

        public final boolean hasSqls()
        For responses, this returns true if the service returned a value for the Sqls property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • sqls

        public final List<String> sqls()

        One or more SQL statements to run. The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSqls() method.

        Returns:
        One or more SQL statements to run. The SQL statements are run as a single transaction. They run serially in the order of the array. Subsequent SQL statements don't start until the previous statement in the array completes. If any SQL statement fails, then because they are run as one transaction, all work is rolled back.
      • hashCode

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

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)