com.amazonaws.services.connectwisdom.model.CreateContentRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-connectwisdom 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.connectwisdom.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 CreateContentRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided,
* the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with
* idempotent APIs.
*
*/
private String clientToken;
/**
*
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing
* Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain 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 Wisdom, you can store an external version identifier as metadata to utilize
* for determining drift.
*
*/
private java.util.Map metadata;
/**
*
* The name of the content. Each piece of content in a knowledge base must have a unique name. You can retrieve a
* piece of content using only its knowledge base and its name with the SearchContent API.
*
*/
private String name;
/**
*
* The URI you want to use for the article. If the knowledge base has a templateUri, setting this argument overrides
* it for this piece of content.
*
*/
private String overrideLinkOutUri;
/**
*
* The tags used to organize, track, or control access for this resource.
*
*/
private java.util.Map tags;
/**
*
* The title of the content. If not set, the title is equal to the name.
*
*/
private String title;
/**
*
* A pointer to the uploaded asset. This value is returned by StartContentUpload.
*
*/
private String uploadId;
/**
*
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided,
* the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with
* idempotent APIs.
*
*
* @param clientToken
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not
* provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries
* safe with idempotent APIs.
*/
public void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
/**
*
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided,
* the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with
* idempotent APIs.
*
*
* @return A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not
* provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see
* Making
* retries safe with idempotent APIs.
*/
public String getClientToken() {
return this.clientToken;
}
/**
*
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided,
* the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with
* idempotent APIs.
*
*
* @param clientToken
* A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not
* provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries
* safe with idempotent APIs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateContentRequest withClientToken(String clientToken) {
setClientToken(clientToken);
return this;
}
/**
*
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing
* Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
*
*
* @param knowledgeBaseId
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're
* storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain 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 if you're storing
* Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
*
*
* @return The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're
* storing Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
*/
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
* Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
*
*
* @param knowledgeBaseId
* The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're
* storing Wisdom Content resource to it. 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 CreateContentRequest 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 Wisdom, 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 Wisdom, 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 Wisdom, 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 Wisdom, 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 Wisdom, 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 Wisdom, 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 CreateContentRequest withMetadata(java.util.Map metadata) {
setMetadata(metadata);
return this;
}
/**
* Add a single Metadata entry
*
* @see CreateContentRequest#withMetadata
* @returns a reference to this object so that method calls can be chained together.
*/
public CreateContentRequest 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 CreateContentRequest clearMetadataEntries() {
this.metadata = null;
return this;
}
/**
*
* The name of the content. Each piece of content in a knowledge base must have a unique name. You can retrieve a
* piece of content using only its knowledge base and its name with the SearchContent API.
*
*
* @param name
* The name of the content. Each piece of content in a knowledge base must have a unique name. You can
* retrieve a piece of content using only its knowledge base and its name with the SearchContent
* API.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the content. Each piece of content in a knowledge base must have a unique name. You can retrieve a
* piece of content using only its knowledge base and its name with the SearchContent API.
*
*
* @return The name of the content. Each piece of content in a knowledge base must have a unique name. You can
* retrieve a piece of content using only its knowledge base and its name with the SearchContent
* API.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the content. Each piece of content in a knowledge base must have a unique name. You can retrieve a
* piece of content using only its knowledge base and its name with the SearchContent API.
*
*
* @param name
* The name of the content. Each piece of content in a knowledge base must have a unique name. You can
* retrieve a piece of content using only its knowledge base and its name with the SearchContent
* API.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateContentRequest withName(String name) {
setName(name);
return this;
}
/**
*
* The URI you want to use for the article. If the knowledge base has a templateUri, setting this argument overrides
* it for this piece of content.
*
*
* @param overrideLinkOutUri
* The URI you want to use for the article. If the knowledge base has a templateUri, setting this argument
* overrides it for this piece of content.
*/
public void setOverrideLinkOutUri(String overrideLinkOutUri) {
this.overrideLinkOutUri = overrideLinkOutUri;
}
/**
*
* The URI you want to use for the article. If the knowledge base has a templateUri, setting this argument overrides
* it for this piece of content.
*
*
* @return The URI you want to use for the article. If the knowledge base has a templateUri, setting this argument
* overrides it for this piece of content.
*/
public String getOverrideLinkOutUri() {
return this.overrideLinkOutUri;
}
/**
*
* The URI you want to use for the article. If the knowledge base has a templateUri, setting this argument overrides
* it for this piece of content.
*
*
* @param overrideLinkOutUri
* The URI you want to use for the article. If the knowledge base has a templateUri, setting this argument
* overrides it for this piece of content.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateContentRequest withOverrideLinkOutUri(String overrideLinkOutUri) {
setOverrideLinkOutUri(overrideLinkOutUri);
return this;
}
/**
*
* 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 java.util.Map getTags() {
return tags;
}
/**
*
* The tags used to organize, track, or control access for this resource.
*
*
* @param tags
* The tags used to organize, track, or control access for this resource.
*/
public void setTags(java.util.Map tags) {
this.tags = tags;
}
/**
*
* The tags used to organize, track, or control access for this resource.
*
*
* @param tags
* 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 CreateContentRequest withTags(java.util.Map tags) {
setTags(tags);
return this;
}
/**
* Add a single Tags entry
*
* @see CreateContentRequest#withTags
* @returns a reference to this object so that method calls can be chained together.
*/
public CreateContentRequest addTagsEntry(String key, String value) {
if (null == this.tags) {
this.tags = new java.util.HashMap();
}
if (this.tags.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.tags.put(key, value);
return this;
}
/**
* Removes all the entries added into Tags.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateContentRequest clearTagsEntries() {
this.tags = null;
return this;
}
/**
*
* The title of the content. If not set, the title is equal to the name.
*
*
* @param title
* The title of the content. If not set, the title is equal to the name.
*/
public void setTitle(String title) {
this.title = title;
}
/**
*
* The title of the content. If not set, the title is equal to the name.
*
*
* @return The title of the content. If not set, the title is equal to the name.
*/
public String getTitle() {
return this.title;
}
/**
*
* The title of the content. If not set, the title is equal to the name.
*
*
* @param title
* The title of the content. If not set, the title is equal to the name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateContentRequest 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 CreateContentRequest 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 (getKnowledgeBaseId() != null)
sb.append("KnowledgeBaseId: ").append(getKnowledgeBaseId()).append(",");
if (getMetadata() != null)
sb.append("Metadata: ").append(getMetadata()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getOverrideLinkOutUri() != null)
sb.append("OverrideLinkOutUri: ").append(getOverrideLinkOutUri()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).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 CreateContentRequest == false)
return false;
CreateContentRequest other = (CreateContentRequest) obj;
if (other.getClientToken() == null ^ this.getClientToken() == null)
return false;
if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == 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.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == 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.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == 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 + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
hashCode = prime * hashCode + ((getKnowledgeBaseId() == null) ? 0 : getKnowledgeBaseId().hashCode());
hashCode = prime * hashCode + ((getMetadata() == null) ? 0 : getMetadata().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getOverrideLinkOutUri() == null) ? 0 : getOverrideLinkOutUri().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getTitle() == null) ? 0 : getTitle().hashCode());
hashCode = prime * hashCode + ((getUploadId() == null) ? 0 : getUploadId().hashCode());
return hashCode;
}
@Override
public CreateContentRequest clone() {
return (CreateContentRequest) super.clone();
}
}