Package software.amazon.awssdk.services.qconnect.model

Class StartImportJobRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.qconnect.model.QConnectRequest
software.amazon.awssdk.services.qconnect.model.StartImportJobRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartImportJobRequest.Builder,StartImportJobRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartImportJobRequest extends QConnectRequest implements ToCopyableBuilder<StartImportJobRequest.Builder,StartImportJobRequest>

  • Method Details

    • clientToken

      public final String clientToken()

      The tags used to organize, track, or control access for this resource.

      Returns:
      The tags used to organize, track, or control access for this resource.

    • externalSourceConfiguration

      public final ExternalSourceConfiguration externalSourceConfiguration()

      The configuration information of the external source that the resource data are imported from.

      Returns:
      The configuration information of the external source that the resource data are imported from.

    • importJobType

      public final ImportJobType importJobType()

      The type of the import job.

      • For importing quick response resource, set the value to QUICK_RESPONSES.

      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.

      • For importing quick response resource, set the value to QUICK_RESPONSES.

      See Also:

    • importJobTypeAsString

      public final String importJobTypeAsString()

      The type of the import job.

      • For importing quick response resource, set the value to QUICK_RESPONSES.

      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.

      • For importing quick response resource, set the value to QUICK_RESPONSES.

      See Also:

    • knowledgeBaseId

      public final String knowledgeBaseId()

      The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

      • For importing Amazon Q in Connect quick responses, this should be a QUICK_RESPONSES type knowledge base.

      Returns:
      The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

      • For importing Amazon Q in Connect quick responses, this should be a QUICK_RESPONSES type knowledge base.

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

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

    • toBuilder

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

    • builder

      public static StartImportJobRequest.Builder builder()

    • serializableBuilderClass

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