software.amazon.awssdk.services.wisdom.model.CreateContentRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of wisdom Show documentation
Show all versions of wisdom Show documentation
The AWS Java SDK for Wisdom module holds the client classes that are used for
communicating with Wisdom.
/*
* Copyright 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 software.amazon.awssdk.services.wisdom.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.DefaultValueTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateContentRequest extends WisdomRequest implements
ToCopyableBuilder {
private static final SdkField CLIENT_TOKEN_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("clientToken")
.getter(getter(CreateContentRequest::clientToken))
.setter(setter(Builder::clientToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("clientToken").build(),
DefaultValueTrait.idempotencyToken()).build();
private static final SdkField KNOWLEDGE_BASE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("knowledgeBaseId").getter(getter(CreateContentRequest::knowledgeBaseId))
.setter(setter(Builder::knowledgeBaseId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("knowledgeBaseId").build()).build();
private static final SdkField> METADATA_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("metadata")
.getter(getter(CreateContentRequest::metadata))
.setter(setter(Builder::metadata))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("metadata").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("name")
.getter(getter(CreateContentRequest::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("name").build()).build();
private static final SdkField OVERRIDE_LINK_OUT_URI_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("overrideLinkOutUri").getter(getter(CreateContentRequest::overrideLinkOutUri))
.setter(setter(Builder::overrideLinkOutUri))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("overrideLinkOutUri").build())
.build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("tags")
.getter(getter(CreateContentRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("tags").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final SdkField TITLE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("title")
.getter(getter(CreateContentRequest::title)).setter(setter(Builder::title))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("title").build()).build();
private static final SdkField UPLOAD_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("uploadId").getter(getter(CreateContentRequest::uploadId)).setter(setter(Builder::uploadId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("uploadId").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CLIENT_TOKEN_FIELD,
KNOWLEDGE_BASE_ID_FIELD, METADATA_FIELD, NAME_FIELD, OVERRIDE_LINK_OUT_URI_FIELD, TAGS_FIELD, TITLE_FIELD,
UPLOAD_ID_FIELD));
private final String clientToken;
private final String knowledgeBaseId;
private final Map metadata;
private final String name;
private final String overrideLinkOutUri;
private final Map tags;
private final String title;
private final String uploadId;
private CreateContentRequest(BuilderImpl builder) {
super(builder);
this.clientToken = builder.clientToken;
this.knowledgeBaseId = builder.knowledgeBaseId;
this.metadata = builder.metadata;
this.name = builder.name;
this.overrideLinkOutUri = builder.overrideLinkOutUri;
this.tags = builder.tags;
this.title = builder.title;
this.uploadId = builder.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.
*
*
* @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 final String clientToken() {
return clientToken;
}
/**
*
* The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
*
*
* @return The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
*/
public final String knowledgeBaseId() {
return knowledgeBaseId;
}
/**
* 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 {@code 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.
*/
public final boolean hasMetadata() {
return metadata != null && !(metadata instanceof SdkAutoConstructMap);
}
/**
*
* 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 {@link #hasMetadata} method.
*
*
* @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 final Map metadata() {
return 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.
*
*
* @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 final String name() {
return 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.
*
*
* @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 final String overrideLinkOutUri() {
return overrideLinkOutUri;
}
/**
* 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 {@code 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.
*/
public final boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructMap);
}
/**
*
* 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 {@link #hasTags} method.
*
*
* @return The tags used to organize, track, or control access for this resource.
*/
public final Map tags() {
return tags;
}
/**
*
* 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 final String title() {
return title;
}
/**
*
* 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 final String uploadId() {
return uploadId;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(clientToken());
hashCode = 31 * hashCode + Objects.hashCode(knowledgeBaseId());
hashCode = 31 * hashCode + Objects.hashCode(hasMetadata() ? metadata() : null);
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(overrideLinkOutUri());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
hashCode = 31 * hashCode + Objects.hashCode(title());
hashCode = 31 * hashCode + Objects.hashCode(uploadId());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreateContentRequest)) {
return false;
}
CreateContentRequest other = (CreateContentRequest) obj;
return Objects.equals(clientToken(), other.clientToken()) && Objects.equals(knowledgeBaseId(), other.knowledgeBaseId())
&& hasMetadata() == other.hasMetadata() && Objects.equals(metadata(), other.metadata())
&& Objects.equals(name(), other.name()) && Objects.equals(overrideLinkOutUri(), other.overrideLinkOutUri())
&& hasTags() == other.hasTags() && Objects.equals(tags(), other.tags()) && Objects.equals(title(), other.title())
&& Objects.equals(uploadId(), other.uploadId());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("CreateContentRequest").add("ClientToken", clientToken())
.add("KnowledgeBaseId", knowledgeBaseId()).add("Metadata", hasMetadata() ? metadata() : null).add("Name", name())
.add("OverrideLinkOutUri", overrideLinkOutUri()).add("Tags", hasTags() ? tags() : null).add("Title", title())
.add("UploadId", uploadId()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "clientToken":
return Optional.ofNullable(clazz.cast(clientToken()));
case "knowledgeBaseId":
return Optional.ofNullable(clazz.cast(knowledgeBaseId()));
case "metadata":
return Optional.ofNullable(clazz.cast(metadata()));
case "name":
return Optional.ofNullable(clazz.cast(name()));
case "overrideLinkOutUri":
return Optional.ofNullable(clazz.cast(overrideLinkOutUri()));
case "tags":
return Optional.ofNullable(clazz.cast(tags()));
case "title":
return Optional.ofNullable(clazz.cast(title()));
case "uploadId":
return Optional.ofNullable(clazz.cast(uploadId()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateContentRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends WisdomRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* 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.
*/
Builder clientToken(String clientToken);
/**
*
* The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
*
*
* @param knowledgeBaseId
* The identifier of the knowledge base. 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.
*/
Builder knowledgeBaseId(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.
*
*
* @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.
*/
Builder metadata(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.
*
*
* @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.
*/
Builder name(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.
*
*
* @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.
*/
Builder overrideLinkOutUri(String overrideLinkOutUri);
/**
*
* 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.
*/
Builder tags(Map tags);
/**
*
* 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.
*/
Builder title(String title);
/**
*
* 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.
*/
Builder uploadId(String uploadId);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends WisdomRequest.BuilderImpl implements Builder {
private String clientToken;
private String knowledgeBaseId;
private Map metadata = DefaultSdkAutoConstructMap.getInstance();
private String name;
private String overrideLinkOutUri;
private Map tags = DefaultSdkAutoConstructMap.getInstance();
private String title;
private String uploadId;
private BuilderImpl() {
}
private BuilderImpl(CreateContentRequest model) {
super(model);
clientToken(model.clientToken);
knowledgeBaseId(model.knowledgeBaseId);
metadata(model.metadata);
name(model.name);
overrideLinkOutUri(model.overrideLinkOutUri);
tags(model.tags);
title(model.title);
uploadId(model.uploadId);
}
public final String getClientToken() {
return clientToken;
}
public final void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
@Override
public final Builder clientToken(String clientToken) {
this.clientToken = clientToken;
return this;
}
public final String getKnowledgeBaseId() {
return knowledgeBaseId;
}
public final void setKnowledgeBaseId(String knowledgeBaseId) {
this.knowledgeBaseId = knowledgeBaseId;
}
@Override
public final Builder knowledgeBaseId(String knowledgeBaseId) {
this.knowledgeBaseId = knowledgeBaseId;
return this;
}
public final Map getMetadata() {
if (metadata instanceof SdkAutoConstructMap) {
return null;
}
return metadata;
}
public final void setMetadata(Map metadata) {
this.metadata = ContentMetadataCopier.copy(metadata);
}
@Override
public final Builder metadata(Map metadata) {
this.metadata = ContentMetadataCopier.copy(metadata);
return this;
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final String getOverrideLinkOutUri() {
return overrideLinkOutUri;
}
public final void setOverrideLinkOutUri(String overrideLinkOutUri) {
this.overrideLinkOutUri = overrideLinkOutUri;
}
@Override
public final Builder overrideLinkOutUri(String overrideLinkOutUri) {
this.overrideLinkOutUri = overrideLinkOutUri;
return this;
}
public final Map getTags() {
if (tags instanceof SdkAutoConstructMap) {
return null;
}
return tags;
}
public final void setTags(Map tags) {
this.tags = TagsCopier.copy(tags);
}
@Override
public final Builder tags(Map tags) {
this.tags = TagsCopier.copy(tags);
return this;
}
public final String getTitle() {
return title;
}
public final void setTitle(String title) {
this.title = title;
}
@Override
public final Builder title(String title) {
this.title = title;
return this;
}
public final String getUploadId() {
return uploadId;
}
public final void setUploadId(String uploadId) {
this.uploadId = uploadId;
}
@Override
public final Builder uploadId(String uploadId) {
this.uploadId = uploadId;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateContentRequest build() {
return new CreateContentRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy