com.amazonaws.services.appflow.model.GlueDataCatalogConfig 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;
/**
*
* Specifies the configuration that Amazon AppFlow uses when it catalogs your data with the Glue Data Catalog. When
* Amazon AppFlow catalogs your data, it stores metadata in Data Catalog tables. This metadata represents the data
* that's transferred by the flow that you configure with these settings.
*
*
*
* You can configure a flow with these settings only when the flow destination is Amazon S3.
*
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GlueDataCatalogConfig implements Serializable, Cloneable, StructuredPojo {
/**
*
* The Amazon Resource Name (ARN) of an IAM role that grants Amazon AppFlow the permissions it needs to create Data
* Catalog tables, databases, and partitions.
*
*
* For an example IAM policy that has the required permissions, see Identity-based policy examples for Amazon AppFlow.
*
*/
private String roleArn;
/**
*
* The name of the Data Catalog database that stores the metadata tables that Amazon AppFlow creates in your Amazon
* Web Services account. These tables contain metadata for the data that's transferred by the flow that you
* configure with this parameter.
*
*
*
* When you configure a new flow with this parameter, you must specify an existing database.
*
*
*/
private String databaseName;
/**
*
* A naming prefix for each Data Catalog table that Amazon AppFlow creates for the flow that you configure with this
* setting. Amazon AppFlow adds the prefix to the beginning of the each table name.
*
*/
private String tablePrefix;
/**
*
* The Amazon Resource Name (ARN) of an IAM role that grants Amazon AppFlow the permissions it needs to create Data
* Catalog tables, databases, and partitions.
*
*
* For an example IAM policy that has the required permissions, see Identity-based policy examples for Amazon AppFlow.
*
*
* @param roleArn
* The Amazon Resource Name (ARN) of an IAM role that grants Amazon AppFlow the permissions it needs to
* create Data Catalog tables, databases, and partitions.
*
* For an example IAM policy that has the required permissions, see Identity-based policy examples for Amazon AppFlow.
*/
public void setRoleArn(String roleArn) {
this.roleArn = roleArn;
}
/**
*
* The Amazon Resource Name (ARN) of an IAM role that grants Amazon AppFlow the permissions it needs to create Data
* Catalog tables, databases, and partitions.
*
*
* For an example IAM policy that has the required permissions, see Identity-based policy examples for Amazon AppFlow.
*
*
* @return The Amazon Resource Name (ARN) of an IAM role that grants Amazon AppFlow the permissions it needs to
* create Data Catalog tables, databases, and partitions.
*
* For an example IAM policy that has the required permissions, see Identity-based policy examples for Amazon AppFlow.
*/
public String getRoleArn() {
return this.roleArn;
}
/**
*
* The Amazon Resource Name (ARN) of an IAM role that grants Amazon AppFlow the permissions it needs to create Data
* Catalog tables, databases, and partitions.
*
*
* For an example IAM policy that has the required permissions, see Identity-based policy examples for Amazon AppFlow.
*
*
* @param roleArn
* The Amazon Resource Name (ARN) of an IAM role that grants Amazon AppFlow the permissions it needs to
* create Data Catalog tables, databases, and partitions.
*
* For an example IAM policy that has the required permissions, see Identity-based policy examples for Amazon AppFlow.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GlueDataCatalogConfig withRoleArn(String roleArn) {
setRoleArn(roleArn);
return this;
}
/**
*
* The name of the Data Catalog database that stores the metadata tables that Amazon AppFlow creates in your Amazon
* Web Services account. These tables contain metadata for the data that's transferred by the flow that you
* configure with this parameter.
*
*
*
* When you configure a new flow with this parameter, you must specify an existing database.
*
*
*
* @param databaseName
* The name of the Data Catalog database that stores the metadata tables that Amazon AppFlow creates in your
* Amazon Web Services account. These tables contain metadata for the data that's transferred by the flow
* that you configure with this parameter.
*
* When you configure a new flow with this parameter, you must specify an existing database.
*
*/
public void setDatabaseName(String databaseName) {
this.databaseName = databaseName;
}
/**
*
* The name of the Data Catalog database that stores the metadata tables that Amazon AppFlow creates in your Amazon
* Web Services account. These tables contain metadata for the data that's transferred by the flow that you
* configure with this parameter.
*
*
*
* When you configure a new flow with this parameter, you must specify an existing database.
*
*
*
* @return The name of the Data Catalog database that stores the metadata tables that Amazon AppFlow creates in your
* Amazon Web Services account. These tables contain metadata for the data that's transferred by the flow
* that you configure with this parameter.
*
* When you configure a new flow with this parameter, you must specify an existing database.
*
*/
public String getDatabaseName() {
return this.databaseName;
}
/**
*
* The name of the Data Catalog database that stores the metadata tables that Amazon AppFlow creates in your Amazon
* Web Services account. These tables contain metadata for the data that's transferred by the flow that you
* configure with this parameter.
*
*
*
* When you configure a new flow with this parameter, you must specify an existing database.
*
*
*
* @param databaseName
* The name of the Data Catalog database that stores the metadata tables that Amazon AppFlow creates in your
* Amazon Web Services account. These tables contain metadata for the data that's transferred by the flow
* that you configure with this parameter.
*
* When you configure a new flow with this parameter, you must specify an existing database.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GlueDataCatalogConfig withDatabaseName(String databaseName) {
setDatabaseName(databaseName);
return this;
}
/**
*
* A naming prefix for each Data Catalog table that Amazon AppFlow creates for the flow that you configure with this
* setting. Amazon AppFlow adds the prefix to the beginning of the each table name.
*
*
* @param tablePrefix
* A naming prefix for each Data Catalog table that Amazon AppFlow creates for the flow that you configure
* with this setting. Amazon AppFlow adds the prefix to the beginning of the each table name.
*/
public void setTablePrefix(String tablePrefix) {
this.tablePrefix = tablePrefix;
}
/**
*
* A naming prefix for each Data Catalog table that Amazon AppFlow creates for the flow that you configure with this
* setting. Amazon AppFlow adds the prefix to the beginning of the each table name.
*
*
* @return A naming prefix for each Data Catalog table that Amazon AppFlow creates for the flow that you configure
* with this setting. Amazon AppFlow adds the prefix to the beginning of the each table name.
*/
public String getTablePrefix() {
return this.tablePrefix;
}
/**
*
* A naming prefix for each Data Catalog table that Amazon AppFlow creates for the flow that you configure with this
* setting. Amazon AppFlow adds the prefix to the beginning of the each table name.
*
*
* @param tablePrefix
* A naming prefix for each Data Catalog table that Amazon AppFlow creates for the flow that you configure
* with this setting. Amazon AppFlow adds the prefix to the beginning of the each table name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GlueDataCatalogConfig withTablePrefix(String tablePrefix) {
setTablePrefix(tablePrefix);
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 (getRoleArn() != null)
sb.append("RoleArn: ").append(getRoleArn()).append(",");
if (getDatabaseName() != null)
sb.append("DatabaseName: ").append(getDatabaseName()).append(",");
if (getTablePrefix() != null)
sb.append("TablePrefix: ").append(getTablePrefix());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GlueDataCatalogConfig == false)
return false;
GlueDataCatalogConfig other = (GlueDataCatalogConfig) obj;
if (other.getRoleArn() == null ^ this.getRoleArn() == null)
return false;
if (other.getRoleArn() != null && other.getRoleArn().equals(this.getRoleArn()) == false)
return false;
if (other.getDatabaseName() == null ^ this.getDatabaseName() == null)
return false;
if (other.getDatabaseName() != null && other.getDatabaseName().equals(this.getDatabaseName()) == false)
return false;
if (other.getTablePrefix() == null ^ this.getTablePrefix() == null)
return false;
if (other.getTablePrefix() != null && other.getTablePrefix().equals(this.getTablePrefix()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getRoleArn() == null) ? 0 : getRoleArn().hashCode());
hashCode = prime * hashCode + ((getDatabaseName() == null) ? 0 : getDatabaseName().hashCode());
hashCode = prime * hashCode + ((getTablePrefix() == null) ? 0 : getTablePrefix().hashCode());
return hashCode;
}
@Override
public GlueDataCatalogConfig clone() {
try {
return (GlueDataCatalogConfig) 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.GlueDataCatalogConfigMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}