Package software.amazon.awssdk.services.comprehend.model

Class CreateFlywheelRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.comprehend.model.ComprehendRequest

software.amazon.awssdk.services.comprehend.model.CreateFlywheelRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateFlywheelRequest.Builder,CreateFlywheelRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateFlywheelRequest
extends ComprehendRequest
implements ToCopyableBuilder<CreateFlywheelRequest.Builder,CreateFlywheelRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateFlywheelRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	activeModelArn()	To associate an existing model with the flywheel, specify the Amazon Resource Number (ARN) of the model version.
static CreateFlywheelRequest.Builder	builder()
String	clientRequestToken()	A unique identifier for the request.
String	dataAccessRoleArn()	The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend the permissions required to access the flywheel data in the data lake.
String	dataLakeS3Uri()	Enter the S3 location for the data lake.
DataSecurityConfig	dataSecurityConfig()	Data security configurations.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	flywheelName()	Name for the flywheel.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
ModelType	modelType()	The model type.
String	modelTypeAsString()	The model type.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateFlywheelRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	The tags to associate with this flywheel.
TaskConfig	taskConfig()	Configuration about the model associated with the flywheel.
CreateFlywheelRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

flywheelName

public final String flywheelName()

Name for the flywheel.

Returns:

Name for the flywheel.

activeModelArn

public final String activeModelArn()

To associate an existing model with the flywheel, specify the Amazon Resource Number (ARN) of the model version. Do not set TaskConfig or ModelType if you specify an ActiveModelArn.

Returns:

To associate an existing model with the flywheel, specify the Amazon Resource Number (ARN) of the model version. Do not set TaskConfig or ModelType if you specify an ActiveModelArn.

dataAccessRoleArn

public final String dataAccessRoleArn()

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend the permissions required to access the flywheel data in the data lake.

Returns:

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend the permissions required to access the flywheel data in the data lake.

taskConfig

public final TaskConfig taskConfig()

Configuration about the model associated with the flywheel. You need to set TaskConfig if you are creating a flywheel for a new model.

Returns:

Configuration about the model associated with the flywheel. You need to set TaskConfig if you are creating a flywheel for a new model.

modelType

public final ModelType modelType()

The model type. You need to set ModelType if you are creating a flywheel for a new model.

If the service returns an enum value that is not available in the current SDK version, modelType will return ModelType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modelTypeAsString().

Returns:

The model type. You need to set ModelType if you are creating a flywheel for a new model.

See Also:

ModelType

modelTypeAsString

public final String modelTypeAsString()

The model type. You need to set ModelType if you are creating a flywheel for a new model.

If the service returns an enum value that is not available in the current SDK version, modelType will return ModelType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modelTypeAsString().

Returns:

The model type. You need to set ModelType if you are creating a flywheel for a new model.

See Also:

ModelType

dataLakeS3Uri

public final String dataLakeS3Uri()

Enter the S3 location for the data lake. You can specify a new S3 bucket or a new folder of an existing S3 bucket. The flywheel creates the data lake at this location.

Returns:

Enter the S3 location for the data lake. You can specify a new S3 bucket or a new folder of an existing S3 bucket. The flywheel creates the data lake at this location.

dataSecurityConfig

public final DataSecurityConfig dataSecurityConfig()

Data security configurations.

Returns:

Data security configurations.

clientRequestToken

public final String clientRequestToken()

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

Returns:

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

The tags to associate with this flywheel.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

The tags to associate with this flywheel.

toBuilder

public CreateFlywheelRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateFlywheelRequest.Builder,CreateFlywheelRequest>

Specified by:

toBuilder in class ComprehendRequest

builder

public static CreateFlywheelRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateFlywheelRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo