com.amazonaws.services.qconnect.model.UpdateContentRequest 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 UpdateContentRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
*
*/
private String contentId;
/**
*
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the
* ID or the ARN
*
*/
private String knowledgeBaseId;
/**
*
* A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing
* data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata
* to utilize for determining drift.
*
*/
private java.util.Map metadata;
/**
*
* The URI for the article. If the knowledge base has a templateUri, setting this argument overrides it for this
* piece of content. To remove an existing overrideLinkOurUri, exclude this argument and set
* removeOverrideLinkOutUri to true.
*
*/
private String overrideLinkOutUri;
/**
*
* Unset the existing overrideLinkOutUri if it exists.
*
*/
private Boolean removeOverrideLinkOutUri;
/**
*
* The revisionId of the content resource to update, taken from an earlier call to
* GetContent, GetContentSummary, SearchContent, or ListContents
* . If included, this argument acts as an optimistic lock to ensure content was not modified since it was last
* read. If it has been modified, this API throws a PreconditionFailedException.
*
*/
private String revisionId;
/**
*
* The title of the content.
*
*/
private String title;
/**
*
* A pointer to the uploaded asset. This value is returned by StartContentUpload.
*
*/
private String uploadId;
/**
*
* The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
*
*
* @param contentId
* The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
*/
public void setContentId(String contentId) {
this.contentId = contentId;
}
/**
*
* The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
*
*
* @return The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
*/
public String getContentId() {
return this.contentId;
}
/**
*
* The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
*
*
* @param contentId
* The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateContentRequest withContentId(String contentId) {
setContentId(contentId);
return this;
}
/**
*
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the
* ID or the ARN
*
*
* @param knowledgeBaseId
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be
* either the ID or the ARN
*/
public void setKnowledgeBaseId(String knowledgeBaseId) {
this.knowledgeBaseId = knowledgeBaseId;
}
/**
*
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the
* ID or the ARN
*
*
* @return The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be
* either the ID or the ARN
*/
public String getKnowledgeBaseId() {
return this.knowledgeBaseId;
}
/**
*
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the
* ID or the ARN
*
*
* @param knowledgeBaseId
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be
* either the ID or the ARN
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateContentRequest withKnowledgeBaseId(String knowledgeBaseId) {
setKnowledgeBaseId(knowledgeBaseId);
return this;
}
/**
*
* A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing
* data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata
* to utilize for determining drift.
*
*
* @return A key/value map to store attributes without affecting tagging or recommendations. For example, when
* synchronizing data between an external system and Amazon Q in Connect, you can store an external version
* identifier as metadata to utilize for determining drift.
*/
public java.util.Map getMetadata() {
return metadata;
}
/**
*
* A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing
* data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata
* to utilize for determining drift.
*
*
* @param metadata
* A key/value map to store attributes without affecting tagging or recommendations. For example, when
* synchronizing data between an external system and Amazon Q in Connect, you can store an external version
* identifier as metadata to utilize for determining drift.
*/
public void setMetadata(java.util.Map metadata) {
this.metadata = metadata;
}
/**
*
* A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing
* data between an external system and Amazon Q in Connect, you can store an external version identifier as metadata
* to utilize for determining drift.
*
*
* @param metadata
* A key/value map to store attributes without affecting tagging or recommendations. For example, when
* synchronizing data between an external system and Amazon Q in Connect, you can store an external version
* identifier as metadata to utilize for determining drift.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateContentRequest withMetadata(java.util.Map metadata) {
setMetadata(metadata);
return this;
}
/**
* Add a single Metadata entry
*
* @see UpdateContentRequest#withMetadata
* @returns a reference to this object so that method calls can be chained together.
*/
public UpdateContentRequest 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 UpdateContentRequest clearMetadataEntries() {
this.metadata = null;
return this;
}
/**
*
* The URI for the article. If the knowledge base has a templateUri, setting this argument overrides it for this
* piece of content. To remove an existing overrideLinkOurUri, exclude this argument and set
* removeOverrideLinkOutUri to true.
*
*
* @param overrideLinkOutUri
* The URI for the article. If the knowledge base has a templateUri, setting this argument overrides it for
* this piece of content. To remove an existing overrideLinkOurUri, exclude this argument and
* set removeOverrideLinkOutUri to true.
*/
public void setOverrideLinkOutUri(String overrideLinkOutUri) {
this.overrideLinkOutUri = overrideLinkOutUri;
}
/**
*
* The URI for the article. If the knowledge base has a templateUri, setting this argument overrides it for this
* piece of content. To remove an existing overrideLinkOurUri, exclude this argument and set
* removeOverrideLinkOutUri to true.
*
*
* @return The URI for the article. If the knowledge base has a templateUri, setting this argument overrides it for
* this piece of content. To remove an existing overrideLinkOurUri, exclude this argument and
* set removeOverrideLinkOutUri to true.
*/
public String getOverrideLinkOutUri() {
return this.overrideLinkOutUri;
}
/**
*
* The URI for the article. If the knowledge base has a templateUri, setting this argument overrides it for this
* piece of content. To remove an existing overrideLinkOurUri, exclude this argument and set
* removeOverrideLinkOutUri to true.
*
*
* @param overrideLinkOutUri
* The URI for the article. If the knowledge base has a templateUri, setting this argument overrides it for
* this piece of content. To remove an existing overrideLinkOurUri, exclude this argument and
* set removeOverrideLinkOutUri to true.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateContentRequest withOverrideLinkOutUri(String overrideLinkOutUri) {
setOverrideLinkOutUri(overrideLinkOutUri);
return this;
}
/**
*
* Unset the existing overrideLinkOutUri if it exists.
*
*
* @param removeOverrideLinkOutUri
* Unset the existing overrideLinkOutUri if it exists.
*/
public void setRemoveOverrideLinkOutUri(Boolean removeOverrideLinkOutUri) {
this.removeOverrideLinkOutUri = removeOverrideLinkOutUri;
}
/**
*
* Unset the existing overrideLinkOutUri if it exists.
*
*
* @return Unset the existing overrideLinkOutUri if it exists.
*/
public Boolean getRemoveOverrideLinkOutUri() {
return this.removeOverrideLinkOutUri;
}
/**
*
* Unset the existing overrideLinkOutUri if it exists.
*
*
* @param removeOverrideLinkOutUri
* Unset the existing overrideLinkOutUri if it exists.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateContentRequest withRemoveOverrideLinkOutUri(Boolean removeOverrideLinkOutUri) {
setRemoveOverrideLinkOutUri(removeOverrideLinkOutUri);
return this;
}
/**
*
* Unset the existing overrideLinkOutUri if it exists.
*
*
* @return Unset the existing overrideLinkOutUri if it exists.
*/
public Boolean isRemoveOverrideLinkOutUri() {
return this.removeOverrideLinkOutUri;
}
/**
*
* The revisionId of the content resource to update, taken from an earlier call to
* GetContent, GetContentSummary, SearchContent, or ListContents
* . If included, this argument acts as an optimistic lock to ensure content was not modified since it was last
* read. If it has been modified, this API throws a PreconditionFailedException.
*
*
* @param revisionId
* The revisionId of the content resource to update, taken from an earlier call to
* GetContent, GetContentSummary, SearchContent, or
* ListContents. If included, this argument acts as an optimistic lock to ensure content was not
* modified since it was last read. If it has been modified, this API throws a
* PreconditionFailedException.
*/
public void setRevisionId(String revisionId) {
this.revisionId = revisionId;
}
/**
*
* The revisionId of the content resource to update, taken from an earlier call to
* GetContent, GetContentSummary, SearchContent, or ListContents
* . If included, this argument acts as an optimistic lock to ensure content was not modified since it was last
* read. If it has been modified, this API throws a PreconditionFailedException.
*
*
* @return The revisionId of the content resource to update, taken from an earlier call to
* GetContent, GetContentSummary, SearchContent, or
* ListContents. If included, this argument acts as an optimistic lock to ensure content was
* not modified since it was last read. If it has been modified, this API throws a
* PreconditionFailedException.
*/
public String getRevisionId() {
return this.revisionId;
}
/**
*
* The revisionId of the content resource to update, taken from an earlier call to
* GetContent, GetContentSummary, SearchContent, or ListContents
* . If included, this argument acts as an optimistic lock to ensure content was not modified since it was last
* read. If it has been modified, this API throws a PreconditionFailedException.
*
*
* @param revisionId
* The revisionId of the content resource to update, taken from an earlier call to
* GetContent, GetContentSummary, SearchContent, or
* ListContents. If included, this argument acts as an optimistic lock to ensure content was not
* modified since it was last read. If it has been modified, this API throws a
* PreconditionFailedException.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateContentRequest withRevisionId(String revisionId) {
setRevisionId(revisionId);
return this;
}
/**
*
* The title of the content.
*
*
* @param title
* The title of the content.
*/
public void setTitle(String title) {
this.title = title;
}
/**
*
* The title of the content.
*
*
* @return The title of the content.
*/
public String getTitle() {
return this.title;
}
/**
*
* The title of the content.
*
*
* @param title
* The title of the content.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateContentRequest withTitle(String title) {
setTitle(title);
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 UpdateContentRequest 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 (getContentId() != null)
sb.append("ContentId: ").append(getContentId()).append(",");
if (getKnowledgeBaseId() != null)
sb.append("KnowledgeBaseId: ").append(getKnowledgeBaseId()).append(",");
if (getMetadata() != null)
sb.append("Metadata: ").append(getMetadata()).append(",");
if (getOverrideLinkOutUri() != null)
sb.append("OverrideLinkOutUri: ").append(getOverrideLinkOutUri()).append(",");
if (getRemoveOverrideLinkOutUri() != null)
sb.append("RemoveOverrideLinkOutUri: ").append(getRemoveOverrideLinkOutUri()).append(",");
if (getRevisionId() != null)
sb.append("RevisionId: ").append(getRevisionId()).append(",");
if (getTitle() != null)
sb.append("Title: ").append(getTitle()).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 UpdateContentRequest == false)
return false;
UpdateContentRequest other = (UpdateContentRequest) obj;
if (other.getContentId() == null ^ this.getContentId() == null)
return false;
if (other.getContentId() != null && other.getContentId().equals(this.getContentId()) == 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.getOverrideLinkOutUri() == null ^ this.getOverrideLinkOutUri() == null)
return false;
if (other.getOverrideLinkOutUri() != null && other.getOverrideLinkOutUri().equals(this.getOverrideLinkOutUri()) == false)
return false;
if (other.getRemoveOverrideLinkOutUri() == null ^ this.getRemoveOverrideLinkOutUri() == null)
return false;
if (other.getRemoveOverrideLinkOutUri() != null && other.getRemoveOverrideLinkOutUri().equals(this.getRemoveOverrideLinkOutUri()) == false)
return false;
if (other.getRevisionId() == null ^ this.getRevisionId() == null)
return false;
if (other.getRevisionId() != null && other.getRevisionId().equals(this.getRevisionId()) == false)
return false;
if (other.getTitle() == null ^ this.getTitle() == null)
return false;
if (other.getTitle() != null && other.getTitle().equals(this.getTitle()) == 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 + ((getContentId() == null) ? 0 : getContentId().hashCode());
hashCode = prime * hashCode + ((getKnowledgeBaseId() == null) ? 0 : getKnowledgeBaseId().hashCode());
hashCode = prime * hashCode + ((getMetadata() == null) ? 0 : getMetadata().hashCode());
hashCode = prime * hashCode + ((getOverrideLinkOutUri() == null) ? 0 : getOverrideLinkOutUri().hashCode());
hashCode = prime * hashCode + ((getRemoveOverrideLinkOutUri() == null) ? 0 : getRemoveOverrideLinkOutUri().hashCode());
hashCode = prime * hashCode + ((getRevisionId() == null) ? 0 : getRevisionId().hashCode());
hashCode = prime * hashCode + ((getTitle() == null) ? 0 : getTitle().hashCode());
hashCode = prime * hashCode + ((getUploadId() == null) ? 0 : getUploadId().hashCode());
return hashCode;
}
@Override
public UpdateContentRequest clone() {
return (UpdateContentRequest) super.clone();
}
}