com.amazonaws.services.qconnect.model.StartImportJobRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-qconnect Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.qconnect.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class StartImportJobRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The tags used to organize, track, or control access for this resource.
*
*/
private String clientToken;
/**
*
* The configuration information of the external source that the resource data are imported from.
*
*/
private ExternalSourceConfiguration externalSourceConfiguration;
/**
*
* The type of the import job.
*
*
* -
*
* For importing quick response resource, set the value to QUICK_RESPONSES.
*
*
*
*/
private String importJobType;
/**
*
* 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_RESPONSES type knowledge base.
*
*
*
*/
private String knowledgeBaseId;
/**
*
* The metadata fields of the imported Amazon Q resources.
*
*/
private java.util.Map metadata;
/**
*
* A pointer to the uploaded asset. This value is returned by StartContentUpload.
*
*/
private String uploadId;
/**
*
* The tags used to organize, track, or control access for this resource.
*
*
* @param clientToken
* The tags used to organize, track, or control access for this resource.
*/
public void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
/**
*
* The tags used to organize, track, or control access for this resource.
*
*
* @return The tags used to organize, track, or control access for this resource.
*/
public String getClientToken() {
return this.clientToken;
}
/**
*
* The tags used to organize, track, or control access for this resource.
*
*
* @param clientToken
* The tags used to organize, track, or control access for this resource.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartImportJobRequest withClientToken(String clientToken) {
setClientToken(clientToken);
return this;
}
/**
*
* The configuration information of the external source that the resource data are imported from.
*
*
* @param externalSourceConfiguration
* The configuration information of the external source that the resource data are imported from.
*/
public void setExternalSourceConfiguration(ExternalSourceConfiguration externalSourceConfiguration) {
this.externalSourceConfiguration = externalSourceConfiguration;
}
/**
*
* The configuration information of the external source that the resource data are imported from.
*
*
* @return The configuration information of the external source that the resource data are imported from.
*/
public ExternalSourceConfiguration getExternalSourceConfiguration() {
return this.externalSourceConfiguration;
}
/**
*
* The configuration information of the external source that the resource data are imported from.
*
*
* @param externalSourceConfiguration
* The configuration information of the external source that the resource data are imported from.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartImportJobRequest withExternalSourceConfiguration(ExternalSourceConfiguration externalSourceConfiguration) {
setExternalSourceConfiguration(externalSourceConfiguration);
return this;
}
/**
*
* The type of the import job.
*
*
* -
*
* For importing quick response resource, set the value to QUICK_RESPONSES.
*
*
*
*
* @param importJobType
* The type of the import job.
*
* -
*
* For importing quick response resource, set the value to QUICK_RESPONSES.
*
*
* @see ImportJobType
*/
public void setImportJobType(String importJobType) {
this.importJobType = importJobType;
}
/**
*
* The type of the import job.
*
*
* -
*
* For importing quick response resource, set the value to QUICK_RESPONSES.
*
*
*
*
* @return The type of the import job.
*
* -
*
* For importing quick response resource, set the value to QUICK_RESPONSES.
*
*
* @see ImportJobType
*/
public String getImportJobType() {
return this.importJobType;
}
/**
*
* The type of the import job.
*
*
* -
*
* For importing quick response resource, set the value to QUICK_RESPONSES.
*
*
*
*
* @param importJobType
* The type of the import job.
*
* -
*
* For importing quick response resource, set the value to QUICK_RESPONSES.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ImportJobType
*/
public StartImportJobRequest withImportJobType(String importJobType) {
setImportJobType(importJobType);
return this;
}
/**
*
* The type of the import job.
*
*
* -
*
* For importing quick response resource, set the value to QUICK_RESPONSES.
*
*
*
*
* @param importJobType
* The type of the import job.
*
* -
*
* For importing quick response resource, set the value to QUICK_RESPONSES.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ImportJobType
*/
public StartImportJobRequest withImportJobType(ImportJobType importJobType) {
this.importJobType = importJobType.toString();
return this;
}
/**
*
* 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_RESPONSES type knowledge base.
*
*
*
*
* @param 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_RESPONSES type knowledge base.
*
*
*/
public void setKnowledgeBaseId(String knowledgeBaseId) {
this.knowledgeBaseId = 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_RESPONSES type knowledge base.
*
*
*
*
* @return 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_RESPONSES type knowledge
* base.
*
*
*/
public String getKnowledgeBaseId() {
return this.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_RESPONSES type knowledge base.
*
*
*
*
* @param 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_RESPONSES type knowledge base.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartImportJobRequest withKnowledgeBaseId(String knowledgeBaseId) {
setKnowledgeBaseId(knowledgeBaseId);
return this;
}
/**
*
* The metadata fields of the imported Amazon Q resources.
*
*
* @return The metadata fields of the imported Amazon Q resources.
*/
public java.util.Map getMetadata() {
return metadata;
}
/**
*
* The metadata fields of the imported Amazon Q resources.
*
*
* @param metadata
* The metadata fields of the imported Amazon Q resources.
*/
public void setMetadata(java.util.Map metadata) {
this.metadata = metadata;
}
/**
*
* The metadata fields of the imported Amazon Q resources.
*
*
* @param metadata
* The metadata fields of the imported Amazon Q resources.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartImportJobRequest withMetadata(java.util.Map metadata) {
setMetadata(metadata);
return this;
}
/**
* Add a single Metadata entry
*
* @see StartImportJobRequest#withMetadata
* @returns a reference to this object so that method calls can be chained together.
*/
public StartImportJobRequest addMetadataEntry(String key, String value) {
if (null == this.metadata) {
this.metadata = new java.util.HashMap();
}
if (this.metadata.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.metadata.put(key, value);
return this;
}
/**
* Removes all the entries added into Metadata.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartImportJobRequest clearMetadataEntries() {
this.metadata = null;
return this;
}
/**
*
* A pointer to the uploaded asset. This value is returned by StartContentUpload.
*
*
* @param uploadId
* A pointer to the uploaded asset. This value is returned by StartContentUpload.
*/
public void setUploadId(String uploadId) {
this.uploadId = uploadId;
}
/**
*
* A pointer to the uploaded asset. This value is returned by StartContentUpload.
*
*
* @return A pointer to the uploaded asset. This value is returned by StartContentUpload.
*/
public String getUploadId() {
return this.uploadId;
}
/**
*
* A pointer to the uploaded asset. This value is returned by StartContentUpload.
*
*
* @param uploadId
* A pointer to the uploaded asset. This value is returned by StartContentUpload.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartImportJobRequest withUploadId(String uploadId) {
setUploadId(uploadId);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getClientToken() != null)
sb.append("ClientToken: ").append(getClientToken()).append(",");
if (getExternalSourceConfiguration() != null)
sb.append("ExternalSourceConfiguration: ").append(getExternalSourceConfiguration()).append(",");
if (getImportJobType() != null)
sb.append("ImportJobType: ").append(getImportJobType()).append(",");
if (getKnowledgeBaseId() != null)
sb.append("KnowledgeBaseId: ").append(getKnowledgeBaseId()).append(",");
if (getMetadata() != null)
sb.append("Metadata: ").append(getMetadata()).append(",");
if (getUploadId() != null)
sb.append("UploadId: ").append(getUploadId());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof StartImportJobRequest == false)
return false;
StartImportJobRequest other = (StartImportJobRequest) obj;
if (other.getClientToken() == null ^ this.getClientToken() == null)
return false;
if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false)
return false;
if (other.getExternalSourceConfiguration() == null ^ this.getExternalSourceConfiguration() == null)
return false;
if (other.getExternalSourceConfiguration() != null && other.getExternalSourceConfiguration().equals(this.getExternalSourceConfiguration()) == false)
return false;
if (other.getImportJobType() == null ^ this.getImportJobType() == null)
return false;
if (other.getImportJobType() != null && other.getImportJobType().equals(this.getImportJobType()) == false)
return false;
if (other.getKnowledgeBaseId() == null ^ this.getKnowledgeBaseId() == null)
return false;
if (other.getKnowledgeBaseId() != null && other.getKnowledgeBaseId().equals(this.getKnowledgeBaseId()) == false)
return false;
if (other.getMetadata() == null ^ this.getMetadata() == null)
return false;
if (other.getMetadata() != null && other.getMetadata().equals(this.getMetadata()) == false)
return false;
if (other.getUploadId() == null ^ this.getUploadId() == null)
return false;
if (other.getUploadId() != null && other.getUploadId().equals(this.getUploadId()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
hashCode = prime * hashCode + ((getExternalSourceConfiguration() == null) ? 0 : getExternalSourceConfiguration().hashCode());
hashCode = prime * hashCode + ((getImportJobType() == null) ? 0 : getImportJobType().hashCode());
hashCode = prime * hashCode + ((getKnowledgeBaseId() == null) ? 0 : getKnowledgeBaseId().hashCode());
hashCode = prime * hashCode + ((getMetadata() == null) ? 0 : getMetadata().hashCode());
hashCode = prime * hashCode + ((getUploadId() == null) ? 0 : getUploadId().hashCode());
return hashCode;
}
@Override
public StartImportJobRequest clone() {
return (StartImportJobRequest) super.clone();
}
}