Class CreateDatasetImportJobRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.personalize.model.PersonalizeRequest
-
- software.amazon.awssdk.services.personalize.model.CreateDatasetImportJobRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateDatasetImportJobRequest.Builder,CreateDatasetImportJobRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateDatasetImportJobRequest extends PersonalizeRequest implements ToCopyableBuilder<CreateDatasetImportJobRequest.Builder,CreateDatasetImportJobRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateDatasetImportJobRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateDatasetImportJobRequest.Builderbuilder()StringdatasetArn()The ARN of the dataset that receives the imported data.DataSourcedataSource()The Amazon S3 bucket that contains the training data to import.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.ImportModeimportMode()Specify how to add the new records to an existing dataset.StringimportModeAsString()Specify how to add the new records to an existing dataset.StringjobName()The name for the dataset import job.BooleanpublishAttributionMetricsToS3()If you created a metric attribution, specify whether to publish metrics for this import job to Amazon S3StringroleArn()The ARN of the IAM role that has permissions to read from the Amazon S3 data source.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CreateDatasetImportJobRequest.Builder>serializableBuilderClass()List<Tag>tags()A list of tags to apply to the dataset import job.CreateDatasetImportJobRequest.BuildertoBuilder()StringtoString()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
-
jobName
public final String jobName()
The name for the dataset import job.
- Returns:
- The name for the dataset import job.
-
datasetArn
public final String datasetArn()
The ARN of the dataset that receives the imported data.
- Returns:
- The ARN of the dataset that receives the imported data.
-
dataSource
public final DataSource dataSource()
The Amazon S3 bucket that contains the training data to import.
- Returns:
- The Amazon S3 bucket that contains the training data to import.
-
roleArn
public final String roleArn()
The ARN of the IAM role that has permissions to read from the Amazon S3 data source.
- Returns:
- The ARN of the IAM role that has permissions to read from the Amazon S3 data source.
-
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 theisEmpty()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()
A list of tags to apply to the dataset import job.
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:
- A list of tags to apply to the dataset import job.
-
importMode
public final ImportMode importMode()
Specify how to add the new records to an existing dataset. The default import mode is
FULL. If you haven't imported bulk records into the dataset previously, you can only specifyFULL.-
Specify
FULLto overwrite all existing bulk data in your dataset. Data you imported individually is not replaced. -
Specify
INCREMENTALto append the new records to the existing data in your dataset. Amazon Personalize replaces any record with the same ID with the new one.
If the service returns an enum value that is not available in the current SDK version,
importModewill returnImportMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromimportModeAsString().- Returns:
- Specify how to add the new records to an existing dataset. The default import mode is
FULL. If you haven't imported bulk records into the dataset previously, you can only specifyFULL.-
Specify
FULLto overwrite all existing bulk data in your dataset. Data you imported individually is not replaced. -
Specify
INCREMENTALto append the new records to the existing data in your dataset. Amazon Personalize replaces any record with the same ID with the new one.
-
- See Also:
ImportMode
-
-
importModeAsString
public final String importModeAsString()
Specify how to add the new records to an existing dataset. The default import mode is
FULL. If you haven't imported bulk records into the dataset previously, you can only specifyFULL.-
Specify
FULLto overwrite all existing bulk data in your dataset. Data you imported individually is not replaced. -
Specify
INCREMENTALto append the new records to the existing data in your dataset. Amazon Personalize replaces any record with the same ID with the new one.
If the service returns an enum value that is not available in the current SDK version,
importModewill returnImportMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromimportModeAsString().- Returns:
- Specify how to add the new records to an existing dataset. The default import mode is
FULL. If you haven't imported bulk records into the dataset previously, you can only specifyFULL.-
Specify
FULLto overwrite all existing bulk data in your dataset. Data you imported individually is not replaced. -
Specify
INCREMENTALto append the new records to the existing data in your dataset. Amazon Personalize replaces any record with the same ID with the new one.
-
- See Also:
ImportMode
-
-
publishAttributionMetricsToS3
public final Boolean publishAttributionMetricsToS3()
If you created a metric attribution, specify whether to publish metrics for this import job to Amazon S3
- Returns:
- If you created a metric attribution, specify whether to publish metrics for this import job to Amazon S3
-
toBuilder
public CreateDatasetImportJobRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateDatasetImportJobRequest.Builder,CreateDatasetImportJobRequest>- Specified by:
toBuilderin classPersonalizeRequest
-
builder
public static CreateDatasetImportJobRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateDatasetImportJobRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-