software.amazon.awssdk.services.wisdom.model

Class CreateContentRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.wisdom.model.WisdomRequest

software.amazon.awssdk.services.wisdom.model.CreateContentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateContentRequest.Builder,CreateContentRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateContentRequest
extends WisdomRequest
implements ToCopyableBuilder<CreateContentRequest.Builder,CreateContentRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateContentRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateContentRequest.Builder	builder()
String	clientToken() A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMetadata() For responses, this returns true if the service returned a value for the Metadata property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	knowledgeBaseId() The identifier of the knowledge base.
Map<String,String>	metadata() A key/value map to store attributes without affecting tagging or recommendations.
String	name() The name of the content.
String	overrideLinkOutUri() The URI you want to use for the article.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateContentRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags() The tags used to organize, track, or control access for this resource.
String	title() The title of the content.
CreateContentRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	uploadId() 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()

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.

knowledgeBaseId

public final String knowledgeBaseId()

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.

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 the isEmpty() 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()

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.

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:

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.

name

public final 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.

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.

overrideLinkOutUri

public final 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.

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.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

tags

public final Map<String,String> tags()

The tags used to organize, track, or control access for this resource.

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 hasTags() method.

Returns:

The tags used to organize, track, or control access for this resource.

title

public final String title()

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.

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 CreateContentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateContentRequest.Builder,CreateContentRequest>

Specified by:

toBuilder in class WisdomRequest

builder

public static CreateContentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateContentRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo