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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceStartImportJobRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static StartImportJobRequest.Builderbuilder()StringclientToken()The tags used to organize, track, or control access for this resource.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)ExternalSourceConfigurationexternalSourceConfiguration()The configuration information of the external source that the resource data are imported from.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasMetadata()For responses, this returns true if the service returned a value for the Metadata property.ImportJobTypeimportJobType()The type of the import job.StringimportJobTypeAsString()The type of the import job.StringknowledgeBaseId()The identifier of the knowledge base.Map<String,String>metadata()The metadata fields of the imported Amazon Q resources.List<SdkField<?>>sdkFields()static Class<? extends StartImportJobRequest.Builder>serializableBuilderClass()StartImportJobRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.StringuploadId()A pointer to the uploaded asset.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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,
importJobTypewill returnImportJobType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromimportJobTypeAsString().- Returns:
- The type of the import job.
-
For importing quick response resource, set the value to
QUICK_RESPONSES.
-
- See Also:
ImportJobType
-
-
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,
importJobTypewill returnImportJobType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromimportJobTypeAsString().- Returns:
- The type of the import job.
-
For importing quick response resource, set the value to
QUICK_RESPONSES.
-
- See Also:
ImportJobType
-
-
knowledgeBaseId
public final String knowledgeBaseId()
The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
-
For importing Amazon Q quick responses, this should be a
QUICK_RESPONSEStype knowledge base.
- Returns:
- The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're
storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the
ARN.
-
For importing Amazon Q quick responses, this should be a
QUICK_RESPONSEStype 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 theisEmpty()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 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 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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<StartImportJobRequest.Builder,StartImportJobRequest>- Specified by:
toBuilderin classQConnectRequest
-
builder
public static StartImportJobRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends StartImportJobRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-