com.amazonaws.services.appflow.model.CreateConnectorProfileRequest 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.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateConnectorProfileRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the connector profile. The name is unique for each ConnectorProfile in your Amazon Web
* Services account.
*
*/
private String connectorProfileName;
/**
*
* The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is
* required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon
* AppFlow uses the Amazon AppFlow-managed KMS key.
*
*/
private String kmsArn;
/**
*
* The type of connector, such as Salesforce, Amplitude, and so on.
*
*/
private String connectorType;
/**
*
* The label of the connector. The label is unique for each ConnectorRegistration in your Amazon Web
* Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.
*
*/
private String connectorLabel;
/**
*
* Indicates the connection mode and specifies whether it is public or private. Private flows use Amazon Web
* Services PrivateLink to route data over Amazon Web Services infrastructure without exposing it to the public
* internet.
*
*/
private String connectionMode;
/**
*
* Defines the connector-specific configuration and credentials.
*
*/
private ConnectorProfileConfig connectorProfileConfig;
/**
*
* The clientToken parameter is an idempotency token. It ensures that your
* CreateConnectorProfile request completes only once. You choose the value to pass. For example, if
* you don't receive a response from your request, you can safely retry the request with the same
* clientToken parameter value.
*
*
* If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for
* you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own
* value for other use cases.
*
*
* If you specify input parameters that differ from your first request, an error occurs. If you use a different
* value for clientToken, Amazon AppFlow considers it a new call to CreateConnectorProfile
* . The token is active for 8 hours.
*
*/
private String clientToken;
/**
*
* The name of the connector profile. The name is unique for each ConnectorProfile in your Amazon Web
* Services account.
*
*
* @param connectorProfileName
* The name of the connector profile. The name is unique for each ConnectorProfile in your
* Amazon Web Services account.
*/
public void setConnectorProfileName(String connectorProfileName) {
this.connectorProfileName = connectorProfileName;
}
/**
*
* The name of the connector profile. The name is unique for each ConnectorProfile in your Amazon Web
* Services account.
*
*
* @return The name of the connector profile. The name is unique for each ConnectorProfile in your
* Amazon Web Services account.
*/
public String getConnectorProfileName() {
return this.connectorProfileName;
}
/**
*
* The name of the connector profile. The name is unique for each ConnectorProfile in your Amazon Web
* Services account.
*
*
* @param connectorProfileName
* The name of the connector profile. The name is unique for each ConnectorProfile in your
* Amazon Web Services account.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateConnectorProfileRequest withConnectorProfileName(String connectorProfileName) {
setConnectorProfileName(connectorProfileName);
return this;
}
/**
*
* The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is
* required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon
* AppFlow uses the Amazon AppFlow-managed KMS key.
*
*
* @param kmsArn
* The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is
* required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here,
* Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
*/
public void setKmsArn(String kmsArn) {
this.kmsArn = kmsArn;
}
/**
*
* The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is
* required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon
* AppFlow uses the Amazon AppFlow-managed KMS key.
*
*
* @return The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This
* is required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything
* here, Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
*/
public String getKmsArn() {
return this.kmsArn;
}
/**
*
* The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is
* required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here, Amazon
* AppFlow uses the Amazon AppFlow-managed KMS key.
*
*
* @param kmsArn
* The ARN (Amazon Resource Name) of the Key Management Service (KMS) key you provide for encryption. This is
* required if you do not want to use the Amazon AppFlow-managed KMS key. If you don't provide anything here,
* Amazon AppFlow uses the Amazon AppFlow-managed KMS key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateConnectorProfileRequest withKmsArn(String kmsArn) {
setKmsArn(kmsArn);
return this;
}
/**
*
* The type of connector, such as Salesforce, Amplitude, and so on.
*
*
* @param connectorType
* The type of connector, such as Salesforce, Amplitude, and so on.
* @see ConnectorType
*/
public void setConnectorType(String connectorType) {
this.connectorType = connectorType;
}
/**
*
* The type of connector, such as Salesforce, Amplitude, and so on.
*
*
* @return The type of connector, such as Salesforce, Amplitude, and so on.
* @see ConnectorType
*/
public String getConnectorType() {
return this.connectorType;
}
/**
*
* The type of connector, such as Salesforce, Amplitude, and so on.
*
*
* @param connectorType
* The type of connector, such as Salesforce, Amplitude, and so on.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ConnectorType
*/
public CreateConnectorProfileRequest withConnectorType(String connectorType) {
setConnectorType(connectorType);
return this;
}
/**
*
* The type of connector, such as Salesforce, Amplitude, and so on.
*
*
* @param connectorType
* The type of connector, such as Salesforce, Amplitude, and so on.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ConnectorType
*/
public CreateConnectorProfileRequest withConnectorType(ConnectorType connectorType) {
this.connectorType = connectorType.toString();
return this;
}
/**
*
* The label of the connector. The label is unique for each ConnectorRegistration in your Amazon Web
* Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.
*
*
* @param connectorLabel
* The label of the connector. The label is unique for each ConnectorRegistration in your Amazon
* Web Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.
*/
public void setConnectorLabel(String connectorLabel) {
this.connectorLabel = connectorLabel;
}
/**
*
* The label of the connector. The label is unique for each ConnectorRegistration in your Amazon Web
* Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.
*
*
* @return The label of the connector. The label is unique for each ConnectorRegistration in your
* Amazon Web Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.
*/
public String getConnectorLabel() {
return this.connectorLabel;
}
/**
*
* The label of the connector. The label is unique for each ConnectorRegistration in your Amazon Web
* Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.
*
*
* @param connectorLabel
* The label of the connector. The label is unique for each ConnectorRegistration in your Amazon
* Web Services account. Only needed if calling for CUSTOMCONNECTOR connector type/.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateConnectorProfileRequest withConnectorLabel(String connectorLabel) {
setConnectorLabel(connectorLabel);
return this;
}
/**
*
* Indicates the connection mode and specifies whether it is public or private. Private flows use Amazon Web
* Services PrivateLink to route data over Amazon Web Services infrastructure without exposing it to the public
* internet.
*
*
* @param connectionMode
* Indicates the connection mode and specifies whether it is public or private. Private flows use Amazon Web
* Services PrivateLink to route data over Amazon Web Services infrastructure without exposing it to the
* public internet.
* @see ConnectionMode
*/
public void setConnectionMode(String connectionMode) {
this.connectionMode = connectionMode;
}
/**
*
* Indicates the connection mode and specifies whether it is public or private. Private flows use Amazon Web
* Services PrivateLink to route data over Amazon Web Services infrastructure without exposing it to the public
* internet.
*
*
* @return Indicates the connection mode and specifies whether it is public or private. Private flows use Amazon Web
* Services PrivateLink to route data over Amazon Web Services infrastructure without exposing it to the
* public internet.
* @see ConnectionMode
*/
public String getConnectionMode() {
return this.connectionMode;
}
/**
*
* Indicates the connection mode and specifies whether it is public or private. Private flows use Amazon Web
* Services PrivateLink to route data over Amazon Web Services infrastructure without exposing it to the public
* internet.
*
*
* @param connectionMode
* Indicates the connection mode and specifies whether it is public or private. Private flows use Amazon Web
* Services PrivateLink to route data over Amazon Web Services infrastructure without exposing it to the
* public internet.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ConnectionMode
*/
public CreateConnectorProfileRequest withConnectionMode(String connectionMode) {
setConnectionMode(connectionMode);
return this;
}
/**
*
* Indicates the connection mode and specifies whether it is public or private. Private flows use Amazon Web
* Services PrivateLink to route data over Amazon Web Services infrastructure without exposing it to the public
* internet.
*
*
* @param connectionMode
* Indicates the connection mode and specifies whether it is public or private. Private flows use Amazon Web
* Services PrivateLink to route data over Amazon Web Services infrastructure without exposing it to the
* public internet.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ConnectionMode
*/
public CreateConnectorProfileRequest withConnectionMode(ConnectionMode connectionMode) {
this.connectionMode = connectionMode.toString();
return this;
}
/**
*
* Defines the connector-specific configuration and credentials.
*
*
* @param connectorProfileConfig
* Defines the connector-specific configuration and credentials.
*/
public void setConnectorProfileConfig(ConnectorProfileConfig connectorProfileConfig) {
this.connectorProfileConfig = connectorProfileConfig;
}
/**
*
* Defines the connector-specific configuration and credentials.
*
*
* @return Defines the connector-specific configuration and credentials.
*/
public ConnectorProfileConfig getConnectorProfileConfig() {
return this.connectorProfileConfig;
}
/**
*
* Defines the connector-specific configuration and credentials.
*
*
* @param connectorProfileConfig
* Defines the connector-specific configuration and credentials.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateConnectorProfileRequest withConnectorProfileConfig(ConnectorProfileConfig connectorProfileConfig) {
setConnectorProfileConfig(connectorProfileConfig);
return this;
}
/**
*
* The clientToken parameter is an idempotency token. It ensures that your
* CreateConnectorProfile request completes only once. You choose the value to pass. For example, if
* you don't receive a response from your request, you can safely retry the request with the same
* clientToken parameter value.
*
*
* If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for
* you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own
* value for other use cases.
*
*
* If you specify input parameters that differ from your first request, an error occurs. If you use a different
* value for clientToken, Amazon AppFlow considers it a new call to CreateConnectorProfile
* . The token is active for 8 hours.
*
*
* @param clientToken
* The clientToken parameter is an idempotency token. It ensures that your
* CreateConnectorProfile request completes only once. You choose the value to pass. For
* example, if you don't receive a response from your request, you can safely retry the request with the same
* clientToken parameter value.
*
* If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a
* value for you. This way, the SDK can safely retry requests multiple times after a network error. You must
* provide your own value for other use cases.
*
*
* If you specify input parameters that differ from your first request, an error occurs. If you use a
* different value for clientToken, Amazon AppFlow considers it a new call to
* CreateConnectorProfile. The token is active for 8 hours.
*/
public void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
/**
*
* The clientToken parameter is an idempotency token. It ensures that your
* CreateConnectorProfile request completes only once. You choose the value to pass. For example, if
* you don't receive a response from your request, you can safely retry the request with the same
* clientToken parameter value.
*
*
* If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for
* you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own
* value for other use cases.
*
*
* If you specify input parameters that differ from your first request, an error occurs. If you use a different
* value for clientToken, Amazon AppFlow considers it a new call to CreateConnectorProfile
* . The token is active for 8 hours.
*
*
* @return The clientToken parameter is an idempotency token. It ensures that your
* CreateConnectorProfile request completes only once. You choose the value to pass. For
* example, if you don't receive a response from your request, you can safely retry the request with the
* same clientToken parameter value.
*
* If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a
* value for you. This way, the SDK can safely retry requests multiple times after a network error. You must
* provide your own value for other use cases.
*
*
* If you specify input parameters that differ from your first request, an error occurs. If you use a
* different value for clientToken, Amazon AppFlow considers it a new call to
* CreateConnectorProfile. The token is active for 8 hours.
*/
public String getClientToken() {
return this.clientToken;
}
/**
*
* The clientToken parameter is an idempotency token. It ensures that your
* CreateConnectorProfile request completes only once. You choose the value to pass. For example, if
* you don't receive a response from your request, you can safely retry the request with the same
* clientToken parameter value.
*
*
* If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a value for
* you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own
* value for other use cases.
*
*
* If you specify input parameters that differ from your first request, an error occurs. If you use a different
* value for clientToken, Amazon AppFlow considers it a new call to CreateConnectorProfile
* . The token is active for 8 hours.
*
*
* @param clientToken
* The clientToken parameter is an idempotency token. It ensures that your
* CreateConnectorProfile request completes only once. You choose the value to pass. For
* example, if you don't receive a response from your request, you can safely retry the request with the same
* clientToken parameter value.
*
* If you omit a clientToken value, the Amazon Web Services SDK that you are using inserts a
* value for you. This way, the SDK can safely retry requests multiple times after a network error. You must
* provide your own value for other use cases.
*
*
* If you specify input parameters that differ from your first request, an error occurs. If you use a
* different value for clientToken, Amazon AppFlow considers it a new call to
* CreateConnectorProfile. The token is active for 8 hours.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateConnectorProfileRequest withClientToken(String clientToken) {
setClientToken(clientToken);
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 (getConnectorProfileName() != null)
sb.append("ConnectorProfileName: ").append(getConnectorProfileName()).append(",");
if (getKmsArn() != null)
sb.append("KmsArn: ").append(getKmsArn()).append(",");
if (getConnectorType() != null)
sb.append("ConnectorType: ").append(getConnectorType()).append(",");
if (getConnectorLabel() != null)
sb.append("ConnectorLabel: ").append(getConnectorLabel()).append(",");
if (getConnectionMode() != null)
sb.append("ConnectionMode: ").append(getConnectionMode()).append(",");
if (getConnectorProfileConfig() != null)
sb.append("ConnectorProfileConfig: ").append(getConnectorProfileConfig()).append(",");
if (getClientToken() != null)
sb.append("ClientToken: ").append(getClientToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateConnectorProfileRequest == false)
return false;
CreateConnectorProfileRequest other = (CreateConnectorProfileRequest) obj;
if (other.getConnectorProfileName() == null ^ this.getConnectorProfileName() == null)
return false;
if (other.getConnectorProfileName() != null && other.getConnectorProfileName().equals(this.getConnectorProfileName()) == false)
return false;
if (other.getKmsArn() == null ^ this.getKmsArn() == null)
return false;
if (other.getKmsArn() != null && other.getKmsArn().equals(this.getKmsArn()) == false)
return false;
if (other.getConnectorType() == null ^ this.getConnectorType() == null)
return false;
if (other.getConnectorType() != null && other.getConnectorType().equals(this.getConnectorType()) == false)
return false;
if (other.getConnectorLabel() == null ^ this.getConnectorLabel() == null)
return false;
if (other.getConnectorLabel() != null && other.getConnectorLabel().equals(this.getConnectorLabel()) == false)
return false;
if (other.getConnectionMode() == null ^ this.getConnectionMode() == null)
return false;
if (other.getConnectionMode() != null && other.getConnectionMode().equals(this.getConnectionMode()) == false)
return false;
if (other.getConnectorProfileConfig() == null ^ this.getConnectorProfileConfig() == null)
return false;
if (other.getConnectorProfileConfig() != null && other.getConnectorProfileConfig().equals(this.getConnectorProfileConfig()) == false)
return false;
if (other.getClientToken() == null ^ this.getClientToken() == null)
return false;
if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getConnectorProfileName() == null) ? 0 : getConnectorProfileName().hashCode());
hashCode = prime * hashCode + ((getKmsArn() == null) ? 0 : getKmsArn().hashCode());
hashCode = prime * hashCode + ((getConnectorType() == null) ? 0 : getConnectorType().hashCode());
hashCode = prime * hashCode + ((getConnectorLabel() == null) ? 0 : getConnectorLabel().hashCode());
hashCode = prime * hashCode + ((getConnectionMode() == null) ? 0 : getConnectionMode().hashCode());
hashCode = prime * hashCode + ((getConnectorProfileConfig() == null) ? 0 : getConnectorProfileConfig().hashCode());
hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
return hashCode;
}
@Override
public CreateConnectorProfileRequest clone() {
return (CreateConnectorProfileRequest) super.clone();
}
}