software.amazon.awssdk.services.lexmodelbuilding.model.ConversationLogsRequest Maven / Gradle / Ivy
/*
* 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.lexmodelbuilding.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
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 java.util.stream.Collectors;
import java.util.stream.Stream;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Provides the settings needed for conversation logs.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ConversationLogsRequest implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField> LOG_SETTINGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("logSettings")
.getter(getter(ConversationLogsRequest::logSettings))
.setter(setter(Builder::logSettings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("logSettings").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(LogSettingsRequest::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField IAM_ROLE_ARN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("iamRoleArn").getter(getter(ConversationLogsRequest::iamRoleArn)).setter(setter(Builder::iamRoleArn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("iamRoleArn").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(LOG_SETTINGS_FIELD,
IAM_ROLE_ARN_FIELD));
private static final long serialVersionUID = 1L;
private final List logSettings;
private final String iamRoleArn;
private ConversationLogsRequest(BuilderImpl builder) {
this.logSettings = builder.logSettings;
this.iamRoleArn = builder.iamRoleArn;
}
/**
* For responses, this returns true if the service returned a value for the LogSettings 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 hasLogSettings() {
return logSettings != null && !(logSettings instanceof SdkAutoConstructList);
}
/**
*
* The settings for your conversation logs. You can log the conversation text, conversation audio, or both.
*
*
* 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 #hasLogSettings} method.
*
*
* @return The settings for your conversation logs. You can log the conversation text, conversation audio, or both.
*/
public final List logSettings() {
return logSettings;
}
/**
*
* The Amazon Resource Name (ARN) of an IAM role with permission to write to your CloudWatch Logs for text logs and
* your S3 bucket for audio logs. If audio encryption is enabled, this role also provides access permission for the
* AWS KMS key used for encrypting audio logs. For more information, see Creating an IAM Role and
* Policy for Conversation Logs.
*
*
* @return The Amazon Resource Name (ARN) of an IAM role with permission to write to your CloudWatch Logs for text
* logs and your S3 bucket for audio logs. If audio encryption is enabled, this role also provides access
* permission for the AWS KMS key used for encrypting audio logs. For more information, see Creating an IAM
* Role and Policy for Conversation Logs.
*/
public final String iamRoleArn() {
return iamRoleArn;
}
@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(hasLogSettings() ? logSettings() : null);
hashCode = 31 * hashCode + Objects.hashCode(iamRoleArn());
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 ConversationLogsRequest)) {
return false;
}
ConversationLogsRequest other = (ConversationLogsRequest) obj;
return hasLogSettings() == other.hasLogSettings() && Objects.equals(logSettings(), other.logSettings())
&& Objects.equals(iamRoleArn(), other.iamRoleArn());
}
/**
* 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("ConversationLogsRequest").add("LogSettings", hasLogSettings() ? logSettings() : null)
.add("IamRoleArn", iamRoleArn()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "logSettings":
return Optional.ofNullable(clazz.cast(logSettings()));
case "iamRoleArn":
return Optional.ofNullable(clazz.cast(iamRoleArn()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ConversationLogsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The settings for your conversation logs. You can log the conversation text, conversation audio, or both.
*
*
* @param logSettings
* The settings for your conversation logs. You can log the conversation text, conversation audio, or
* both.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder logSettings(Collection logSettings);
/**
*
* The settings for your conversation logs. You can log the conversation text, conversation audio, or both.
*
*
* @param logSettings
* The settings for your conversation logs. You can log the conversation text, conversation audio, or
* both.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder logSettings(LogSettingsRequest... logSettings);
/**
*
* The settings for your conversation logs. You can log the conversation text, conversation audio, or both.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.lexmodelbuilding.model.LogSettingsRequest.Builder} avoiding the need
* to create one manually via
* {@link software.amazon.awssdk.services.lexmodelbuilding.model.LogSettingsRequest#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.lexmodelbuilding.model.LogSettingsRequest.Builder#build()} is called
* immediately and its result is passed to {@link #logSettings(List)}.
*
* @param logSettings
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.lexmodelbuilding.model.LogSettingsRequest.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #logSettings(java.util.Collection)
*/
Builder logSettings(Consumer... logSettings);
/**
*
* The Amazon Resource Name (ARN) of an IAM role with permission to write to your CloudWatch Logs for text logs
* and your S3 bucket for audio logs. If audio encryption is enabled, this role also provides access permission
* for the AWS KMS key used for encrypting audio logs. For more information, see Creating an IAM Role
* and Policy for Conversation Logs.
*
*
* @param iamRoleArn
* The Amazon Resource Name (ARN) of an IAM role with permission to write to your CloudWatch Logs for
* text logs and your S3 bucket for audio logs. If audio encryption is enabled, this role also provides
* access permission for the AWS KMS key used for encrypting audio logs. For more information, see Creating an
* IAM Role and Policy for Conversation Logs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder iamRoleArn(String iamRoleArn);
}
static final class BuilderImpl implements Builder {
private List logSettings = DefaultSdkAutoConstructList.getInstance();
private String iamRoleArn;
private BuilderImpl() {
}
private BuilderImpl(ConversationLogsRequest model) {
logSettings(model.logSettings);
iamRoleArn(model.iamRoleArn);
}
public final List getLogSettings() {
List result = LogSettingsRequestListCopier.copyToBuilder(this.logSettings);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setLogSettings(Collection logSettings) {
this.logSettings = LogSettingsRequestListCopier.copyFromBuilder(logSettings);
}
@Override
public final Builder logSettings(Collection logSettings) {
this.logSettings = LogSettingsRequestListCopier.copy(logSettings);
return this;
}
@Override
@SafeVarargs
public final Builder logSettings(LogSettingsRequest... logSettings) {
logSettings(Arrays.asList(logSettings));
return this;
}
@Override
@SafeVarargs
public final Builder logSettings(Consumer... logSettings) {
logSettings(Stream.of(logSettings).map(c -> LogSettingsRequest.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final String getIamRoleArn() {
return iamRoleArn;
}
public final void setIamRoleArn(String iamRoleArn) {
this.iamRoleArn = iamRoleArn;
}
@Override
public final Builder iamRoleArn(String iamRoleArn) {
this.iamRoleArn = iamRoleArn;
return this;
}
@Override
public ConversationLogsRequest build() {
return new ConversationLogsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}