CreateDataSourceFromRdsRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.machinelearning.model.MachineLearningRequest
    - - software.amazon.awssdk.services.machinelearning.model.CreateDataSourceFromRdsRequest

All Implemented Interfaces:: ToCopyableBuilder<CreateDataSourceFromRdsRequest.Builder,CreateDataSourceFromRdsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateDataSourceFromRdsRequest
extends MachineLearningRequest
implements ToCopyableBuilder<CreateDataSourceFromRdsRequest.Builder,CreateDataSourceFromRdsRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateDataSourceFromRdsRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateDataSourceFromRdsRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateDataSourceFromRdsRequest.Builder`	`builder()`
`Boolean`	`computeStatistics()` The compute statistics for a `DataSource`.
`String`	`dataSourceId()` A user-supplied ID that uniquely identifies the `DataSource`.
`String`	`dataSourceName()` A user-supplied name or description of the `DataSource`.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`RDSDataSpec`	`rdsData()` The data specification of an Amazon RDS `DataSource`:
`String`	`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.
`static Class<? extends CreateDataSourceFromRdsRequest.Builder>`	`serializableBuilderClass()`
`CreateDataSourceFromRdsRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - dataSourceId
```
public String dataSourceId()
```
    A user-supplied ID that uniquely identifies the DataSource. Typically, an Amazon Resource Number (ARN) becomes the ID for a DataSource.
    
    Returns:
    
    A user-supplied ID that uniquely identifies the DataSource. Typically, an Amazon Resource Number (ARN) becomes the ID for a DataSource.
  - dataSourceName
```
public String dataSourceName()
```
    A user-supplied name or description of the DataSource.
    
    Returns:
    
    A user-supplied name or description of the DataSource.
  - rdsData
```
public RDSDataSpec rdsData()
```
    The data specification of an Amazon RDS DataSource:
    - DatabaseInformation -
      
      DatabaseName - The name of the Amazon RDS database.
      
      InstanceIdentifier - A 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 - A role (DataPipelineDefaultResourceRole) assumed by an EC2 instance to carry out the copy task from Amazon RDS to Amazon Simple Storage Service (Amazon S3). For more information, see Role templates for data pipelines.
    - ServiceRole - A role (DataPipelineDefaultRole) assumed by the 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.
    - SecurityInfo - The security information to use to access an RDS DB 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 RDS DB instance.
    - SelectSqlQuery - A query that is used to retrieve the observation data for the Datasource.
    - S3StagingLocation - The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.
    - DataSchemaUri - The 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 that represents the splitting and rearrangement requirements for the Datasource.
      
      Sample - "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"
    Returns:
    The data specification of an Amazon RDS DataSource:
    
    DatabaseInformation -
    
    DatabaseName - The name of the Amazon RDS database.
    
    InstanceIdentifier - A 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 - A role (DataPipelineDefaultResourceRole) assumed by an EC2 instance to carry out the copy task from Amazon RDS to Amazon Simple Storage Service (Amazon S3). For more information, see Role templates for data pipelines.
    
    ServiceRole - A role (DataPipelineDefaultRole) assumed by the 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.
    
    SecurityInfo - The security information to use to access an RDS DB 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 RDS DB instance.
    
    SelectSqlQuery - A query that is used to retrieve the observation data for the Datasource.
    
    S3StagingLocation - The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using SelectSqlQuery is stored in this location.
    
    DataSchemaUri - The 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 that represents the splitting and rearrangement requirements for the Datasource.
    
    Sample - "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"
  - roleARN
```
public String 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.
    
    Returns:
    
    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.
  - computeStatistics
```
public Boolean 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 MLModel training. This parameter must be set to true if the DataSource needs to be used for MLModel training.
    
    Returns:
    
    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 MLModel training. This parameter must be set to true if the DataSource needs to be used for MLModel training.
  - toBuilder
```
public CreateDataSourceFromRdsRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateDataSourceFromRdsRequest.Builder,CreateDataSourceFromRdsRequest>
    
    Specified by:
    
    toBuilder in class MachineLearningRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static CreateDataSourceFromRdsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateDataSourceFromRdsRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value

Class CreateDataSourceFromRdsRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

dataSourceId

dataSourceName

rdsData

roleARN

computeStatistics

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField