com.amazonaws.services.machinelearning.model.CreateDataSourceFromRDSRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-machinelearning Show documentation
/*
* Copyright 2010-2016 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 com.amazonaws.AmazonWebServiceRequest;
/**
*
*/
public class CreateDataSourceFromRDSRequest extends AmazonWebServiceRequest
implements Serializable, Cloneable {
/**
*
* A user-supplied ID that uniquely identifies the DataSource.
* Typically, an Amazon Resource Number (ARN) becomes the ID for a
* DataSource.
*
*/
private String dataSourceId;
/**
*
* A user-supplied name or description of the DataSource.
*
*/
private String dataSourceName;
/**
*
* The data specification of an Amazon RDS DataSource:
*
*
* -
*
* DatabaseInformation -
*
* -
DatabaseName - Name of the Amazon RDS database.
* -
InstanceIdentifier - Unique identifier for the Amazon
* RDS database instance.
*
*
*
* -
*
* DatabaseCredentials - AWS Identity and Access Management (IAM)
* credentials that are used to connect to the Amazon RDS database.
*
*
* -
*
* ResourceRole - Role (DataPipelineDefaultResourceRole) assumed by an
* Amazon Elastic Compute Cloud (EC2) instance to carry out the copy task
* from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.
*
*
* -
*
* ServiceRole - Role (DataPipelineDefaultRole) assumed by the AWS Data
* Pipeline service to monitor the progress of the copy task from Amazon RDS
* to Amazon Simple Storage Service (S3). For more information, see Role templates for data pipelines.
*
*
* -
*
* SecurityInfo - Security information to use to access an Amazon RDS
* instance. You need to set up appropriate ingress rules for the security
* entity IDs provided to allow access to the Amazon RDS instance. Specify a
* [SubnetId, SecurityGroupIds] pair for a
* VPC-based Amazon RDS instance.
*
*
* -
*
* SelectSqlQuery - Query that is used to retrieve the observation data for
* the Datasource.
*
*
* -
*
* S3StagingLocation - Amazon S3 location for staging RDS data. The data
* retrieved from Amazon RDS using SelectSqlQuery is stored in
* this location.
*
*
* -
*
* DataSchemaUri - Amazon S3 location of the DataSchema.
*
*
* -
*
* DataSchema - A JSON string representing the schema. This is not required
* if DataSchemaUri is specified.
*
*
* -
*
* DataRearrangement - A JSON string representing the splitting requirement
* of a Datasource.
*
*
*
* Sample -
* "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"
*
*
*
*/
private RDSDataSpec rDSData;
/**
*
* The role that Amazon ML assumes on behalf of the user to create and
* activate a data pipeline in the user’s account and copy data (using the
* SelectSqlQuery) query from Amazon RDS to Amazon S3.
*
*
*
*/
private String roleARN;
/**
*
* The compute statistics for a DataSource. The statistics are
* generated from the observation data referenced by a
* DataSource. Amazon ML uses the statistics internally during
* an MLModel training. This parameter must be set to
* true if the MLModel training.
*
*/
private Boolean computeStatistics;
/**
*
* A user-supplied ID that uniquely identifies the DataSource.
* Typically, an Amazon Resource Number (ARN) becomes the ID for a
* DataSource.
*
*
* @param dataSourceId
* A user-supplied ID that uniquely identifies the
* DataSource. Typically, an Amazon Resource Number
* (ARN) becomes the ID for a DataSource.
*/
public void setDataSourceId(String dataSourceId) {
this.dataSourceId = dataSourceId;
}
/**
*
* A user-supplied ID that uniquely identifies the DataSource.
* Typically, an Amazon Resource Number (ARN) becomes the ID for a
* DataSource.
*
*
* @return A user-supplied ID that uniquely identifies the
* DataSource. Typically, an Amazon Resource Number
* (ARN) becomes the ID for a DataSource.
*/
public String getDataSourceId() {
return this.dataSourceId;
}
/**
*
* A user-supplied ID that uniquely identifies the DataSource.
* Typically, an Amazon Resource Number (ARN) becomes the ID for a
* DataSource.
*
*
* @param dataSourceId
* A user-supplied ID that uniquely identifies the
* DataSource. Typically, an Amazon Resource Number
* (ARN) becomes the ID for a DataSource.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateDataSourceFromRDSRequest withDataSourceId(String dataSourceId) {
setDataSourceId(dataSourceId);
return this;
}
/**
*
* A user-supplied name or description of the DataSource.
*
*
* @param dataSourceName
* A user-supplied name or description of the DataSource
* .
*/
public void setDataSourceName(String dataSourceName) {
this.dataSourceName = dataSourceName;
}
/**
*
* A user-supplied name or description of the DataSource.
*
*
* @return A user-supplied name or description of the
* DataSource.
*/
public String getDataSourceName() {
return this.dataSourceName;
}
/**
*
* A user-supplied name or description of the DataSource.
*
*
* @param dataSourceName
* A user-supplied name or description of the DataSource
* .
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateDataSourceFromRDSRequest withDataSourceName(
String dataSourceName) {
setDataSourceName(dataSourceName);
return this;
}
/**
*
* The data specification of an Amazon RDS DataSource:
*
*
* -
*
* DatabaseInformation -
*
* -
DatabaseName - Name of the Amazon RDS database.
* -
InstanceIdentifier - Unique identifier for the Amazon
* RDS database instance.
*
*
*
* -
*
* DatabaseCredentials - AWS Identity and Access Management (IAM)
* credentials that are used to connect to the Amazon RDS database.
*
*
* -
*
* ResourceRole - Role (DataPipelineDefaultResourceRole) assumed by an
* Amazon Elastic Compute Cloud (EC2) instance to carry out the copy task
* from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.
*
*
* -
*
* ServiceRole - Role (DataPipelineDefaultRole) assumed by the AWS Data
* Pipeline service to monitor the progress of the copy task from Amazon RDS
* to Amazon Simple Storage Service (S3). For more information, see Role templates for data pipelines.
*
*
* -
*
* SecurityInfo - Security information to use to access an Amazon RDS
* instance. You need to set up appropriate ingress rules for the security
* entity IDs provided to allow access to the Amazon RDS instance. Specify a
* [SubnetId, SecurityGroupIds] pair for a
* VPC-based Amazon RDS instance.
*
*
* -
*
* SelectSqlQuery - Query that is used to retrieve the observation data for
* the Datasource.
*
*
* -
*
* S3StagingLocation - Amazon S3 location for staging RDS data. The data
* retrieved from Amazon RDS using SelectSqlQuery is stored in
* this location.
*
*
* -
*
* DataSchemaUri - Amazon S3 location of the DataSchema.
*
*
* -
*
* DataSchema - A JSON string representing the schema. This is not required
* if DataSchemaUri is specified.
*
*
* -
*
* DataRearrangement - A JSON string representing the splitting requirement
* of a Datasource.
*
*
*
* Sample -
* "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"
*
*
*
*
* @param rDSData
* The data specification of an Amazon RDS DataSource
* :
*
* -
*
* DatabaseInformation -
*
* -
DatabaseName - Name of the Amazon RDS database.
* -
InstanceIdentifier - Unique identifier for the
* Amazon RDS database instance.
*
*
*
* -
*
* DatabaseCredentials - AWS Identity and Access Management (IAM)
* credentials that are used to connect to the Amazon RDS database.
*
*
* -
*
* ResourceRole - Role (DataPipelineDefaultResourceRole) assumed by
* an Amazon Elastic Compute Cloud (EC2) instance to carry out the
* copy task from Amazon RDS to Amazon S3. For more information, see
* Role templates for data pipelines.
*
*
* -
*
* ServiceRole - Role (DataPipelineDefaultRole) assumed by the AWS
* Data Pipeline service to monitor the progress of the copy task
* from Amazon RDS to Amazon Simple Storage Service (S3). For more
* information, see Role templates for data pipelines.
*
*
* -
*
* SecurityInfo - Security information to use to access an Amazon RDS
* instance. You need to set up appropriate ingress rules for the
* security entity IDs provided to allow access to the Amazon RDS
* instance. Specify a [SubnetId,
* SecurityGroupIds] pair for a VPC-based Amazon RDS
* instance.
*
*
* -
*
* SelectSqlQuery - Query that is used to retrieve the observation
* data for the Datasource.
*
*
* -
*
* S3StagingLocation - Amazon S3 location for staging RDS data. The
* data retrieved from Amazon RDS using SelectSqlQuery
* is stored in this location.
*
*
* -
*
* DataSchemaUri - Amazon S3 location of the DataSchema.
*
*
* -
*
* DataSchema - A JSON string representing the schema. This is not
* required if DataSchemaUri is specified.
*
*
* -
*
* DataRearrangement - A JSON string representing the splitting
* requirement of a Datasource.
*
*
*
* Sample -
* "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"
*
*
*/
public void setRDSData(RDSDataSpec rDSData) {
this.rDSData = rDSData;
}
/**
*
* The data specification of an Amazon RDS DataSource:
*
*
* -
*
* DatabaseInformation -
*
* -
DatabaseName - Name of the Amazon RDS database.
* -
InstanceIdentifier - Unique identifier for the Amazon
* RDS database instance.
*
*
*
* -
*
* DatabaseCredentials - AWS Identity and Access Management (IAM)
* credentials that are used to connect to the Amazon RDS database.
*
*
* -
*
* ResourceRole - Role (DataPipelineDefaultResourceRole) assumed by an
* Amazon Elastic Compute Cloud (EC2) instance to carry out the copy task
* from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.
*
*
* -
*
* ServiceRole - Role (DataPipelineDefaultRole) assumed by the AWS Data
* Pipeline service to monitor the progress of the copy task from Amazon RDS
* to Amazon Simple Storage Service (S3). For more information, see Role templates for data pipelines.
*
*
* -
*
* SecurityInfo - Security information to use to access an Amazon RDS
* instance. You need to set up appropriate ingress rules for the security
* entity IDs provided to allow access to the Amazon RDS instance. Specify a
* [SubnetId, SecurityGroupIds] pair for a
* VPC-based Amazon RDS instance.
*
*
* -
*
* SelectSqlQuery - Query that is used to retrieve the observation data for
* the Datasource.
*
*
* -
*
* S3StagingLocation - Amazon S3 location for staging RDS data. The data
* retrieved from Amazon RDS using SelectSqlQuery is stored in
* this location.
*
*
* -
*
* DataSchemaUri - Amazon S3 location of the DataSchema.
*
*
* -
*
* DataSchema - A JSON string representing the schema. This is not required
* if DataSchemaUri is specified.
*
*
* -
*
* DataRearrangement - A JSON string representing the splitting requirement
* of a Datasource.
*
*
*
* Sample -
* "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"
*
*
*
*
* @return The data specification of an Amazon RDS DataSource
* :
*
* -
*
* DatabaseInformation -
*
* -
DatabaseName - Name of the Amazon RDS database.
*
* -
InstanceIdentifier - Unique identifier for the
* Amazon RDS database instance.
*
*
*
* -
*
* DatabaseCredentials - AWS Identity and Access Management (IAM)
* credentials that are used to connect to the Amazon RDS database.
*
*
* -
*
* ResourceRole - Role (DataPipelineDefaultResourceRole) assumed by
* an Amazon Elastic Compute Cloud (EC2) instance to carry out the
* copy task from Amazon RDS to Amazon S3. For more information, see
* Role templates for data pipelines.
*
*
* -
*
* ServiceRole - Role (DataPipelineDefaultRole) assumed by the AWS
* Data Pipeline service to monitor the progress of the copy task
* from Amazon RDS to Amazon Simple Storage Service (S3). For more
* information, see Role templates for data pipelines.
*
*
* -
*
* SecurityInfo - Security information to use to access an Amazon
* RDS instance. You need to set up appropriate ingress rules for
* the security entity IDs provided to allow access to the Amazon
* RDS instance. Specify a [SubnetId,
* SecurityGroupIds] pair for a VPC-based Amazon RDS
* instance.
*
*
* -
*
* SelectSqlQuery - Query that is used to retrieve the observation
* data for the Datasource.
*
*
* -
*
* S3StagingLocation - Amazon S3 location for staging RDS data. The
* data retrieved from Amazon RDS using SelectSqlQuery
* is stored in this location.
*
*
* -
*
* DataSchemaUri - Amazon S3 location of the DataSchema
* .
*
*
* -
*
* DataSchema - A JSON string representing the schema. This is not
* required if DataSchemaUri is specified.
*
*
* -
*
* DataRearrangement - A JSON string representing the splitting
* requirement of a Datasource.
*
*
*
* Sample -
* "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"
*
*
*/
public RDSDataSpec getRDSData() {
return this.rDSData;
}
/**
*
* The data specification of an Amazon RDS DataSource:
*
*
* -
*
* DatabaseInformation -
*
* -
DatabaseName - Name of the Amazon RDS database.
* -
InstanceIdentifier - Unique identifier for the Amazon
* RDS database instance.
*
*
*
* -
*
* DatabaseCredentials - AWS Identity and Access Management (IAM)
* credentials that are used to connect to the Amazon RDS database.
*
*
* -
*
* ResourceRole - Role (DataPipelineDefaultResourceRole) assumed by an
* Amazon Elastic Compute Cloud (EC2) instance to carry out the copy task
* from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.
*
*
* -
*
* ServiceRole - Role (DataPipelineDefaultRole) assumed by the AWS Data
* Pipeline service to monitor the progress of the copy task from Amazon RDS
* to Amazon Simple Storage Service (S3). For more information, see Role templates for data pipelines.
*
*
* -
*
* SecurityInfo - Security information to use to access an Amazon RDS
* instance. You need to set up appropriate ingress rules for the security
* entity IDs provided to allow access to the Amazon RDS instance. Specify a
* [SubnetId, SecurityGroupIds] pair for a
* VPC-based Amazon RDS instance.
*
*
* -
*
* SelectSqlQuery - Query that is used to retrieve the observation data for
* the Datasource.
*
*
* -
*
* S3StagingLocation - Amazon S3 location for staging RDS data. The data
* retrieved from Amazon RDS using SelectSqlQuery is stored in
* this location.
*
*
* -
*
* DataSchemaUri - Amazon S3 location of the DataSchema.
*
*
* -
*
* DataSchema - A JSON string representing the schema. This is not required
* if DataSchemaUri is specified.
*
*
* -
*
* DataRearrangement - A JSON string representing the splitting requirement
* of a Datasource.
*
*
*
* Sample -
* "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"
*
*
*
*
* @param rDSData
* The data specification of an Amazon RDS DataSource
* :
*
* -
*
* DatabaseInformation -
*
* -
DatabaseName - Name of the Amazon RDS database.
* -
InstanceIdentifier - Unique identifier for the
* Amazon RDS database instance.
*
*
*
* -
*
* DatabaseCredentials - AWS Identity and Access Management (IAM)
* credentials that are used to connect to the Amazon RDS database.
*
*
* -
*
* ResourceRole - Role (DataPipelineDefaultResourceRole) assumed by
* an Amazon Elastic Compute Cloud (EC2) instance to carry out the
* copy task from Amazon RDS to Amazon S3. For more information, see
* Role templates for data pipelines.
*
*
* -
*
* ServiceRole - Role (DataPipelineDefaultRole) assumed by the AWS
* Data Pipeline service to monitor the progress of the copy task
* from Amazon RDS to Amazon Simple Storage Service (S3). For more
* information, see Role templates for data pipelines.
*
*
* -
*
* SecurityInfo - Security information to use to access an Amazon RDS
* instance. You need to set up appropriate ingress rules for the
* security entity IDs provided to allow access to the Amazon RDS
* instance. Specify a [SubnetId,
* SecurityGroupIds] pair for a VPC-based Amazon RDS
* instance.
*
*
* -
*
* SelectSqlQuery - Query that is used to retrieve the observation
* data for the Datasource.
*
*
* -
*
* S3StagingLocation - Amazon S3 location for staging RDS data. The
* data retrieved from Amazon RDS using SelectSqlQuery
* is stored in this location.
*
*
* -
*
* DataSchemaUri - Amazon S3 location of the DataSchema.
*
*
* -
*
* DataSchema - A JSON string representing the schema. This is not
* required if DataSchemaUri is specified.
*
*
* -
*
* DataRearrangement - A JSON string representing the splitting
* requirement of a Datasource.
*
*
*
* Sample -
* "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"
*
*
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateDataSourceFromRDSRequest withRDSData(RDSDataSpec rDSData) {
setRDSData(rDSData);
return this;
}
/**
*
* The role that Amazon ML assumes on behalf of the user to create and
* activate a data pipeline in the user’s account and copy data (using the
* SelectSqlQuery) query from Amazon RDS to Amazon S3.
*
*
*
*
* @param roleARN
* The role that Amazon ML assumes on behalf of the user to create
* and activate a data pipeline in the user’s account and copy data
* (using the SelectSqlQuery) query from Amazon RDS to
* Amazon S3.
*
*/
public void setRoleARN(String roleARN) {
this.roleARN = roleARN;
}
/**
*
* The role that Amazon ML assumes on behalf of the user to create and
* activate a data pipeline in the user’s account and copy data (using the
* SelectSqlQuery) query from Amazon RDS to Amazon S3.
*
*
*
*
* @return The role that Amazon ML assumes on behalf of the user to create
* and activate a data pipeline in the user’s account and copy data
* (using the SelectSqlQuery) query from Amazon RDS to
* Amazon S3.
*
*/
public String getRoleARN() {
return this.roleARN;
}
/**
*
* The role that Amazon ML assumes on behalf of the user to create and
* activate a data pipeline in the user’s account and copy data (using the
* SelectSqlQuery) query from Amazon RDS to Amazon S3.
*
*
*
*
* @param roleARN
* The role that Amazon ML assumes on behalf of the user to create
* and activate a data pipeline in the user’s account and copy data
* (using the SelectSqlQuery) query from Amazon RDS to
* Amazon S3.
*
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateDataSourceFromRDSRequest withRoleARN(String roleARN) {
setRoleARN(roleARN);
return this;
}
/**
*
* The compute statistics for a DataSource. The statistics are
* generated from the observation data referenced by a
* DataSource. Amazon ML uses the statistics internally during
* an MLModel training. This parameter must be set to
* true if the MLModel training.
*
*
* @param computeStatistics
* The compute statistics for a DataSource. The
* statistics are generated from the observation data referenced by a
* DataSource. Amazon ML uses the statistics internally
* during an MLModel training. This parameter must be
* set to true if the MLModel training.
*/
public void setComputeStatistics(Boolean computeStatistics) {
this.computeStatistics = computeStatistics;
}
/**
*
* The compute statistics for a DataSource. The statistics are
* generated from the observation data referenced by a
* DataSource. Amazon ML uses the statistics internally during
* an MLModel training. This parameter must be set to
* true if the MLModel training.
*
*
* @return The compute statistics for a DataSource. The
* statistics are generated from the observation data referenced by
* a DataSource. Amazon ML uses the statistics
* internally during an MLModel training. This
* parameter must be set to true if the MLModel
* training.
*/
public Boolean getComputeStatistics() {
return this.computeStatistics;
}
/**
*
* The compute statistics for a DataSource. The statistics are
* generated from the observation data referenced by a
* DataSource. Amazon ML uses the statistics internally during
* an MLModel training. This parameter must be set to
* true if the MLModel training.
*
*
* @param computeStatistics
* The compute statistics for a DataSource. The
* statistics are generated from the observation data referenced by a
* DataSource. Amazon ML uses the statistics internally
* during an MLModel training. This parameter must be
* set to true if the MLModel training.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public CreateDataSourceFromRDSRequest withComputeStatistics(
Boolean computeStatistics) {
setComputeStatistics(computeStatistics);
return this;
}
/**
*
* The compute statistics for a DataSource. The statistics are
* generated from the observation data referenced by a
* DataSource. Amazon ML uses the statistics internally during
* an MLModel training. This parameter must be set to
* true if the MLModel training.
*
*
* @return The compute statistics for a DataSource. The
* statistics are generated from the observation data referenced by
* a DataSource. Amazon ML uses the statistics
* internally during an MLModel training. This
* parameter must be set to true if the MLModel
* 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: " + getDataSourceId() + ",");
if (getDataSourceName() != null)
sb.append("DataSourceName: " + getDataSourceName() + ",");
if (getRDSData() != null)
sb.append("RDSData: " + getRDSData() + ",");
if (getRoleARN() != null)
sb.append("RoleARN: " + getRoleARN() + ",");
if (getComputeStatistics() != null)
sb.append("ComputeStatistics: " + 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 CreateDataSourceFromRDSRequest == false)
return false;
CreateDataSourceFromRDSRequest other = (CreateDataSourceFromRDSRequest) 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.getRDSData() == null ^ this.getRDSData() == null)
return false;
if (other.getRDSData() != null
&& other.getRDSData().equals(this.getRDSData()) == 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
+ ((getRDSData() == null) ? 0 : getRDSData().hashCode());
hashCode = prime * hashCode
+ ((getRoleARN() == null) ? 0 : getRoleARN().hashCode());
hashCode = prime
* hashCode
+ ((getComputeStatistics() == null) ? 0
: getComputeStatistics().hashCode());
return hashCode;
}
@Override
public CreateDataSourceFromRDSRequest clone() {
return (CreateDataSourceFromRDSRequest) super.clone();
}
}