software.amazon.awssdk.services.machinelearning.model

Class CreateDataSourceFromRedshiftRequest

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.CreateDataSourceFromRedshiftRequest

All Implemented Interfaces:

ToCopyableBuilder<CreateDataSourceFromRedshiftRequest.Builder,CreateDataSourceFromRedshiftRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateDataSourceFromRedshiftRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateDataSourceFromRedshiftRequest.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.
RedshiftDataSpec	dataSpec() The data specification of an Amazon Redshift 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()
String	roleARN() A fully specified role Amazon Resource Name (ARN).
static Class<? extends CreateDataSourceFromRedshiftRequest.Builder>	serializableBuilderClass()
CreateDataSourceFromRedshiftRequest.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

requestOverrideConfig

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.

Returns:

A user-supplied ID that uniquely identifies the DataSource.

dataSourceName

public String dataSourceName()

A user-supplied name or description of the DataSource.

Returns:

A user-supplied name or description of the DataSource.

dataSpec

public RedshiftDataSpec dataSpec()

The data specification of an Amazon Redshift DataSource:

• DatabaseInformation -

  • DatabaseName - The name of the Amazon Redshift database.
  • ClusterIdentifier - The unique ID for the Amazon Redshift cluster.

• DatabaseCredentials - The AWS Identity and Access Management (IAM) credentials that are used to connect to the Amazon Redshift database.

• SelectSqlQuery - The query that is used to retrieve the observation data for the Datasource.

• S3StagingLocation - The Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift data. The data retrieved from Amazon Redshift using the SelectSqlQuery query 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 Redshift DataSource:

• DatabaseInformation -

  • DatabaseName - The name of the Amazon Redshift database.
  • ClusterIdentifier - The unique ID for the Amazon Redshift cluster.

• DatabaseCredentials - The AWS Identity and Access Management (IAM) credentials that are used to connect to the Amazon Redshift database.

• SelectSqlQuery - The query that is used to retrieve the observation data for the Datasource.

• S3StagingLocation - The Amazon Simple Storage Service (Amazon S3) location for staging Amazon Redshift data. The data retrieved from Amazon Redshift using the SelectSqlQuery query 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()

A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to create the following:

• A security group to allow Amazon ML to execute the SelectSqlQuery query on an Amazon Redshift cluster

• An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the S3StagingLocation

Returns:

A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to create the following:

• A security group to allow Amazon ML to execute the SelectSqlQuery query on an Amazon Redshift cluster

• An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the S3StagingLocation

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 CreateDataSourceFromRedshiftRequest.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<CreateDataSourceFromRedshiftRequest.Builder,CreateDataSourceFromRedshiftRequest>

Specified by:

toBuilder in class MachineLearningRequest

Returns:

a builder for type T

builder

public static CreateDataSourceFromRedshiftRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateDataSourceFromRedshiftRequest.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