Class CreateDatasetImportJobRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateDatasetImportJobRequest.Builder,
CreateDatasetImportJobRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The ARN of the dataset that receives the imported data.final DataSource
The Amazon S3 bucket that contains the training data to import.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final ImportMode
Specify how to add the new records to an existing dataset.final String
Specify how to add the new records to an existing dataset.final String
jobName()
The name for the dataset import job.final Boolean
If you created a metric attribution, specify whether to publish metrics for this import job to Amazon S3final String
roleArn()
The ARN of the IAM role that has permissions to read from the Amazon S3 data source.static Class
<? extends CreateDatasetImportJobRequest.Builder> tags()
A list of tags to apply to the dataset import job.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
jobName
The name for the dataset import job.
- Returns:
- The name for the dataset import job.
-
datasetArn
The ARN of the dataset that receives the imported data.
- Returns:
- The ARN of the dataset that receives the imported data.
-
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
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
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
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
FULL
to overwrite all existing bulk data in your dataset. Data you imported individually is not replaced. -
Specify
INCREMENTAL
to 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,
importMode
will 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
FULL
to overwrite all existing bulk data in your dataset. Data you imported individually is not replaced. -
Specify
INCREMENTAL
to 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:
-
-
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
FULL
to overwrite all existing bulk data in your dataset. Data you imported individually is not replaced. -
Specify
INCREMENTAL
to 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,
importMode
will 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
FULL
to overwrite all existing bulk data in your dataset. Data you imported individually is not replaced. -
Specify
INCREMENTAL
to 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:
-
-
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
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 interfaceToCopyableBuilder<CreateDatasetImportJobRequest.Builder,
CreateDatasetImportJobRequest> - Specified by:
toBuilder
in classPersonalizeRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-
sdkFields
-