Package software.amazon.awssdk.services.personalize.model

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>

  • Method Details

    • 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 BULK data that you imported using a dataset import job, only PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.

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

      Returns:
      The data to export, based on how you imported the data. You can choose to export only BULK data that you imported using a dataset import job, only PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.
      See Also:

    • ingestionModeAsString

      public final String ingestionModeAsString()

      The data to export, based on how you imported the data. You can choose to export only BULK data that you imported using a dataset import job, only PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.

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

      Returns:
      The data to export, based on how you imported the data. You can choose to export only BULK data that you imported using a dataset import job, only PUT data that you imported incrementally (using the console, PutEvents, PutUsers and PutItems operations), or ALL for both types. The default value is PUT.
      See Also:

    • 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 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()

      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()
      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<CreateDatasetExportJobRequest.Builder,CreateDatasetExportJobRequest>
      Specified by:
      toBuilder in class PersonalizeRequest
      Returns:
      a builder for type T

    • builder

      public static CreateDatasetExportJobRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateDatasetExportJobRequest.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.