Package software.amazon.awssdk.services.pinpoint.model

Class ExportJobResponse

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

Provides information about the status and settings of a job that exports endpoint definitions to a file. The file can be added directly to an Amazon Simple Storage Service (Amazon S3) bucket by using the Amazon Pinpoint API or downloaded directly to a computer by using the Amazon Pinpoint console.

See Also:

  • Method Details

    • applicationId

      public final String applicationId()

      The unique identifier for the application that's associated with the export job.

      Returns:
      The unique identifier for the application that's associated with the export job.

    • completedPieces

      public final Integer completedPieces()

      The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.

      Returns:
      The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.

    • completionDate

      public final String completionDate()

      The date, in ISO 8601 format, when the export job was completed.

      Returns:
      The date, in ISO 8601 format, when the export job was completed.

    • creationDate

      public final String creationDate()

      The date, in ISO 8601 format, when the export job was created.

      Returns:
      The date, in ISO 8601 format, when the export job was created.

    • definition

      public final ExportJobResource definition()

      The resource settings that apply to the export job.

      Returns:
      The resource settings that apply to the export job.

    • failedPieces

      public final Integer failedPieces()

      The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.

      Returns:
      The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.

    • hasFailures

      public final boolean hasFailures()
      For responses, this returns true if the service returned a value for the Failures 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.

    • failures

      public final List<String> failures()

      An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.

      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 hasFailures() method.

      Returns:
      An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.

    • id

      public final String id()

      The unique identifier for the export job.

      Returns:
      The unique identifier for the export job.

    • jobStatus

      public final JobStatus jobStatus()

      The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.

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

      Returns:
      The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
      See Also:

    • jobStatusAsString

      public final String jobStatusAsString()

      The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.

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

      Returns:
      The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
      See Also:

    • totalFailures

      public final Integer totalFailures()

      The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.

      Returns:
      The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.

    • totalPieces

      public final Integer totalPieces()

      The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.

      Returns:
      The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.

    • totalProcessed

      public final Integer totalProcessed()

      The total number of endpoint definitions that were processed by the export job.

      Returns:
      The total number of endpoint definitions that were processed by the export job.

    • type

      public final String type()

      The job type. This value is EXPORT for export jobs.

      Returns:
      The job type. This value is EXPORT for export jobs.

    • toBuilder

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

    • builder

      public static ExportJobResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ExportJobResponse.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.