CreateContentRequest (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.qconnect.model

Class CreateContentRequest

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.qconnect.model.CreateContentRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateContentRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateContentRequest ()

Constructors
Constructor and Description
`CreateContentRequest ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`CreateContentRequest`	`addMetadataEntry (String key, String value)` Add a single Metadata entry
`CreateContentRequest`	`addTagsEntry (String key, String value)` Add a single Tags entry
`CreateContentRequest`	`clearMetadataEntries ()` Removes all the entries added into Metadata.
`CreateContentRequest`	`clearTagsEntries ()` Removes all the entries added into Tags.
`CreateContentRequest`	`clone ()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals (Object obj)`
`String`	`getClientToken ()` A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`String`	`getKnowledgeBaseId ()` The identifier of the knowledge base.
`Map<String,String>`	`getMetadata ()` A key/value map to store attributes without affecting tagging or recommendations.
`String`	`getName ()` The name of the content.
`String`	`getOverrideLinkOutUri ()` The URI you want to use for the article.
`Map<String,String>`	`getTags ()` The tags used to organize, track, or control access for this resource.
`String`	`getTitle ()` The title of the content.
`String`	`getUploadId ()` A pointer to the uploaded asset.
`int`	`hashCode ()`
`void`	`setClientToken (String clientToken)` A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`void`	`setKnowledgeBaseId (String knowledgeBaseId)` The identifier of the knowledge base.
`void`	`setMetadata (Map<String,String> metadata)` A key/value map to store attributes without affecting tagging or recommendations.
`void`	`setName (String name)` The name of the content.
`void`	`setOverrideLinkOutUri (String overrideLinkOutUri)` The URI you want to use for the article.
`void`	`setTags (Map<String,String> tags)` The tags used to organize, track, or control access for this resource.
`void`	`setTitle (String title)` The title of the content.
`void`	`setUploadId (String uploadId)` A pointer to the uploaded asset.
`String`	`toString ()` Returns a string representation of this object.
`CreateContentRequest`	`withClientToken (String clientToken)` A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`CreateContentRequest`	`withKnowledgeBaseId (String knowledgeBaseId)` The identifier of the knowledge base.
`CreateContentRequest`	`withMetadata (Map<String,String> metadata)` A key/value map to store attributes without affecting tagging or recommendations.
`CreateContentRequest`	`withName (String name)` The name of the content.
`CreateContentRequest`	`withOverrideLinkOutUri (String overrideLinkOutUri)` The URI you want to use for the article.
`CreateContentRequest`	`withTags (Map<String,String> tags)` The tags used to organize, track, or control access for this resource.
`CreateContentRequest`	`withTitle (String title)` The title of the content.
`CreateContentRequest`	`withUploadId (String uploadId)` A pointer to the uploaded asset.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateContentRequest
```
public CreateContentRequest()
```
- Method Detail
  - setClientToken
```
public void setClientToken(String 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.
    
    Parameters:
    
    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.
  - getClientToken
```
public String getClientToken()
```
    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.
    
    Returns:
    
    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.
  - withClientToken
```
public CreateContentRequest withClientToken(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKnowledgeBaseId
```
public void setKnowledgeBaseId(String 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. URLs cannot contain the ARN.
    
    Parameters:
    
    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. URLs cannot contain the ARN.
  - getKnowledgeBaseId
```
public String getKnowledgeBaseId()
```
    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
    
    Returns:
    
    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
  - withKnowledgeBaseId
```
public CreateContentRequest withKnowledgeBaseId(String 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. URLs cannot contain the ARN.
    
    Parameters:
    
    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. URLs cannot contain the ARN.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getMetadata
```
public Map<String,String> getMetadata()
```
    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.
    
    Returns:
    
    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.
  - setMetadata
```
public void setMetadata(Map<String,String> 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.
    
    Parameters:
    
    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.
  - withMetadata
```
public CreateContentRequest withMetadata(Map<String,String> 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addMetadataEntry
```
public CreateContentRequest addMetadataEntry(String key,
 String value)
```
    Add a single Metadata entry
    
    See Also:
    
    withMetadata(java.util.Map<java.lang.String, java.lang.String>)
  - clearMetadataEntries
```
public CreateContentRequest clearMetadataEntries()
```
    Removes all the entries added into Metadata.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String 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.
    
    Parameters:
    
    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.
  - getName
```
public String getName()
```
    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.
    
    Returns:
    
    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.
  - withName
```
public CreateContentRequest withName(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOverrideLinkOutUri
```
public void setOverrideLinkOutUri(String 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.
    
    Parameters:
    
    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.
  - getOverrideLinkOutUri
```
public String getOverrideLinkOutUri()
```
    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.
    
    Returns:
    
    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.
  - withOverrideLinkOutUri
```
public CreateContentRequest withOverrideLinkOutUri(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public Map<String,String> getTags()
```
    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.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    The tags used to organize, track, or control access for this resource.
    
    Parameters:
    
    tags - The tags used to organize, track, or control access for this resource.
  - withTags
```
public CreateContentRequest withTags(Map<String,String> tags)
```
    The tags used to organize, track, or control access for this resource.
    
    Parameters:
    
    tags - The tags used to organize, track, or control access for this resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public CreateContentRequest addTagsEntry(String key,
 String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public CreateContentRequest clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTitle
```
public void setTitle(String title)
```
    The title of the content. If not set, the title is equal to the name.
    
    Parameters:
    
    title - The title of the content. If not set, the title is equal to the name.
  - getTitle
```
public String getTitle()
```
    The title of the content. If not set, the title is equal to the name.
    
    Returns:
    
    The title of the content. If not set, the title is equal to the name.
  - withTitle
```
public CreateContentRequest withTitle(String title)
```
    The title of the content. If not set, the title is equal to the name.
    
    Parameters:
    
    title - The title of the content. If not set, the title is equal to the name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUploadId
```
public void setUploadId(String uploadId)
```
    A pointer to the uploaded asset. This value is returned by StartContentUpload.
    
    Parameters:
    
    uploadId - A pointer to the uploaded asset. This value is returned by StartContentUpload.
  - getUploadId
```
public String getUploadId()
```
    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.
  - withUploadId
```
public CreateContentRequest withUploadId(String uploadId)
```
    A pointer to the uploaded asset. This value is returned by StartContentUpload.
    
    Parameters:
    
    uploadId - A pointer to the uploaded asset. This value is returned by StartContentUpload.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateContentRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.793

Class CreateContentRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateContentRequest

Method Detail

setClientToken

getClientToken

withClientToken

setKnowledgeBaseId

getKnowledgeBaseId

withKnowledgeBaseId

getMetadata

setMetadata

withMetadata

addMetadataEntry

clearMetadataEntries

setName

getName

withName

setOverrideLinkOutUri

getOverrideLinkOutUri

withOverrideLinkOutUri

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setTitle

getTitle

withTitle

setUploadId

getUploadId

withUploadId

toString

equals

hashCode

clone