Class ExportDestination

java.lang.Object
software.amazon.awssdk.services.sesv2.model.ExportDestination
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ExportDestination.Builder,ExportDestination>
@Generated("software.amazon.awssdk:codegen") public final class ExportDestination extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ExportDestination.Builder,ExportDestination>

An object that contains details about the destination of the export job.

When you create an export job, specify only DataFormat. SES writes the export file to a location that it manages. After the job completes, call GetExportJob and use the S3Url that's returned to download the file. To store a copy in your own Amazon S3 bucket, upload the downloaded file to your bucket. Do not include S3Url in the CreateExportJob request.

See Also:

  • Method Details

    • dataFormat

      public final DataFormat dataFormat()

      The data format of the final export job file, can be one of the following:

      • CSV - A comma-separated values file.

      • JSON - A Json file.

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

      Returns:
      The data format of the final export job file, can be one of the following:

      • CSV - A comma-separated values file.

      • JSON - A Json file.

      See Also:

    • dataFormatAsString

      public final String dataFormatAsString()

      The data format of the final export job file, can be one of the following:

      • CSV - A comma-separated values file.

      • JSON - A Json file.

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

      Returns:
      The data format of the final export job file, can be one of the following:

      • CSV - A comma-separated values file.

      • JSON - A Json file.

      See Also:

    • s3Url

      public final String s3Url()

      An Amazon S3 pre-signed URL that points to the generated export file.

      SES sets this value. It's returned only in the GetExportJob response, after the export job status is COMPLETED. The URL expires five minutes after GetExportJob returns it. Call GetExportJob again to get a new URL. If you include this field in a CreateExportJob request, the request fails with a BadRequestException.

      Returns:
      An Amazon S3 pre-signed URL that points to the generated export file.

      SES sets this value. It's returned only in the GetExportJob response, after the export job status is COMPLETED. The URL expires five minutes after GetExportJob returns it. Call GetExportJob again to get a new URL. If you include this field in a CreateExportJob request, the request fails with a BadRequestException.

    • toBuilder

      public ExportDestination.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<ExportDestination.Builder,ExportDestination>
      Returns:
      a builder for type T

    • builder

      public static ExportDestination.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.