Class RDSDataSpec

    • Constructor Detail

      • RDSDataSpec

        public RDSDataSpec()
    • Method Detail

      • setDatabaseInformation

        public void setDatabaseInformation​(RDSDatabase databaseInformation)

        Describes the DatabaseName and InstanceIdentifier of an an Amazon RDS database.

        Parameters:
        databaseInformation - Describes the DatabaseName and InstanceIdentifier of an an Amazon RDS database.
      • getDatabaseInformation

        public RDSDatabase getDatabaseInformation()

        Describes the DatabaseName and InstanceIdentifier of an an Amazon RDS database.

        Returns:
        Describes the DatabaseName and InstanceIdentifier of an an Amazon RDS database.
      • withDatabaseInformation

        public RDSDataSpec withDatabaseInformation​(RDSDatabase databaseInformation)

        Describes the DatabaseName and InstanceIdentifier of an an Amazon RDS database.

        Parameters:
        databaseInformation - Describes the DatabaseName and InstanceIdentifier of an an Amazon RDS database.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setSelectSqlQuery

        public void setSelectSqlQuery​(String selectSqlQuery)

        The query that is used to retrieve the observation data for the DataSource.

        Parameters:
        selectSqlQuery - The query that is used to retrieve the observation data for the DataSource.
      • getSelectSqlQuery

        public String getSelectSqlQuery()

        The query that is used to retrieve the observation data for the DataSource.

        Returns:
        The query that is used to retrieve the observation data for the DataSource.
      • withSelectSqlQuery

        public RDSDataSpec withSelectSqlQuery​(String selectSqlQuery)

        The query that is used to retrieve the observation data for the DataSource.

        Parameters:
        selectSqlQuery - The query that is used to retrieve the observation data for the DataSource.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setDatabaseCredentials

        public void setDatabaseCredentials​(RDSDatabaseCredentials databaseCredentials)

        The AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon RDS database.

        Parameters:
        databaseCredentials - The AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon RDS database.
      • getDatabaseCredentials

        public RDSDatabaseCredentials getDatabaseCredentials()

        The AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon RDS database.

        Returns:
        The AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon RDS database.
      • withDatabaseCredentials

        public RDSDataSpec withDatabaseCredentials​(RDSDatabaseCredentials databaseCredentials)

        The AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon RDS database.

        Parameters:
        databaseCredentials - The AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon RDS database.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setS3StagingLocation

        public void setS3StagingLocation​(String s3StagingLocation)

        The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.

        Parameters:
        s3StagingLocation - The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.
      • getS3StagingLocation

        public String getS3StagingLocation()

        The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.

        Returns:
        The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.
      • withS3StagingLocation

        public RDSDataSpec withS3StagingLocation​(String s3StagingLocation)

        The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.

        Parameters:
        s3StagingLocation - The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setDataRearrangement

        public void setDataRearrangement​(String dataRearrangement)

        DataRearrangement - A JSON string that represents the splitting requirement of a DataSource.


        Sample - "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"

        Parameters:
        dataRearrangement - DataRearrangement - A JSON string that represents the splitting requirement of a DataSource.


        Sample - "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"

      • getDataRearrangement

        public String getDataRearrangement()

        DataRearrangement - A JSON string that represents the splitting requirement of a DataSource.


        Sample - "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"

        Returns:
        DataRearrangement - A JSON string that represents the splitting requirement of a DataSource.


        Sample - "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"

      • withDataRearrangement

        public RDSDataSpec withDataRearrangement​(String dataRearrangement)

        DataRearrangement - A JSON string that represents the splitting requirement of a DataSource.


        Sample - "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"

        Parameters:
        dataRearrangement - DataRearrangement - A JSON string that represents the splitting requirement of a DataSource.


        Sample - "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setDataSchema

        public void setDataSchema​(String dataSchema)

        A JSON string that represents the schema for an Amazon RDS DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource.

        A DataSchema is not required if you specify a DataSchemaUri

        Define your DataSchema as a series of key-value pairs. attributes and excludedVariableNames have an array of key-value pairs for their value. Use the following format to define your DataSchema.

        { "version": "1.0",

        "recordAnnotationFieldName": "F1",

        "recordWeightFieldName": "F2",

        "targetFieldName": "F3",

        "dataFormat": "CSV",

        "dataFileContainsHeader": true,

        "attributes": [

        { "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ],

        "excludedVariableNames": [ "F6" ] }

        Parameters:
        dataSchema - A JSON string that represents the schema for an Amazon RDS DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource.

        A DataSchema is not required if you specify a DataSchemaUri

        Define your DataSchema as a series of key-value pairs. attributes and excludedVariableNames have an array of key-value pairs for their value. Use the following format to define your DataSchema.

        { "version": "1.0",

        "recordAnnotationFieldName": "F1",

        "recordWeightFieldName": "F2",

        "targetFieldName": "F3",

        "dataFormat": "CSV",

        "dataFileContainsHeader": true,

        "attributes": [

        { "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ],

        "excludedVariableNames": [ "F6" ] }

      • getDataSchema

        public String getDataSchema()

        A JSON string that represents the schema for an Amazon RDS DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource.

        A DataSchema is not required if you specify a DataSchemaUri

        Define your DataSchema as a series of key-value pairs. attributes and excludedVariableNames have an array of key-value pairs for their value. Use the following format to define your DataSchema.

        { "version": "1.0",

        "recordAnnotationFieldName": "F1",

        "recordWeightFieldName": "F2",

        "targetFieldName": "F3",

        "dataFormat": "CSV",

        "dataFileContainsHeader": true,

        "attributes": [

        { "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ],

        "excludedVariableNames": [ "F6" ] }

        Returns:
        A JSON string that represents the schema for an Amazon RDS DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource.

        A DataSchema is not required if you specify a DataSchemaUri

        Define your DataSchema as a series of key-value pairs. attributes and excludedVariableNames have an array of key-value pairs for their value. Use the following format to define your DataSchema.

        { "version": "1.0",

        "recordAnnotationFieldName": "F1",

        "recordWeightFieldName": "F2",

        "targetFieldName": "F3",

        "dataFormat": "CSV",

        "dataFileContainsHeader": true,

        "attributes": [

        { "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ],

        "excludedVariableNames": [ "F6" ] }

      • withDataSchema

        public RDSDataSpec withDataSchema​(String dataSchema)

        A JSON string that represents the schema for an Amazon RDS DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource.

        A DataSchema is not required if you specify a DataSchemaUri

        Define your DataSchema as a series of key-value pairs. attributes and excludedVariableNames have an array of key-value pairs for their value. Use the following format to define your DataSchema.

        { "version": "1.0",

        "recordAnnotationFieldName": "F1",

        "recordWeightFieldName": "F2",

        "targetFieldName": "F3",

        "dataFormat": "CSV",

        "dataFileContainsHeader": true,

        "attributes": [

        { "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ],

        "excludedVariableNames": [ "F6" ] }

        Parameters:
        dataSchema - A JSON string that represents the schema for an Amazon RDS DataSource. The DataSchema defines the structure of the observation data in the data file(s) referenced in the DataSource.

        A DataSchema is not required if you specify a DataSchemaUri

        Define your DataSchema as a series of key-value pairs. attributes and excludedVariableNames have an array of key-value pairs for their value. Use the following format to define your DataSchema.

        { "version": "1.0",

        "recordAnnotationFieldName": "F1",

        "recordWeightFieldName": "F2",

        "targetFieldName": "F3",

        "dataFormat": "CSV",

        "dataFileContainsHeader": true,

        "attributes": [

        { "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ],

        "excludedVariableNames": [ "F6" ] }

        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setDataSchemaUri

        public void setDataSchemaUri​(String dataSchemaUri)

        The Amazon S3 location of the DataSchema.

        Parameters:
        dataSchemaUri - The Amazon S3 location of the DataSchema.
      • getDataSchemaUri

        public String getDataSchemaUri()

        The Amazon S3 location of the DataSchema.

        Returns:
        The Amazon S3 location of the DataSchema.
      • withDataSchemaUri

        public RDSDataSpec withDataSchemaUri​(String dataSchemaUri)

        The Amazon S3 location of the DataSchema.

        Parameters:
        dataSchemaUri - The Amazon S3 location of the DataSchema.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setResourceRole

        public void setResourceRole​(String resourceRole)

        The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to an Amazon S3 task. For more information, see Role templates for data pipelines.

        Parameters:
        resourceRole - The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to an Amazon S3 task. For more information, see Role templates for data pipelines.
      • getResourceRole

        public String getResourceRole()

        The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to an Amazon S3 task. For more information, see Role templates for data pipelines.

        Returns:
        The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to an Amazon S3 task. For more information, see Role templates for data pipelines.
      • withResourceRole

        public RDSDataSpec withResourceRole​(String resourceRole)

        The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to an Amazon S3 task. For more information, see Role templates for data pipelines.

        Parameters:
        resourceRole - The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to an Amazon S3 task. For more information, see Role templates for data pipelines.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setServiceRole

        public void setServiceRole​(String serviceRole)

        The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.

        Parameters:
        serviceRole - The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.
      • getServiceRole

        public String getServiceRole()

        The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.

        Returns:
        The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.
      • withServiceRole

        public RDSDataSpec withServiceRole​(String serviceRole)

        The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.

        Parameters:
        serviceRole - The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see Role templates for data pipelines.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setSubnetId

        public void setSubnetId​(String subnetId)

        The subnet ID to be used to access a VPC-based RDS DB instance. This attribute is used by Data Pipeline to carry out the copy task from Amazon RDS to Amazon S3.

        Parameters:
        subnetId - The subnet ID to be used to access a VPC-based RDS DB instance. This attribute is used by Data Pipeline to carry out the copy task from Amazon RDS to Amazon S3.
      • getSubnetId

        public String getSubnetId()

        The subnet ID to be used to access a VPC-based RDS DB instance. This attribute is used by Data Pipeline to carry out the copy task from Amazon RDS to Amazon S3.

        Returns:
        The subnet ID to be used to access a VPC-based RDS DB instance. This attribute is used by Data Pipeline to carry out the copy task from Amazon RDS to Amazon S3.
      • withSubnetId

        public RDSDataSpec withSubnetId​(String subnetId)

        The subnet ID to be used to access a VPC-based RDS DB instance. This attribute is used by Data Pipeline to carry out the copy task from Amazon RDS to Amazon S3.

        Parameters:
        subnetId - The subnet ID to be used to access a VPC-based RDS DB instance. This attribute is used by Data Pipeline to carry out the copy task from Amazon RDS to Amazon S3.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • getSecurityGroupIds

        public List<String> getSecurityGroupIds()

        The security group IDs to be used to access a VPC-based RDS DB instance. Ensure that there are appropriate ingress rules set up to allow access to the RDS DB instance. This attribute is used by Data Pipeline to carry out the copy operation from Amazon RDS to an Amazon S3 task.

        Returns:
        The security group IDs to be used to access a VPC-based RDS DB instance. Ensure that there are appropriate ingress rules set up to allow access to the RDS DB instance. This attribute is used by Data Pipeline to carry out the copy operation from Amazon RDS to an Amazon S3 task.
      • setSecurityGroupIds

        public void setSecurityGroupIds​(Collection<String> securityGroupIds)

        The security group IDs to be used to access a VPC-based RDS DB instance. Ensure that there are appropriate ingress rules set up to allow access to the RDS DB instance. This attribute is used by Data Pipeline to carry out the copy operation from Amazon RDS to an Amazon S3 task.

        Parameters:
        securityGroupIds - The security group IDs to be used to access a VPC-based RDS DB instance. Ensure that there are appropriate ingress rules set up to allow access to the RDS DB instance. This attribute is used by Data Pipeline to carry out the copy operation from Amazon RDS to an Amazon S3 task.
      • withSecurityGroupIds

        public RDSDataSpec withSecurityGroupIds​(String... securityGroupIds)

        The security group IDs to be used to access a VPC-based RDS DB instance. Ensure that there are appropriate ingress rules set up to allow access to the RDS DB instance. This attribute is used by Data Pipeline to carry out the copy operation from Amazon RDS to an Amazon S3 task.

        NOTE: This method appends the values to the existing list (if any). Use setSecurityGroupIds(java.util.Collection) or withSecurityGroupIds(java.util.Collection) if you want to override the existing values.

        Parameters:
        securityGroupIds - The security group IDs to be used to access a VPC-based RDS DB instance. Ensure that there are appropriate ingress rules set up to allow access to the RDS DB instance. This attribute is used by Data Pipeline to carry out the copy operation from Amazon RDS to an Amazon S3 task.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • withSecurityGroupIds

        public RDSDataSpec withSecurityGroupIds​(Collection<String> securityGroupIds)

        The security group IDs to be used to access a VPC-based RDS DB instance. Ensure that there are appropriate ingress rules set up to allow access to the RDS DB instance. This attribute is used by Data Pipeline to carry out the copy operation from Amazon RDS to an Amazon S3 task.

        Parameters:
        securityGroupIds - The security group IDs to be used to access a VPC-based RDS DB instance. Ensure that there are appropriate ingress rules set up to allow access to the RDS DB instance. This attribute is used by Data Pipeline to carry out the copy operation from Amazon RDS to an Amazon S3 task.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • toString

        public String toString()
        Returns a string representation of this object; useful for testing and debugging.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object