Class PipeTargetRedshiftDataParameters

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

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.

See Also:

  • Method Details

    • secretManagerArn

      public final String secretManagerArn()

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

      Returns:
      The name or ARN of the secret that enables access to the database. Required when authenticating using 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.

    • 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()

      The SQL statement text to run.

      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:
      The SQL statement text to run.

    • toBuilder

      public PipeTargetRedshiftDataParameters.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<PipeTargetRedshiftDataParameters.Builder,PipeTargetRedshiftDataParameters>
      Returns:
      a builder for type T

    • builder

      public static PipeTargetRedshiftDataParameters.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PipeTargetRedshiftDataParameters.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)

    • 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.