/* * Copyright 2012-2017 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.machinelearning.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CreateDataSourceFromRedshiftRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** * <p> * A user-supplied ID that uniquely identifies the <code>DataSource</code>. * </p> */ private String dataSourceId; /** * <p> * A user-supplied name or description of the <code>DataSource</code>. * </p> */ private String dataSourceName; /** * <p> * The data specification of an Amazon Redshift <code>DataSource</code>: * </p> * <ul> * <li> * <p> * DatabaseInformation - * <ul> * <li> <code>DatabaseName</code> - The name of the Amazon Redshift database.</li> * <li> <code> ClusterIdentifier</code> - The unique ID for the Amazon Redshift cluster.</li> * </ul> * </p> * </li> * <li> * <p> * DatabaseCredentials - The AWS Identity and Access Management (IAM) credentials that are used to connect to the * Amazon Redshift database. * </p> * </li> * <li> * <p> * SelectSqlQuery - The query that is used to retrieve the observation data for the <code>Datasource</code>. * </p> * </li> * <li> * <p> * S3StagingLocation - The Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift data. The * data retrieved from Amazon Redshift using the <code>SelectSqlQuery</code> query is stored in this location. * </p> * </li> * <li> * <p> * DataSchemaUri - The Amazon S3 location of the <code>DataSchema</code>. * </p> * </li> * <li> * <p> * DataSchema - A JSON string representing the schema. This is not required if <code>DataSchemaUri</code> is * specified. * </p> * </li> * <li> * <p> * DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the * <code>DataSource</code>. * </p> * <p> * Sample - <code> "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"</code> * </p> * </li> * </ul> */ private RedshiftDataSpec dataSpec; /** * <p> * A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to create the * following: * </p> * <p> * <ul> * <li> * <p> * A security group to allow Amazon ML to execute the <code>SelectSqlQuery</code> query on an Amazon Redshift * cluster * </p> * </li> * <li> * <p> * An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the <code>S3StagingLocation</code> * </p> * </li> * </ul> * </p> */ private String roleARN; /** * <p> * The compute statistics for a <code>DataSource</code>. The statistics are generated from the observation data * referenced by a <code>DataSource</code>. Amazon ML uses the statistics internally during <code>MLModel</code> * training. This parameter must be set to <code>true</code> if the <code>DataSource</code> needs to be used for * <code>MLModel</code> training. * </p> */ private Boolean computeStatistics; /** * <p> * A user-supplied ID that uniquely identifies the <code>DataSource</code>. * </p> * * @param dataSourceId * A user-supplied ID that uniquely identifies the <code>DataSource</code>. */ public void setDataSourceId(String dataSourceId) { this.dataSourceId = dataSourceId; } /** * <p> * A user-supplied ID that uniquely identifies the <code>DataSource</code>. * </p> * * @return A user-supplied ID that uniquely identifies the <code>DataSource</code>. */ public String getDataSourceId() { return this.dataSourceId; } /** * <p> * A user-supplied ID that uniquely identifies the <code>DataSource</code>. * </p> * * @param dataSourceId * A user-supplied ID that uniquely identifies the <code>DataSource</code>. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDataSourceFromRedshiftRequest withDataSourceId(String dataSourceId) { setDataSourceId(dataSourceId); return this; } /** * <p> * A user-supplied name or description of the <code>DataSource</code>. * </p> * * @param dataSourceName * A user-supplied name or description of the <code>DataSource</code>. */ public void setDataSourceName(String dataSourceName) { this.dataSourceName = dataSourceName; } /** * <p> * A user-supplied name or description of the <code>DataSource</code>. * </p> * * @return A user-supplied name or description of the <code>DataSource</code>. */ public String getDataSourceName() { return this.dataSourceName; } /** * <p> * A user-supplied name or description of the <code>DataSource</code>. * </p> * * @param dataSourceName * A user-supplied name or description of the <code>DataSource</code>. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDataSourceFromRedshiftRequest withDataSourceName(String dataSourceName) { setDataSourceName(dataSourceName); return this; } /** * <p> * The data specification of an Amazon Redshift <code>DataSource</code>: * </p> * <ul> * <li> * <p> * DatabaseInformation - * <ul> * <li> <code>DatabaseName</code> - The name of the Amazon Redshift database.</li> * <li> <code> ClusterIdentifier</code> - The unique ID for the Amazon Redshift cluster.</li> * </ul> * </p> * </li> * <li> * <p> * DatabaseCredentials - The AWS Identity and Access Management (IAM) credentials that are used to connect to the * Amazon Redshift database. * </p> * </li> * <li> * <p> * SelectSqlQuery - The query that is used to retrieve the observation data for the <code>Datasource</code>. * </p> * </li> * <li> * <p> * S3StagingLocation - The Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift data. The * data retrieved from Amazon Redshift using the <code>SelectSqlQuery</code> query is stored in this location. * </p> * </li> * <li> * <p> * DataSchemaUri - The Amazon S3 location of the <code>DataSchema</code>. * </p> * </li> * <li> * <p> * DataSchema - A JSON string representing the schema. This is not required if <code>DataSchemaUri</code> is * specified. * </p> * </li> * <li> * <p> * DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the * <code>DataSource</code>. * </p> * <p> * Sample - <code> "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"</code> * </p> * </li> * </ul> * * @param dataSpec * The data specification of an Amazon Redshift <code>DataSource</code>:</p> * <ul> * <li> * <p> * DatabaseInformation - * <ul> * <li> <code>DatabaseName</code> - The name of the Amazon Redshift database.</li> * <li> <code> ClusterIdentifier</code> - The unique ID for the Amazon Redshift cluster.</li> * </ul> * </p> * </li> * <li> * <p> * DatabaseCredentials - The AWS Identity and Access Management (IAM) credentials that are used to connect to * the Amazon Redshift database. * </p> * </li> * <li> * <p> * SelectSqlQuery - The query that is used to retrieve the observation data for the <code>Datasource</code>. * </p> * </li> * <li> * <p> * S3StagingLocation - The Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift * data. The data retrieved from Amazon Redshift using the <code>SelectSqlQuery</code> query is stored in * this location. * </p> * </li> * <li> * <p> * DataSchemaUri - The Amazon S3 location of the <code>DataSchema</code>. * </p> * </li> * <li> * <p> * DataSchema - A JSON string representing the schema. This is not required if <code>DataSchemaUri</code> is * specified. * </p> * </li> * <li> * <p> * DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the * <code>DataSource</code>. * </p> * <p> * Sample - <code> "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"</code> * </p> * </li> */ public void setDataSpec(RedshiftDataSpec dataSpec) { this.dataSpec = dataSpec; } /** * <p> * The data specification of an Amazon Redshift <code>DataSource</code>: * </p> * <ul> * <li> * <p> * DatabaseInformation - * <ul> * <li> <code>DatabaseName</code> - The name of the Amazon Redshift database.</li> * <li> <code> ClusterIdentifier</code> - The unique ID for the Amazon Redshift cluster.</li> * </ul> * </p> * </li> * <li> * <p> * DatabaseCredentials - The AWS Identity and Access Management (IAM) credentials that are used to connect to the * Amazon Redshift database. * </p> * </li> * <li> * <p> * SelectSqlQuery - The query that is used to retrieve the observation data for the <code>Datasource</code>. * </p> * </li> * <li> * <p> * S3StagingLocation - The Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift data. The * data retrieved from Amazon Redshift using the <code>SelectSqlQuery</code> query is stored in this location. * </p> * </li> * <li> * <p> * DataSchemaUri - The Amazon S3 location of the <code>DataSchema</code>. * </p> * </li> * <li> * <p> * DataSchema - A JSON string representing the schema. This is not required if <code>DataSchemaUri</code> is * specified. * </p> * </li> * <li> * <p> * DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the * <code>DataSource</code>. * </p> * <p> * Sample - <code> "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"</code> * </p> * </li> * </ul> * * @return The data specification of an Amazon Redshift <code>DataSource</code>:</p> * <ul> * <li> * <p> * DatabaseInformation - * <ul> * <li> <code>DatabaseName</code> - The name of the Amazon Redshift database.</li> * <li> <code> ClusterIdentifier</code> - The unique ID for the Amazon Redshift cluster.</li> * </ul> * </p> * </li> * <li> * <p> * DatabaseCredentials - The AWS Identity and Access Management (IAM) credentials that are used to connect * to the Amazon Redshift database. * </p> * </li> * <li> * <p> * SelectSqlQuery - The query that is used to retrieve the observation data for the <code>Datasource</code>. * </p> * </li> * <li> * <p> * S3StagingLocation - The Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift * data. The data retrieved from Amazon Redshift using the <code>SelectSqlQuery</code> query is stored in * this location. * </p> * </li> * <li> * <p> * DataSchemaUri - The Amazon S3 location of the <code>DataSchema</code>. * </p> * </li> * <li> * <p> * DataSchema - A JSON string representing the schema. This is not required if <code>DataSchemaUri</code> is * specified. * </p> * </li> * <li> * <p> * DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the * <code>DataSource</code>. * </p> * <p> * Sample - <code> "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"</code> * </p> * </li> */ public RedshiftDataSpec getDataSpec() { return this.dataSpec; } /** * <p> * The data specification of an Amazon Redshift <code>DataSource</code>: * </p> * <ul> * <li> * <p> * DatabaseInformation - * <ul> * <li> <code>DatabaseName</code> - The name of the Amazon Redshift database.</li> * <li> <code> ClusterIdentifier</code> - The unique ID for the Amazon Redshift cluster.</li> * </ul> * </p> * </li> * <li> * <p> * DatabaseCredentials - The AWS Identity and Access Management (IAM) credentials that are used to connect to the * Amazon Redshift database. * </p> * </li> * <li> * <p> * SelectSqlQuery - The query that is used to retrieve the observation data for the <code>Datasource</code>. * </p> * </li> * <li> * <p> * S3StagingLocation - The Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift data. The * data retrieved from Amazon Redshift using the <code>SelectSqlQuery</code> query is stored in this location. * </p> * </li> * <li> * <p> * DataSchemaUri - The Amazon S3 location of the <code>DataSchema</code>. * </p> * </li> * <li> * <p> * DataSchema - A JSON string representing the schema. This is not required if <code>DataSchemaUri</code> is * specified. * </p> * </li> * <li> * <p> * DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the * <code>DataSource</code>. * </p> * <p> * Sample - <code> "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"</code> * </p> * </li> * </ul> * * @param dataSpec * The data specification of an Amazon Redshift <code>DataSource</code>:</p> * <ul> * <li> * <p> * DatabaseInformation - * <ul> * <li> <code>DatabaseName</code> - The name of the Amazon Redshift database.</li> * <li> <code> ClusterIdentifier</code> - The unique ID for the Amazon Redshift cluster.</li> * </ul> * </p> * </li> * <li> * <p> * DatabaseCredentials - The AWS Identity and Access Management (IAM) credentials that are used to connect to * the Amazon Redshift database. * </p> * </li> * <li> * <p> * SelectSqlQuery - The query that is used to retrieve the observation data for the <code>Datasource</code>. * </p> * </li> * <li> * <p> * S3StagingLocation - The Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift * data. The data retrieved from Amazon Redshift using the <code>SelectSqlQuery</code> query is stored in * this location. * </p> * </li> * <li> * <p> * DataSchemaUri - The Amazon S3 location of the <code>DataSchema</code>. * </p> * </li> * <li> * <p> * DataSchema - A JSON string representing the schema. This is not required if <code>DataSchemaUri</code> is * specified. * </p> * </li> * <li> * <p> * DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the * <code>DataSource</code>. * </p> * <p> * Sample - <code> "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"</code> * </p> * </li> * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDataSourceFromRedshiftRequest withDataSpec(RedshiftDataSpec dataSpec) { setDataSpec(dataSpec); return this; } /** * <p> * A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to create the * following: * </p> * <p> * <ul> * <li> * <p> * A security group to allow Amazon ML to execute the <code>SelectSqlQuery</code> query on an Amazon Redshift * cluster * </p> * </li> * <li> * <p> * An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the <code>S3StagingLocation</code> * </p> * </li> * </ul> * </p> * * @param roleARN * A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to * create the following: </p> * <p> * <ul> * <li> * <p> * A security group to allow Amazon ML to execute the <code>SelectSqlQuery</code> query on an Amazon Redshift * cluster * </p> * </li> * <li> * <p> * An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the <code>S3StagingLocation</code> * </p> * </li> * </ul> */ public void setRoleARN(String roleARN) { this.roleARN = roleARN; } /** * <p> * A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to create the * following: * </p> * <p> * <ul> * <li> * <p> * A security group to allow Amazon ML to execute the <code>SelectSqlQuery</code> query on an Amazon Redshift * cluster * </p> * </li> * <li> * <p> * An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the <code>S3StagingLocation</code> * </p> * </li> * </ul> * </p> * * @return A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to * create the following: </p> * <p> * <ul> * <li> * <p> * A security group to allow Amazon ML to execute the <code>SelectSqlQuery</code> query on an Amazon * Redshift cluster * </p> * </li> * <li> * <p> * An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the * <code>S3StagingLocation</code> * </p> * </li> * </ul> */ public String getRoleARN() { return this.roleARN; } /** * <p> * A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to create the * following: * </p> * <p> * <ul> * <li> * <p> * A security group to allow Amazon ML to execute the <code>SelectSqlQuery</code> query on an Amazon Redshift * cluster * </p> * </li> * <li> * <p> * An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the <code>S3StagingLocation</code> * </p> * </li> * </ul> * </p> * * @param roleARN * A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to * create the following: </p> * <p> * <ul> * <li> * <p> * A security group to allow Amazon ML to execute the <code>SelectSqlQuery</code> query on an Amazon Redshift * cluster * </p> * </li> * <li> * <p> * An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the <code>S3StagingLocation</code> * </p> * </li> * </ul> * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDataSourceFromRedshiftRequest withRoleARN(String roleARN) { setRoleARN(roleARN); return this; } /** * <p> * The compute statistics for a <code>DataSource</code>. The statistics are generated from the observation data * referenced by a <code>DataSource</code>. Amazon ML uses the statistics internally during <code>MLModel</code> * training. This parameter must be set to <code>true</code> if the <code>DataSource</code> needs to be used for * <code>MLModel</code> training. * </p> * * @param computeStatistics * The compute statistics for a <code>DataSource</code>. The statistics are generated from the observation * data referenced by a <code>DataSource</code>. Amazon ML uses the statistics internally during * <code>MLModel</code> training. This parameter must be set to <code>true</code> if the * <code>DataSource</code> needs to be used for <code>MLModel</code> training. */ public void setComputeStatistics(Boolean computeStatistics) { this.computeStatistics = computeStatistics; } /** * <p> * The compute statistics for a <code>DataSource</code>. The statistics are generated from the observation data * referenced by a <code>DataSource</code>. Amazon ML uses the statistics internally during <code>MLModel</code> * training. This parameter must be set to <code>true</code> if the <code>DataSource</code> needs to be used for * <code>MLModel</code> training. * </p> * * @return The compute statistics for a <code>DataSource</code>. The statistics are generated from the observation * data referenced by a <code>DataSource</code>. Amazon ML uses the statistics internally during * <code>MLModel</code> training. This parameter must be set to <code>true</code> if the * <code>DataSource</code> needs to be used for <code>MLModel</code> training. */ public Boolean getComputeStatistics() { return this.computeStatistics; } /** * <p> * The compute statistics for a <code>DataSource</code>. The statistics are generated from the observation data * referenced by a <code>DataSource</code>. Amazon ML uses the statistics internally during <code>MLModel</code> * training. This parameter must be set to <code>true</code> if the <code>DataSource</code> needs to be used for * <code>MLModel</code> training. * </p> * * @param computeStatistics * The compute statistics for a <code>DataSource</code>. The statistics are generated from the observation * data referenced by a <code>DataSource</code>. Amazon ML uses the statistics internally during * <code>MLModel</code> training. This parameter must be set to <code>true</code> if the * <code>DataSource</code> needs to be used for <code>MLModel</code> training. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateDataSourceFromRedshiftRequest withComputeStatistics(Boolean computeStatistics) { setComputeStatistics(computeStatistics); return this; } /** * <p> * The compute statistics for a <code>DataSource</code>. The statistics are generated from the observation data * referenced by a <code>DataSource</code>. Amazon ML uses the statistics internally during <code>MLModel</code> * training. This parameter must be set to <code>true</code> if the <code>DataSource</code> needs to be used for * <code>MLModel</code> training. * </p> * * @return The compute statistics for a <code>DataSource</code>. The statistics are generated from the observation * data referenced by a <code>DataSource</code>. Amazon ML uses the statistics internally during * <code>MLModel</code> training. This parameter must be set to <code>true</code> if the * <code>DataSource</code> needs to be used for <code>MLModel</code> training. */ public Boolean isComputeStatistics() { return this.computeStatistics; } /** * Returns a string representation of this object; useful for testing and debugging. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getDataSourceId() != null) sb.append("DataSourceId: ").append(getDataSourceId()).append(","); if (getDataSourceName() != null) sb.append("DataSourceName: ").append(getDataSourceName()).append(","); if (getDataSpec() != null) sb.append("DataSpec: ").append(getDataSpec()).append(","); if (getRoleARN() != null) sb.append("RoleARN: ").append(getRoleARN()).append(","); if (getComputeStatistics() != null) sb.append("ComputeStatistics: ").append(getComputeStatistics()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof CreateDataSourceFromRedshiftRequest == false) return false; CreateDataSourceFromRedshiftRequest other = (CreateDataSourceFromRedshiftRequest) obj; if (other.getDataSourceId() == null ^ this.getDataSourceId() == null) return false; if (other.getDataSourceId() != null && other.getDataSourceId().equals(this.getDataSourceId()) == false) return false; if (other.getDataSourceName() == null ^ this.getDataSourceName() == null) return false; if (other.getDataSourceName() != null && other.getDataSourceName().equals(this.getDataSourceName()) == false) return false; if (other.getDataSpec() == null ^ this.getDataSpec() == null) return false; if (other.getDataSpec() != null && other.getDataSpec().equals(this.getDataSpec()) == false) return false; if (other.getRoleARN() == null ^ this.getRoleARN() == null) return false; if (other.getRoleARN() != null && other.getRoleARN().equals(this.getRoleARN()) == false) return false; if (other.getComputeStatistics() == null ^ this.getComputeStatistics() == null) return false; if (other.getComputeStatistics() != null && other.getComputeStatistics().equals(this.getComputeStatistics()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getDataSourceId() == null) ? 0 : getDataSourceId().hashCode()); hashCode = prime * hashCode + ((getDataSourceName() == null) ? 0 : getDataSourceName().hashCode()); hashCode = prime * hashCode + ((getDataSpec() == null) ? 0 : getDataSpec().hashCode()); hashCode = prime * hashCode + ((getRoleARN() == null) ? 0 : getRoleARN().hashCode()); hashCode = prime * hashCode + ((getComputeStatistics() == null) ? 0 : getComputeStatistics().hashCode()); return hashCode; } @Override public CreateDataSourceFromRedshiftRequest clone() { return (CreateDataSourceFromRedshiftRequest) super.clone(); } }