software.amazon.awssdk.services.wisdom.model.UpdateContentRequest 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.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 UpdateContentRequest extends WisdomRequest implements
ToCopyableBuilder {
private static final SdkField CONTENT_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("contentId").getter(getter(UpdateContentRequest::contentId)).setter(setter(Builder::contentId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("contentId").build()).build();
private static final SdkField KNOWLEDGE_BASE_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("knowledgeBaseId").getter(getter(UpdateContentRequest::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(UpdateContentRequest::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 OVERRIDE_LINK_OUT_URI_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("overrideLinkOutUri").getter(getter(UpdateContentRequest::overrideLinkOutUri))
.setter(setter(Builder::overrideLinkOutUri))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("overrideLinkOutUri").build())
.build();
private static final SdkField REMOVE_OVERRIDE_LINK_OUT_URI_FIELD = SdkField
. builder(MarshallingType.BOOLEAN).memberName("removeOverrideLinkOutUri")
.getter(getter(UpdateContentRequest::removeOverrideLinkOutUri)).setter(setter(Builder::removeOverrideLinkOutUri))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("removeOverrideLinkOutUri").build())
.build();
private static final SdkField REVISION_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("revisionId").getter(getter(UpdateContentRequest::revisionId)).setter(setter(Builder::revisionId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("revisionId").build()).build();
private static final SdkField TITLE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("title")
.getter(getter(UpdateContentRequest::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(UpdateContentRequest::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(CONTENT_ID_FIELD,
KNOWLEDGE_BASE_ID_FIELD, METADATA_FIELD, OVERRIDE_LINK_OUT_URI_FIELD, REMOVE_OVERRIDE_LINK_OUT_URI_FIELD,
REVISION_ID_FIELD, TITLE_FIELD, UPLOAD_ID_FIELD));
private final String contentId;
private final String knowledgeBaseId;
private final Map metadata;
private final String overrideLinkOutUri;
private final Boolean removeOverrideLinkOutUri;
private final String revisionId;
private final String title;
private final String uploadId;
private UpdateContentRequest(BuilderImpl builder) {
super(builder);
this.contentId = builder.contentId;
this.knowledgeBaseId = builder.knowledgeBaseId;
this.metadata = builder.metadata;
this.overrideLinkOutUri = builder.overrideLinkOutUri;
this.removeOverrideLinkOutUri = builder.removeOverrideLinkOutUri;
this.revisionId = builder.revisionId;
this.title = builder.title;
this.uploadId = builder.uploadId;
}
/**
*
* 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 final String contentId() {
return contentId;
}
/**
*
* The identifier of the knowledge base. Can be either the ID or the ARN
*
*
* @return The identifier of the knowledge base. Can be either the ID or 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 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 final String overrideLinkOutUri() {
return overrideLinkOutUri;
}
/**
*
* Unset the existing overrideLinkOutUri if it exists.
*
*
* @return Unset the existing overrideLinkOutUri if it exists.
*/
public final Boolean removeOverrideLinkOutUri() {
return 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.
*
*
* @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 final String revisionId() {
return revisionId;
}
/**
*
* The title of the content.
*
*
* @return The title of the content.
*/
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(contentId());
hashCode = 31 * hashCode + Objects.hashCode(knowledgeBaseId());
hashCode = 31 * hashCode + Objects.hashCode(hasMetadata() ? metadata() : null);
hashCode = 31 * hashCode + Objects.hashCode(overrideLinkOutUri());
hashCode = 31 * hashCode + Objects.hashCode(removeOverrideLinkOutUri());
hashCode = 31 * hashCode + Objects.hashCode(revisionId());
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 UpdateContentRequest)) {
return false;
}
UpdateContentRequest other = (UpdateContentRequest) obj;
return Objects.equals(contentId(), other.contentId()) && Objects.equals(knowledgeBaseId(), other.knowledgeBaseId())
&& hasMetadata() == other.hasMetadata() && Objects.equals(metadata(), other.metadata())
&& Objects.equals(overrideLinkOutUri(), other.overrideLinkOutUri())
&& Objects.equals(removeOverrideLinkOutUri(), other.removeOverrideLinkOutUri())
&& Objects.equals(revisionId(), other.revisionId()) && 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("UpdateContentRequest").add("ContentId", contentId()).add("KnowledgeBaseId", knowledgeBaseId())
.add("Metadata", hasMetadata() ? metadata() : null).add("OverrideLinkOutUri", overrideLinkOutUri())
.add("RemoveOverrideLinkOutUri", removeOverrideLinkOutUri()).add("RevisionId", revisionId())
.add("Title", title()).add("UploadId", uploadId()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "contentId":
return Optional.ofNullable(clazz.cast(contentId()));
case "knowledgeBaseId":
return Optional.ofNullable(clazz.cast(knowledgeBaseId()));
case "metadata":
return Optional.ofNullable(clazz.cast(metadata()));
case "overrideLinkOutUri":
return Optional.ofNullable(clazz.cast(overrideLinkOutUri()));
case "removeOverrideLinkOutUri":
return Optional.ofNullable(clazz.cast(removeOverrideLinkOutUri()));
case "revisionId":
return Optional.ofNullable(clazz.cast(revisionId()));
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((UpdateContentRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends WisdomRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* 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.
*/
Builder contentId(String contentId);
/**
*
* The identifier of the knowledge base. Can be either the ID or the ARN
*
*
* @param knowledgeBaseId
* The identifier of the 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.
*/
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 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.
*/
Builder overrideLinkOutUri(String overrideLinkOutUri);
/**
*
* 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.
*/
Builder removeOverrideLinkOutUri(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.
*
*
* @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.
*/
Builder revisionId(String revisionId);
/**
*
* 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.
*/
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 contentId;
private String knowledgeBaseId;
private Map metadata = DefaultSdkAutoConstructMap.getInstance();
private String overrideLinkOutUri;
private Boolean removeOverrideLinkOutUri;
private String revisionId;
private String title;
private String uploadId;
private BuilderImpl() {
}
private BuilderImpl(UpdateContentRequest model) {
super(model);
contentId(model.contentId);
knowledgeBaseId(model.knowledgeBaseId);
metadata(model.metadata);
overrideLinkOutUri(model.overrideLinkOutUri);
removeOverrideLinkOutUri(model.removeOverrideLinkOutUri);
revisionId(model.revisionId);
title(model.title);
uploadId(model.uploadId);
}
public final String getContentId() {
return contentId;
}
public final void setContentId(String contentId) {
this.contentId = contentId;
}
@Override
public final Builder contentId(String contentId) {
this.contentId = contentId;
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 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 Boolean getRemoveOverrideLinkOutUri() {
return removeOverrideLinkOutUri;
}
public final void setRemoveOverrideLinkOutUri(Boolean removeOverrideLinkOutUri) {
this.removeOverrideLinkOutUri = removeOverrideLinkOutUri;
}
@Override
public final Builder removeOverrideLinkOutUri(Boolean removeOverrideLinkOutUri) {
this.removeOverrideLinkOutUri = removeOverrideLinkOutUri;
return this;
}
public final String getRevisionId() {
return revisionId;
}
public final void setRevisionId(String revisionId) {
this.revisionId = revisionId;
}
@Override
public final Builder revisionId(String revisionId) {
this.revisionId = revisionId;
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 UpdateContentRequest build() {
return new UpdateContentRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy