software.amazon.awssdk.services.quicksight.model.RegisteredUserGenerativeQnAEmbeddingConfiguration Maven / Gradle / Ivy
Show all versions of quicksight Show documentation
/*
* 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.quicksight.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
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.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* An object that provides information about the configuration of a Generative Q&A experience.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class RegisteredUserGenerativeQnAEmbeddingConfiguration
implements
SdkPojo,
Serializable,
ToCopyableBuilder {
private static final SdkField INITIAL_TOPIC_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("InitialTopicId").getter(getter(RegisteredUserGenerativeQnAEmbeddingConfiguration::initialTopicId))
.setter(setter(Builder::initialTopicId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("InitialTopicId").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(INITIAL_TOPIC_ID_FIELD));
private static final long serialVersionUID = 1L;
private final String initialTopicId;
private RegisteredUserGenerativeQnAEmbeddingConfiguration(BuilderImpl builder) {
this.initialTopicId = builder.initialTopicId;
}
/**
*
* The ID of the new Q reader experience topic that you want to make the starting topic in the Generative Q&A
* experience. You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and
* opening a topic. The ID is in the URL for the topic that you open.
*
*
* If you don't specify an initial topic or you specify a legacy topic, a list of all shared new reader experience
* topics is shown in the Generative Q&A experience for your readers. When you select an initial new reader
* experience topic, you can specify whether or not readers are allowed to select other new reader experience topics
* from the available ones in the list.
*
*
* @return The ID of the new Q reader experience topic that you want to make the starting topic in the Generative
* Q&A experience. You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight
* application and opening a topic. The ID is in the URL for the topic that you open.
*
* If you don't specify an initial topic or you specify a legacy topic, a list of all shared new reader
* experience topics is shown in the Generative Q&A experience for your readers. When you select an
* initial new reader experience topic, you can specify whether or not readers are allowed to select other
* new reader experience topics from the available ones in the list.
*/
public final String initialTopicId() {
return initialTopicId;
}
@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 + Objects.hashCode(initialTopicId());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof RegisteredUserGenerativeQnAEmbeddingConfiguration)) {
return false;
}
RegisteredUserGenerativeQnAEmbeddingConfiguration other = (RegisteredUserGenerativeQnAEmbeddingConfiguration) obj;
return Objects.equals(initialTopicId(), other.initialTopicId());
}
/**
* 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("RegisteredUserGenerativeQnAEmbeddingConfiguration").add("InitialTopicId", initialTopicId())
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "InitialTopicId":
return Optional.ofNullable(clazz.cast(initialTopicId()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((RegisteredUserGenerativeQnAEmbeddingConfiguration) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The ID of the new Q reader experience topic that you want to make the starting topic in the Generative
* Q&A experience. You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight
* application and opening a topic. The ID is in the URL for the topic that you open.
*
*
* If you don't specify an initial topic or you specify a legacy topic, a list of all shared new reader
* experience topics is shown in the Generative Q&A experience for your readers. When you select an initial
* new reader experience topic, you can specify whether or not readers are allowed to select other new reader
* experience topics from the available ones in the list.
*
*
* @param initialTopicId
* The ID of the new Q reader experience topic that you want to make the starting topic in the Generative
* Q&A experience. You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight
* application and opening a topic. The ID is in the URL for the topic that you open.
*
* If you don't specify an initial topic or you specify a legacy topic, a list of all shared new reader
* experience topics is shown in the Generative Q&A experience for your readers. When you select an
* initial new reader experience topic, you can specify whether or not readers are allowed to select
* other new reader experience topics from the available ones in the list.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder initialTopicId(String initialTopicId);
}
static final class BuilderImpl implements Builder {
private String initialTopicId;
private BuilderImpl() {
}
private BuilderImpl(RegisteredUserGenerativeQnAEmbeddingConfiguration model) {
initialTopicId(model.initialTopicId);
}
public final String getInitialTopicId() {
return initialTopicId;
}
public final void setInitialTopicId(String initialTopicId) {
this.initialTopicId = initialTopicId;
}
@Override
public final Builder initialTopicId(String initialTopicId) {
this.initialTopicId = initialTopicId;
return this;
}
@Override
public RegisteredUserGenerativeQnAEmbeddingConfiguration build() {
return new RegisteredUserGenerativeQnAEmbeddingConfiguration(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}