Class GetUploadJobResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.customerprofiles.model.CustomerProfilesResponse
software.amazon.awssdk.services.customerprofiles.model.GetUploadJobResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetUploadJobResponse.Builder,GetUploadJobResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetUploadJobResponse extends CustomerProfilesResponse implements ToCopyableBuilder<GetUploadJobResponse.Builder,GetUploadJobResponse>

  • Method Details

    • jobId

      public final String jobId()

      The unique identifier of the upload job.

      Returns:
      The unique identifier of the upload job.

    • displayName

      public final String displayName()

      The unique name of the upload job. Could be a file name to identify the upload job.

      Returns:
      The unique name of the upload job. Could be a file name to identify the upload job.

    • status

      public final UploadJobStatus status()

      The status describing the status for the upload job. The following are Valid Values:

      • CREATED: The upload job has been created, but has not started processing yet.

      • IN_PROGRESS: The upload job is currently in progress, ingesting and processing the profile data.

      • PARTIALLY_SUCCEEDED: The upload job has successfully completed the ingestion and processing of all profile data.

      • SUCCEEDED: The upload job has successfully completed the ingestion and processing of all profile data.

      • FAILED: The upload job has failed to complete.

      • STOPPED: The upload job has been manually stopped or terminated before completion.

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

      Returns:
      The status describing the status for the upload job. The following are Valid Values:

      • CREATED: The upload job has been created, but has not started processing yet.

      • IN_PROGRESS: The upload job is currently in progress, ingesting and processing the profile data.

      • PARTIALLY_SUCCEEDED: The upload job has successfully completed the ingestion and processing of all profile data.

      • SUCCEEDED: The upload job has successfully completed the ingestion and processing of all profile data.

      • FAILED: The upload job has failed to complete.

      • STOPPED: The upload job has been manually stopped or terminated before completion.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status describing the status for the upload job. The following are Valid Values:

      • CREATED: The upload job has been created, but has not started processing yet.

      • IN_PROGRESS: The upload job is currently in progress, ingesting and processing the profile data.

      • PARTIALLY_SUCCEEDED: The upload job has successfully completed the ingestion and processing of all profile data.

      • SUCCEEDED: The upload job has successfully completed the ingestion and processing of all profile data.

      • FAILED: The upload job has failed to complete.

      • STOPPED: The upload job has been manually stopped or terminated before completion.

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

      Returns:
      The status describing the status for the upload job. The following are Valid Values:

      • CREATED: The upload job has been created, but has not started processing yet.

      • IN_PROGRESS: The upload job is currently in progress, ingesting and processing the profile data.

      • PARTIALLY_SUCCEEDED: The upload job has successfully completed the ingestion and processing of all profile data.

      • SUCCEEDED: The upload job has successfully completed the ingestion and processing of all profile data.

      • FAILED: The upload job has failed to complete.

      • STOPPED: The upload job has been manually stopped or terminated before completion.

      See Also:

    • statusReason

      public final StatusReason statusReason()

      The reason for the current status of the upload job. Possible reasons:

      • VALIDATION_FAILURE: The upload job has encountered an error or issue and was unable to complete the profile data ingestion.

      • INTERNAL_FAILURE: Failure caused from service side

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

      Returns:
      The reason for the current status of the upload job. Possible reasons:

      • VALIDATION_FAILURE: The upload job has encountered an error or issue and was unable to complete the profile data ingestion.

      • INTERNAL_FAILURE: Failure caused from service side

      See Also:

    • statusReasonAsString

      public final String statusReasonAsString()

      The reason for the current status of the upload job. Possible reasons:

      • VALIDATION_FAILURE: The upload job has encountered an error or issue and was unable to complete the profile data ingestion.

      • INTERNAL_FAILURE: Failure caused from service side

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

      Returns:
      The reason for the current status of the upload job. Possible reasons:

      • VALIDATION_FAILURE: The upload job has encountered an error or issue and was unable to complete the profile data ingestion.

      • INTERNAL_FAILURE: Failure caused from service side

      See Also:

    • createdAt

      public final Instant createdAt()

      The timestamp when the upload job was created.

      Returns:
      The timestamp when the upload job was created.

    • completedAt

      public final Instant completedAt()

      The timestamp when the upload job was completed.

      Returns:
      The timestamp when the upload job was completed.

    • hasFields

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

    • fields

      public final Map<String,ObjectTypeField> fields()

      The mapping between CSV Columns and Profile Object attributes for the upload 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 hasFields() method.

      Returns:
      The mapping between CSV Columns and Profile Object attributes for the upload job.

    • uniqueKey

      public final String uniqueKey()

      The unique key columns used for de-duping the keys in the upload job.

      Returns:
      The unique key columns used for de-duping the keys in the upload job.

    • resultsSummary

      public final ResultsSummary resultsSummary()

      The summary of results for the upload job, including the number of updated, created, and failed records.

      Returns:
      The summary of results for the upload job, including the number of updated, created, and failed records.

    • dataExpiry

      public final Integer dataExpiry()

      The expiry duration for the profiles ingested with the upload job.

      Returns:
      The expiry duration for the profiles ingested with the upload job.

    • toBuilder

      public GetUploadJobResponse.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<GetUploadJobResponse.Builder,GetUploadJobResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetUploadJobResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.

    • sdkFieldNameToField

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