software.amazon.awssdk.services.lexruntime.model.GetSessionRequest Maven / Gradle / Ivy
Show all versions of lexruntime 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.lexruntime.model;
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.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.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class GetSessionRequest extends LexRuntimeRequest implements
ToCopyableBuilder {
private static final SdkField BOT_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("botName").getter(getter(GetSessionRequest::botName)).setter(setter(Builder::botName))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("botName").build()).build();
private static final SdkField BOT_ALIAS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("botAlias").getter(getter(GetSessionRequest::botAlias)).setter(setter(Builder::botAlias))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("botAlias").build()).build();
private static final SdkField USER_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("userId")
.getter(getter(GetSessionRequest::userId)).setter(setter(Builder::userId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("userId").build()).build();
private static final SdkField CHECKPOINT_LABEL_FILTER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("checkpointLabelFilter").getter(getter(GetSessionRequest::checkpointLabelFilter))
.setter(setter(Builder::checkpointLabelFilter))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("checkpointLabelFilter").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(BOT_NAME_FIELD,
BOT_ALIAS_FIELD, USER_ID_FIELD, CHECKPOINT_LABEL_FILTER_FIELD));
private final String botName;
private final String botAlias;
private final String userId;
private final String checkpointLabelFilter;
private GetSessionRequest(BuilderImpl builder) {
super(builder);
this.botName = builder.botName;
this.botAlias = builder.botAlias;
this.userId = builder.userId;
this.checkpointLabelFilter = builder.checkpointLabelFilter;
}
/**
*
* The name of the bot that contains the session data.
*
*
* @return The name of the bot that contains the session data.
*/
public final String botName() {
return botName;
}
/**
*
* The alias in use for the bot that contains the session data.
*
*
* @return The alias in use for the bot that contains the session data.
*/
public final String botAlias() {
return botAlias;
}
/**
*
* The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.
*
*
* @return The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your
* bot.
*/
public final String userId() {
return userId;
}
/**
*
* A string used to filter the intents returned in the recentIntentSummaryView structure.
*
*
* When you specify a filter, only intents with their checkpointLabel field set to that string are
* returned.
*
*
* @return A string used to filter the intents returned in the recentIntentSummaryView structure.
*
* When you specify a filter, only intents with their checkpointLabel field set to that string
* are returned.
*/
public final String checkpointLabelFilter() {
return checkpointLabelFilter;
}
@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(botName());
hashCode = 31 * hashCode + Objects.hashCode(botAlias());
hashCode = 31 * hashCode + Objects.hashCode(userId());
hashCode = 31 * hashCode + Objects.hashCode(checkpointLabelFilter());
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 GetSessionRequest)) {
return false;
}
GetSessionRequest other = (GetSessionRequest) obj;
return Objects.equals(botName(), other.botName()) && Objects.equals(botAlias(), other.botAlias())
&& Objects.equals(userId(), other.userId())
&& Objects.equals(checkpointLabelFilter(), other.checkpointLabelFilter());
}
/**
* 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("GetSessionRequest").add("BotName", botName()).add("BotAlias", botAlias())
.add("UserId", userId()).add("CheckpointLabelFilter", checkpointLabelFilter()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "botName":
return Optional.ofNullable(clazz.cast(botName()));
case "botAlias":
return Optional.ofNullable(clazz.cast(botAlias()));
case "userId":
return Optional.ofNullable(clazz.cast(userId()));
case "checkpointLabelFilter":
return Optional.ofNullable(clazz.cast(checkpointLabelFilter()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetSessionRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends LexRuntimeRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the bot that contains the session data.
*
*
* @param botName
* The name of the bot that contains the session data.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder botName(String botName);
/**
*
* The alias in use for the bot that contains the session data.
*
*
* @param botAlias
* The alias in use for the bot that contains the session data.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder botAlias(String botAlias);
/**
*
* The ID of the client application user. Amazon Lex uses this to identify a user's conversation with your bot.
*
*
* @param userId
* The ID of the client application user. Amazon Lex uses this to identify a user's conversation with
* your bot.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder userId(String userId);
/**
*
* A string used to filter the intents returned in the recentIntentSummaryView structure.
*
*
* When you specify a filter, only intents with their checkpointLabel field set to that string are
* returned.
*
*
* @param checkpointLabelFilter
* A string used to filter the intents returned in the recentIntentSummaryView structure.
*
*
* When you specify a filter, only intents with their checkpointLabel field set to that
* string are returned.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder checkpointLabelFilter(String checkpointLabelFilter);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends LexRuntimeRequest.BuilderImpl implements Builder {
private String botName;
private String botAlias;
private String userId;
private String checkpointLabelFilter;
private BuilderImpl() {
}
private BuilderImpl(GetSessionRequest model) {
super(model);
botName(model.botName);
botAlias(model.botAlias);
userId(model.userId);
checkpointLabelFilter(model.checkpointLabelFilter);
}
public final String getBotName() {
return botName;
}
public final void setBotName(String botName) {
this.botName = botName;
}
@Override
public final Builder botName(String botName) {
this.botName = botName;
return this;
}
public final String getBotAlias() {
return botAlias;
}
public final void setBotAlias(String botAlias) {
this.botAlias = botAlias;
}
@Override
public final Builder botAlias(String botAlias) {
this.botAlias = botAlias;
return this;
}
public final String getUserId() {
return userId;
}
public final void setUserId(String userId) {
this.userId = userId;
}
@Override
public final Builder userId(String userId) {
this.userId = userId;
return this;
}
public final String getCheckpointLabelFilter() {
return checkpointLabelFilter;
}
public final void setCheckpointLabelFilter(String checkpointLabelFilter) {
this.checkpointLabelFilter = checkpointLabelFilter;
}
@Override
public final Builder checkpointLabelFilter(String checkpointLabelFilter) {
this.checkpointLabelFilter = checkpointLabelFilter;
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 GetSessionRequest build() {
return new GetSessionRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}