Class CreateDatasetExportJobRequest
- 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.CreateDatasetExportJobRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateDatasetExportJobRequest.Builder,CreateDatasetExportJobRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateDatasetExportJobRequest extends PersonalizeRequest implements ToCopyableBuilder<CreateDatasetExportJobRequest.Builder,CreateDatasetExportJobRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateDatasetExportJobRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateDatasetExportJobRequest.Builderbuilder()StringdatasetArn()The Amazon Resource Name (ARN) of the dataset that contains the data to export.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.IngestionModeingestionMode()The data to export, based on how you imported the data.StringingestionModeAsString()The data to export, based on how you imported the data.StringjobName()The name for the dataset export job.DatasetExportJobOutputjobOutput()The path to the Amazon S3 bucket where the job's output is stored.StringroleArn()The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.List<SdkField<?>>sdkFields()static Class<? extends CreateDatasetExportJobRequest.Builder>serializableBuilderClass()List<Tag>tags()A list of tags to apply to the dataset export job.CreateDatasetExportJobRequest.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 export job.
- Returns:
- The name for the dataset export job.
-
datasetArn
public final String datasetArn()
The Amazon Resource Name (ARN) of the dataset that contains the data to export.
- Returns:
- The Amazon Resource Name (ARN) of the dataset that contains the data to export.
-
ingestionMode
public final IngestionMode ingestionMode()
The data to export, based on how you imported the data. You can choose to export only
BULKdata that you imported using a dataset import job, onlyPUTdata that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), orALLfor both types. The default value isPUT.If the service returns an enum value that is not available in the current SDK version,
ingestionModewill returnIngestionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromingestionModeAsString().- Returns:
- The data to export, based on how you imported the data. You can choose to export only
BULKdata that you imported using a dataset import job, onlyPUTdata that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), orALLfor both types. The default value isPUT. - See Also:
IngestionMode
-
ingestionModeAsString
public final String ingestionModeAsString()
The data to export, based on how you imported the data. You can choose to export only
BULKdata that you imported using a dataset import job, onlyPUTdata that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), orALLfor both types. The default value isPUT.If the service returns an enum value that is not available in the current SDK version,
ingestionModewill returnIngestionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromingestionModeAsString().- Returns:
- The data to export, based on how you imported the data. You can choose to export only
BULKdata that you imported using a dataset import job, onlyPUTdata that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), orALLfor both types. The default value isPUT. - See Also:
IngestionMode
-
roleArn
public final String roleArn()
The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.
- Returns:
- The Amazon Resource Name (ARN) of the IAM service role that has permissions to add data to your output Amazon S3 bucket.
-
jobOutput
public final DatasetExportJobOutput jobOutput()
The path to the Amazon S3 bucket where the job's output is stored.
- Returns:
- The path to the Amazon S3 bucket where the job's output is stored.
-
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 export 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 export job.
-
toBuilder
public CreateDatasetExportJobRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateDatasetExportJobRequest.Builder,CreateDatasetExportJobRequest>- Specified by:
toBuilderin classPersonalizeRequest
-
builder
public static CreateDatasetExportJobRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateDatasetExportJobRequest.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
-
-