com.amazonaws.services.pipes.model.PipeTargetRedshiftDataParameters Maven / Gradle / Ivy
Show all versions of aws-java-sdk-pipes 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.pipes.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift
* Data API BatchExecuteStatement.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class PipeTargetRedshiftDataParameters implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name or ARN of the secret that enables access to the database. Required when authenticating using Secrets
* Manager.
*
*/
private String secretManagerArn;
/**
*
* The name of the database. Required when authenticating using temporary credentials.
*
*/
private String database;
/**
*
* The database user name. Required when authenticating using temporary credentials.
*
*/
private String dbUser;
/**
*
* The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
*
*/
private String statementName;
/**
*
* Indicates whether to send an event back to EventBridge after the SQL statement runs.
*
*/
private Boolean withEvent;
/**
*
* The SQL statement text to run.
*
*/
private java.util.List sqls;
/**
*
* The name or ARN of the secret that enables access to the database. Required when authenticating using Secrets
* Manager.
*
*
* @param secretManagerArn
* The name or ARN of the secret that enables access to the database. Required when authenticating using
* Secrets Manager.
*/
public void setSecretManagerArn(String secretManagerArn) {
this.secretManagerArn = secretManagerArn;
}
/**
*
* The name or ARN of the secret that enables access to the database. Required when authenticating using Secrets
* Manager.
*
*
* @return The name or ARN of the secret that enables access to the database. Required when authenticating using
* Secrets Manager.
*/
public String getSecretManagerArn() {
return this.secretManagerArn;
}
/**
*
* The name or ARN of the secret that enables access to the database. Required when authenticating using Secrets
* Manager.
*
*
* @param secretManagerArn
* The name or ARN of the secret that enables access to the database. Required when authenticating using
* Secrets Manager.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PipeTargetRedshiftDataParameters withSecretManagerArn(String secretManagerArn) {
setSecretManagerArn(secretManagerArn);
return this;
}
/**
*
* The name of the database. Required when authenticating using temporary credentials.
*
*
* @param database
* The name of the database. Required when authenticating using temporary credentials.
*/
public void setDatabase(String database) {
this.database = database;
}
/**
*
* The name of the database. Required when authenticating using temporary credentials.
*
*
* @return The name of the database. Required when authenticating using temporary credentials.
*/
public String getDatabase() {
return this.database;
}
/**
*
* The name of the database. Required when authenticating using temporary credentials.
*
*
* @param database
* The name of the database. Required when authenticating using temporary credentials.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PipeTargetRedshiftDataParameters withDatabase(String database) {
setDatabase(database);
return this;
}
/**
*
* The database user name. Required when authenticating using temporary credentials.
*
*
* @param dbUser
* The database user name. Required when authenticating using temporary credentials.
*/
public void setDbUser(String dbUser) {
this.dbUser = dbUser;
}
/**
*
* The database user name. Required when authenticating using temporary credentials.
*
*
* @return The database user name. Required when authenticating using temporary credentials.
*/
public String getDbUser() {
return this.dbUser;
}
/**
*
* The database user name. Required when authenticating using temporary credentials.
*
*
* @param dbUser
* The database user name. Required when authenticating using temporary credentials.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PipeTargetRedshiftDataParameters withDbUser(String dbUser) {
setDbUser(dbUser);
return this;
}
/**
*
* The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
*
*
* @param statementName
* The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
*/
public void setStatementName(String statementName) {
this.statementName = statementName;
}
/**
*
* The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
*
*
* @return The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
*/
public String getStatementName() {
return this.statementName;
}
/**
*
* The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
*
*
* @param statementName
* The name of the SQL statement. You can name the SQL statement when you create it to identify the query.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PipeTargetRedshiftDataParameters withStatementName(String statementName) {
setStatementName(statementName);
return this;
}
/**
*
* Indicates whether to send an event back to EventBridge after the SQL statement runs.
*
*
* @param withEvent
* Indicates whether to send an event back to EventBridge after the SQL statement runs.
*/
public void setWithEvent(Boolean withEvent) {
this.withEvent = withEvent;
}
/**
*
* Indicates whether to send an event back to EventBridge after the SQL statement runs.
*
*
* @return Indicates whether to send an event back to EventBridge after the SQL statement runs.
*/
public Boolean getWithEvent() {
return this.withEvent;
}
/**
*
* Indicates whether to send an event back to EventBridge after the SQL statement runs.
*
*
* @param withEvent
* Indicates whether to send an event back to EventBridge after the SQL statement runs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PipeTargetRedshiftDataParameters withWithEvent(Boolean withEvent) {
setWithEvent(withEvent);
return this;
}
/**
*
* Indicates whether to send an event back to EventBridge after the SQL statement runs.
*
*
* @return Indicates whether to send an event back to EventBridge after the SQL statement runs.
*/
public Boolean isWithEvent() {
return this.withEvent;
}
/**
*
* The SQL statement text to run.
*
*
* @return The SQL statement text to run.
*/
public java.util.List getSqls() {
return sqls;
}
/**
*
* The SQL statement text to run.
*
*
* @param sqls
* The SQL statement text to run.
*/
public void setSqls(java.util.Collection sqls) {
if (sqls == null) {
this.sqls = null;
return;
}
this.sqls = new java.util.ArrayList(sqls);
}
/**
*
* The SQL statement text to run.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setSqls(java.util.Collection)} or {@link #withSqls(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param sqls
* The SQL statement text to run.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PipeTargetRedshiftDataParameters withSqls(String... sqls) {
if (this.sqls == null) {
setSqls(new java.util.ArrayList(sqls.length));
}
for (String ele : sqls) {
this.sqls.add(ele);
}
return this;
}
/**
*
* The SQL statement text to run.
*
*
* @param sqls
* The SQL statement text to run.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PipeTargetRedshiftDataParameters withSqls(java.util.Collection sqls) {
setSqls(sqls);
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 (getSecretManagerArn() != null)
sb.append("SecretManagerArn: ").append(getSecretManagerArn()).append(",");
if (getDatabase() != null)
sb.append("Database: ").append("***Sensitive Data Redacted***").append(",");
if (getDbUser() != null)
sb.append("DbUser: ").append("***Sensitive Data Redacted***").append(",");
if (getStatementName() != null)
sb.append("StatementName: ").append("***Sensitive Data Redacted***").append(",");
if (getWithEvent() != null)
sb.append("WithEvent: ").append(getWithEvent()).append(",");
if (getSqls() != null)
sb.append("Sqls: ").append("***Sensitive Data Redacted***");
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PipeTargetRedshiftDataParameters == false)
return false;
PipeTargetRedshiftDataParameters other = (PipeTargetRedshiftDataParameters) obj;
if (other.getSecretManagerArn() == null ^ this.getSecretManagerArn() == null)
return false;
if (other.getSecretManagerArn() != null && other.getSecretManagerArn().equals(this.getSecretManagerArn()) == false)
return false;
if (other.getDatabase() == null ^ this.getDatabase() == null)
return false;
if (other.getDatabase() != null && other.getDatabase().equals(this.getDatabase()) == false)
return false;
if (other.getDbUser() == null ^ this.getDbUser() == null)
return false;
if (other.getDbUser() != null && other.getDbUser().equals(this.getDbUser()) == false)
return false;
if (other.getStatementName() == null ^ this.getStatementName() == null)
return false;
if (other.getStatementName() != null && other.getStatementName().equals(this.getStatementName()) == false)
return false;
if (other.getWithEvent() == null ^ this.getWithEvent() == null)
return false;
if (other.getWithEvent() != null && other.getWithEvent().equals(this.getWithEvent()) == false)
return false;
if (other.getSqls() == null ^ this.getSqls() == null)
return false;
if (other.getSqls() != null && other.getSqls().equals(this.getSqls()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getSecretManagerArn() == null) ? 0 : getSecretManagerArn().hashCode());
hashCode = prime * hashCode + ((getDatabase() == null) ? 0 : getDatabase().hashCode());
hashCode = prime * hashCode + ((getDbUser() == null) ? 0 : getDbUser().hashCode());
hashCode = prime * hashCode + ((getStatementName() == null) ? 0 : getStatementName().hashCode());
hashCode = prime * hashCode + ((getWithEvent() == null) ? 0 : getWithEvent().hashCode());
hashCode = prime * hashCode + ((getSqls() == null) ? 0 : getSqls().hashCode());
return hashCode;
}
@Override
public PipeTargetRedshiftDataParameters clone() {
try {
return (PipeTargetRedshiftDataParameters) 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.pipes.model.transform.PipeTargetRedshiftDataParametersMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}