Class ImportJobData

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

Summary information about the import job.

See Also:

  • Method Details

    • importJobId

      public final String importJobId()

      The identifier of the import job.

      Returns:
      The identifier of the import job.

    • knowledgeBaseId

      public final String knowledgeBaseId()

      The identifier of the knowledge base.

      Returns:
      The identifier of the knowledge base.

    • uploadId

      public final String uploadId()

      A pointer to the uploaded asset. This value is returned by StartContentUpload.

      Returns:
      A pointer to the uploaded asset. This value is returned by StartContentUpload.

    • knowledgeBaseArn

      public final String knowledgeBaseArn()

      The Amazon Resource Name (ARN) of the knowledge base.

      Returns:
      The Amazon Resource Name (ARN) of the knowledge base.

    • importJobType

      public final ImportJobType importJobType()

      The type of the import job.

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

      Returns:
      The type of the import job.
      See Also:

    • importJobTypeAsString

      public final String importJobTypeAsString()

      The type of the import job.

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

      Returns:
      The type of the import job.
      See Also:

    • status

      public final ImportJobStatus status()

      The status of the import job.

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

      Returns:
      The status of the import job.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the import job.

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

      Returns:
      The status of the import job.
      See Also:

    • url

      public final String url()

      The download link to the resource file that is uploaded to the import job.

      Returns:
      The download link to the resource file that is uploaded to the import job.

    • failedRecordReport

      public final String failedRecordReport()

      The link to download the information of resource data that failed to be imported.

      Returns:
      The link to download the information of resource data that failed to be imported.

    • urlExpiry

      public final Instant urlExpiry()

      The expiration time of the URL as an epoch timestamp.

      Returns:
      The expiration time of the URL as an epoch timestamp.

    • createdTime

      public final Instant createdTime()

      The timestamp when the import job was created.

      Returns:
      The timestamp when the import job was created.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The timestamp when the import job data was last modified.

      Returns:
      The timestamp when the import job data was last modified.

    • hasMetadata

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

    • metadata

      public final Map<String,String> metadata()

      The metadata fields of the imported Amazon Q in Connect resources.

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

      Returns:
      The metadata fields of the imported Amazon Q in Connect resources.

    • externalSourceConfiguration

      public final ExternalSourceConfiguration externalSourceConfiguration()
      Returns the value of the ExternalSourceConfiguration property for this object.
      Returns:
      The value of the ExternalSourceConfiguration property for this object.

    • toBuilder

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

    • builder

      public static ImportJobData.Builder builder()

    • serializableBuilderClass

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