com.amazonaws.services.appflow.model.CustomConnectorDestinationProperties Maven / Gradle / Ivy
Show all versions of aws-java-sdk-appflow 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.appflow.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The properties that are applied when the custom connector is being used as a destination.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CustomConnectorDestinationProperties implements Serializable, Cloneable, StructuredPojo {
/**
*
* The entity specified in the custom connector as a destination in the flow.
*
*/
private String entityName;
/**
*
* The settings that determine how Amazon AppFlow handles an error when placing data in the custom connector as
* destination.
*
*/
private ErrorHandlingConfig errorHandlingConfig;
/**
*
* Specifies the type of write operation to be performed in the custom connector when it's used as destination.
*
*/
private String writeOperationType;
/**
*
* The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update, delete,
* or upsert.
*
*/
private java.util.List idFieldNames;
/**
*
* The custom properties that are specific to the connector when it's used as a destination in the flow.
*
*/
private java.util.Map customProperties;
/**
*
* The entity specified in the custom connector as a destination in the flow.
*
*
* @param entityName
* The entity specified in the custom connector as a destination in the flow.
*/
public void setEntityName(String entityName) {
this.entityName = entityName;
}
/**
*
* The entity specified in the custom connector as a destination in the flow.
*
*
* @return The entity specified in the custom connector as a destination in the flow.
*/
public String getEntityName() {
return this.entityName;
}
/**
*
* The entity specified in the custom connector as a destination in the flow.
*
*
* @param entityName
* The entity specified in the custom connector as a destination in the flow.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CustomConnectorDestinationProperties withEntityName(String entityName) {
setEntityName(entityName);
return this;
}
/**
*
* The settings that determine how Amazon AppFlow handles an error when placing data in the custom connector as
* destination.
*
*
* @param errorHandlingConfig
* The settings that determine how Amazon AppFlow handles an error when placing data in the custom connector
* as destination.
*/
public void setErrorHandlingConfig(ErrorHandlingConfig errorHandlingConfig) {
this.errorHandlingConfig = errorHandlingConfig;
}
/**
*
* The settings that determine how Amazon AppFlow handles an error when placing data in the custom connector as
* destination.
*
*
* @return The settings that determine how Amazon AppFlow handles an error when placing data in the custom connector
* as destination.
*/
public ErrorHandlingConfig getErrorHandlingConfig() {
return this.errorHandlingConfig;
}
/**
*
* The settings that determine how Amazon AppFlow handles an error when placing data in the custom connector as
* destination.
*
*
* @param errorHandlingConfig
* The settings that determine how Amazon AppFlow handles an error when placing data in the custom connector
* as destination.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CustomConnectorDestinationProperties withErrorHandlingConfig(ErrorHandlingConfig errorHandlingConfig) {
setErrorHandlingConfig(errorHandlingConfig);
return this;
}
/**
*
* Specifies the type of write operation to be performed in the custom connector when it's used as destination.
*
*
* @param writeOperationType
* Specifies the type of write operation to be performed in the custom connector when it's used as
* destination.
* @see WriteOperationType
*/
public void setWriteOperationType(String writeOperationType) {
this.writeOperationType = writeOperationType;
}
/**
*
* Specifies the type of write operation to be performed in the custom connector when it's used as destination.
*
*
* @return Specifies the type of write operation to be performed in the custom connector when it's used as
* destination.
* @see WriteOperationType
*/
public String getWriteOperationType() {
return this.writeOperationType;
}
/**
*
* Specifies the type of write operation to be performed in the custom connector when it's used as destination.
*
*
* @param writeOperationType
* Specifies the type of write operation to be performed in the custom connector when it's used as
* destination.
* @return Returns a reference to this object so that method calls can be chained together.
* @see WriteOperationType
*/
public CustomConnectorDestinationProperties withWriteOperationType(String writeOperationType) {
setWriteOperationType(writeOperationType);
return this;
}
/**
*
* Specifies the type of write operation to be performed in the custom connector when it's used as destination.
*
*
* @param writeOperationType
* Specifies the type of write operation to be performed in the custom connector when it's used as
* destination.
* @return Returns a reference to this object so that method calls can be chained together.
* @see WriteOperationType
*/
public CustomConnectorDestinationProperties withWriteOperationType(WriteOperationType writeOperationType) {
this.writeOperationType = writeOperationType.toString();
return this;
}
/**
*
* The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update, delete,
* or upsert.
*
*
* @return The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update,
* delete, or upsert.
*/
public java.util.List getIdFieldNames() {
return idFieldNames;
}
/**
*
* The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update, delete,
* or upsert.
*
*
* @param idFieldNames
* The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update,
* delete, or upsert.
*/
public void setIdFieldNames(java.util.Collection idFieldNames) {
if (idFieldNames == null) {
this.idFieldNames = null;
return;
}
this.idFieldNames = new java.util.ArrayList(idFieldNames);
}
/**
*
* The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update, delete,
* or upsert.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setIdFieldNames(java.util.Collection)} or {@link #withIdFieldNames(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param idFieldNames
* The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update,
* delete, or upsert.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CustomConnectorDestinationProperties withIdFieldNames(String... idFieldNames) {
if (this.idFieldNames == null) {
setIdFieldNames(new java.util.ArrayList(idFieldNames.length));
}
for (String ele : idFieldNames) {
this.idFieldNames.add(ele);
}
return this;
}
/**
*
* The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update, delete,
* or upsert.
*
*
* @param idFieldNames
* The name of the field that Amazon AppFlow uses as an ID when performing a write operation such as update,
* delete, or upsert.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CustomConnectorDestinationProperties withIdFieldNames(java.util.Collection idFieldNames) {
setIdFieldNames(idFieldNames);
return this;
}
/**
*
* The custom properties that are specific to the connector when it's used as a destination in the flow.
*
*
* @return The custom properties that are specific to the connector when it's used as a destination in the flow.
*/
public java.util.Map getCustomProperties() {
return customProperties;
}
/**
*
* The custom properties that are specific to the connector when it's used as a destination in the flow.
*
*
* @param customProperties
* The custom properties that are specific to the connector when it's used as a destination in the flow.
*/
public void setCustomProperties(java.util.Map customProperties) {
this.customProperties = customProperties;
}
/**
*
* The custom properties that are specific to the connector when it's used as a destination in the flow.
*
*
* @param customProperties
* The custom properties that are specific to the connector when it's used as a destination in the flow.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CustomConnectorDestinationProperties withCustomProperties(java.util.Map customProperties) {
setCustomProperties(customProperties);
return this;
}
/**
* Add a single CustomProperties entry
*
* @see CustomConnectorDestinationProperties#withCustomProperties
* @returns a reference to this object so that method calls can be chained together.
*/
public CustomConnectorDestinationProperties addCustomPropertiesEntry(String key, String value) {
if (null == this.customProperties) {
this.customProperties = new java.util.HashMap();
}
if (this.customProperties.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.customProperties.put(key, value);
return this;
}
/**
* Removes all the entries added into CustomProperties.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CustomConnectorDestinationProperties clearCustomPropertiesEntries() {
this.customProperties = null;
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 (getEntityName() != null)
sb.append("EntityName: ").append(getEntityName()).append(",");
if (getErrorHandlingConfig() != null)
sb.append("ErrorHandlingConfig: ").append(getErrorHandlingConfig()).append(",");
if (getWriteOperationType() != null)
sb.append("WriteOperationType: ").append(getWriteOperationType()).append(",");
if (getIdFieldNames() != null)
sb.append("IdFieldNames: ").append(getIdFieldNames()).append(",");
if (getCustomProperties() != null)
sb.append("CustomProperties: ").append(getCustomProperties());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CustomConnectorDestinationProperties == false)
return false;
CustomConnectorDestinationProperties other = (CustomConnectorDestinationProperties) obj;
if (other.getEntityName() == null ^ this.getEntityName() == null)
return false;
if (other.getEntityName() != null && other.getEntityName().equals(this.getEntityName()) == false)
return false;
if (other.getErrorHandlingConfig() == null ^ this.getErrorHandlingConfig() == null)
return false;
if (other.getErrorHandlingConfig() != null && other.getErrorHandlingConfig().equals(this.getErrorHandlingConfig()) == false)
return false;
if (other.getWriteOperationType() == null ^ this.getWriteOperationType() == null)
return false;
if (other.getWriteOperationType() != null && other.getWriteOperationType().equals(this.getWriteOperationType()) == false)
return false;
if (other.getIdFieldNames() == null ^ this.getIdFieldNames() == null)
return false;
if (other.getIdFieldNames() != null && other.getIdFieldNames().equals(this.getIdFieldNames()) == false)
return false;
if (other.getCustomProperties() == null ^ this.getCustomProperties() == null)
return false;
if (other.getCustomProperties() != null && other.getCustomProperties().equals(this.getCustomProperties()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getEntityName() == null) ? 0 : getEntityName().hashCode());
hashCode = prime * hashCode + ((getErrorHandlingConfig() == null) ? 0 : getErrorHandlingConfig().hashCode());
hashCode = prime * hashCode + ((getWriteOperationType() == null) ? 0 : getWriteOperationType().hashCode());
hashCode = prime * hashCode + ((getIdFieldNames() == null) ? 0 : getIdFieldNames().hashCode());
hashCode = prime * hashCode + ((getCustomProperties() == null) ? 0 : getCustomProperties().hashCode());
return hashCode;
}
@Override
public CustomConnectorDestinationProperties clone() {
try {
return (CustomConnectorDestinationProperties) 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.appflow.model.transform.CustomConnectorDestinationPropertiesMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}