Class RedshiftDataParameters
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<RedshiftDataParameters.Builder,
RedshiftDataParameters>
These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API ExecuteStatement based on EventBridge events.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
database()
The name of the database.final String
dbUser()
The database user name.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasSqls()
For responses, this returns true if the service returned a value for the Sqls property.final String
The name or ARN of the secret that enables access to the database.static Class
<? extends RedshiftDataParameters.Builder> final String
sql()
The SQL statement text to run.sqls()
One or more SQL statements to run.final String
The name of the SQL statement.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Boolean
Indicates whether to send an event back to EventBridge after the SQL statement runs.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The name of the database. Required when authenticating using temporary credentials.
- Returns:
- The name of the database. Required when authenticating using temporary credentials.
-
dbUser
The database user name. Required when authenticating using temporary credentials.
- Returns:
- The database user name. Required when authenticating using temporary credentials.
-
sql
The SQL statement text to run.
- Returns:
- The SQL statement text to run.
-
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
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 theisEmpty()
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
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.
-
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 interfaceToCopyableBuilder<RedshiftDataParameters.Builder,
RedshiftDataParameters> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-