software.amazon.awssdk.services.connect.model.RealTimeContactAnalysisSegmentPostContactSummary Maven / Gradle / Ivy
Show all versions of connect 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.connect.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;
/**
*
* Information about the post-contact summary for a real-time contact segment.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class RealTimeContactAnalysisSegmentPostContactSummary
implements
SdkPojo,
Serializable,
ToCopyableBuilder {
private static final SdkField CONTENT_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Content")
.getter(getter(RealTimeContactAnalysisSegmentPostContactSummary::content)).setter(setter(Builder::content))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Content").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Status")
.getter(getter(RealTimeContactAnalysisSegmentPostContactSummary::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Status").build()).build();
private static final SdkField FAILURE_CODE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("FailureCode").getter(getter(RealTimeContactAnalysisSegmentPostContactSummary::failureCodeAsString))
.setter(setter(Builder::failureCode))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("FailureCode").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CONTENT_FIELD, STATUS_FIELD,
FAILURE_CODE_FIELD));
private static final long serialVersionUID = 1L;
private final String content;
private final String status;
private final String failureCode;
private RealTimeContactAnalysisSegmentPostContactSummary(BuilderImpl builder) {
this.content = builder.content;
this.status = builder.status;
this.failureCode = builder.failureCode;
}
/**
*
* The content of the summary.
*
*
* @return The content of the summary.
*/
public final String content() {
return content;
}
/**
*
* Whether the summary was successfully COMPLETED or FAILED to be generated.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link RealTimeContactAnalysisPostContactSummaryStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by
* the service is available from {@link #statusAsString}.
*
*
* @return Whether the summary was successfully COMPLETED or FAILED to be generated.
* @see RealTimeContactAnalysisPostContactSummaryStatus
*/
public final RealTimeContactAnalysisPostContactSummaryStatus status() {
return RealTimeContactAnalysisPostContactSummaryStatus.fromValue(status);
}
/**
*
* Whether the summary was successfully COMPLETED or FAILED to be generated.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link RealTimeContactAnalysisPostContactSummaryStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by
* the service is available from {@link #statusAsString}.
*
*
* @return Whether the summary was successfully COMPLETED or FAILED to be generated.
* @see RealTimeContactAnalysisPostContactSummaryStatus
*/
public final String statusAsString() {
return status;
}
/**
*
* If the summary failed to be generated, one of the following failure codes occurs:
*
*
* -
*
* QUOTA_EXCEEDED: The number of concurrent analytics jobs reached your service quota.
*
*
* -
*
* INSUFFICIENT_CONVERSATION_CONTENT: The conversation needs to have at least one turn from both the
* participants in order to generate the summary.
*
*
* -
*
* FAILED_SAFETY_GUIDELINES: The generated summary cannot be provided because it failed to meet system
* safety guidelines.
*
*
* -
*
* INVALID_ANALYSIS_CONFIGURATION: This code occurs when, for example, you're using a language that isn't supported by generative AI-powered post-contact summaries.
*
*
* -
*
* INTERNAL_ERROR: Internal system error.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #failureCode} will
* return {@link RealTimeContactAnalysisPostContactSummaryFailureCode#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #failureCodeAsString}.
*
*
* @return If the summary failed to be generated, one of the following failure codes occurs:
*
* -
*
* QUOTA_EXCEEDED: The number of concurrent analytics jobs reached your service quota.
*
*
* -
*
* INSUFFICIENT_CONVERSATION_CONTENT: The conversation needs to have at least one turn from
* both the participants in order to generate the summary.
*
*
* -
*
* FAILED_SAFETY_GUIDELINES: The generated summary cannot be provided because it failed to meet
* system safety guidelines.
*
*
* -
*
* INVALID_ANALYSIS_CONFIGURATION: This code occurs when, for example, you're using a language that isn't supported by generative AI-powered post-contact summaries.
*
*
* -
*
* INTERNAL_ERROR: Internal system error.
*
*
* @see RealTimeContactAnalysisPostContactSummaryFailureCode
*/
public final RealTimeContactAnalysisPostContactSummaryFailureCode failureCode() {
return RealTimeContactAnalysisPostContactSummaryFailureCode.fromValue(failureCode);
}
/**
*
* If the summary failed to be generated, one of the following failure codes occurs:
*
*
* -
*
* QUOTA_EXCEEDED: The number of concurrent analytics jobs reached your service quota.
*
*
* -
*
* INSUFFICIENT_CONVERSATION_CONTENT: The conversation needs to have at least one turn from both the
* participants in order to generate the summary.
*
*
* -
*
* FAILED_SAFETY_GUIDELINES: The generated summary cannot be provided because it failed to meet system
* safety guidelines.
*
*
* -
*
* INVALID_ANALYSIS_CONFIGURATION: This code occurs when, for example, you're using a language that isn't supported by generative AI-powered post-contact summaries.
*
*
* -
*
* INTERNAL_ERROR: Internal system error.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #failureCode} will
* return {@link RealTimeContactAnalysisPostContactSummaryFailureCode#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #failureCodeAsString}.
*
*
* @return If the summary failed to be generated, one of the following failure codes occurs:
*
* -
*
* QUOTA_EXCEEDED: The number of concurrent analytics jobs reached your service quota.
*
*
* -
*
* INSUFFICIENT_CONVERSATION_CONTENT: The conversation needs to have at least one turn from
* both the participants in order to generate the summary.
*
*
* -
*
* FAILED_SAFETY_GUIDELINES: The generated summary cannot be provided because it failed to meet
* system safety guidelines.
*
*
* -
*
* INVALID_ANALYSIS_CONFIGURATION: This code occurs when, for example, you're using a language that isn't supported by generative AI-powered post-contact summaries.
*
*
* -
*
* INTERNAL_ERROR: Internal system error.
*
*
* @see RealTimeContactAnalysisPostContactSummaryFailureCode
*/
public final String failureCodeAsString() {
return failureCode;
}
@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(content());
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
hashCode = 31 * hashCode + Objects.hashCode(failureCodeAsString());
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 RealTimeContactAnalysisSegmentPostContactSummary)) {
return false;
}
RealTimeContactAnalysisSegmentPostContactSummary other = (RealTimeContactAnalysisSegmentPostContactSummary) obj;
return Objects.equals(content(), other.content()) && Objects.equals(statusAsString(), other.statusAsString())
&& Objects.equals(failureCodeAsString(), other.failureCodeAsString());
}
/**
* 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("RealTimeContactAnalysisSegmentPostContactSummary").add("Content", content())
.add("Status", statusAsString()).add("FailureCode", failureCodeAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Content":
return Optional.ofNullable(clazz.cast(content()));
case "Status":
return Optional.ofNullable(clazz.cast(statusAsString()));
case "FailureCode":
return Optional.ofNullable(clazz.cast(failureCodeAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((RealTimeContactAnalysisSegmentPostContactSummary) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The content of the summary.
*
*
* @param content
* The content of the summary.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder content(String content);
/**
*
* Whether the summary was successfully COMPLETED or FAILED to be generated.
*
*
* @param status
* Whether the summary was successfully COMPLETED or FAILED to be generated.
* @see RealTimeContactAnalysisPostContactSummaryStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see RealTimeContactAnalysisPostContactSummaryStatus
*/
Builder status(String status);
/**
*
* Whether the summary was successfully COMPLETED or FAILED to be generated.
*
*
* @param status
* Whether the summary was successfully COMPLETED or FAILED to be generated.
* @see RealTimeContactAnalysisPostContactSummaryStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see RealTimeContactAnalysisPostContactSummaryStatus
*/
Builder status(RealTimeContactAnalysisPostContactSummaryStatus status);
/**
*
* If the summary failed to be generated, one of the following failure codes occurs:
*
*
* -
*
* QUOTA_EXCEEDED: The number of concurrent analytics jobs reached your service quota.
*
*
* -
*
* INSUFFICIENT_CONVERSATION_CONTENT: The conversation needs to have at least one turn from both
* the participants in order to generate the summary.
*
*
* -
*
* FAILED_SAFETY_GUIDELINES: The generated summary cannot be provided because it failed to meet
* system safety guidelines.
*
*
* -
*
* INVALID_ANALYSIS_CONFIGURATION: This code occurs when, for example, you're using a language that isn't supported by generative AI-powered post-contact summaries.
*
*
* -
*
* INTERNAL_ERROR: Internal system error.
*
*
*
*
* @param failureCode
* If the summary failed to be generated, one of the following failure codes occurs:
*
* -
*
* QUOTA_EXCEEDED: The number of concurrent analytics jobs reached your service quota.
*
*
* -
*
* INSUFFICIENT_CONVERSATION_CONTENT: The conversation needs to have at least one turn from
* both the participants in order to generate the summary.
*
*
* -
*
* FAILED_SAFETY_GUIDELINES: The generated summary cannot be provided because it failed to
* meet system safety guidelines.
*
*
* -
*
* INVALID_ANALYSIS_CONFIGURATION: This code occurs when, for example, you're using a language that isn't supported by generative AI-powered post-contact summaries.
*
*
* -
*
* INTERNAL_ERROR: Internal system error.
*
*
* @see RealTimeContactAnalysisPostContactSummaryFailureCode
* @return Returns a reference to this object so that method calls can be chained together.
* @see RealTimeContactAnalysisPostContactSummaryFailureCode
*/
Builder failureCode(String failureCode);
/**
*
* If the summary failed to be generated, one of the following failure codes occurs:
*
*
* -
*
* QUOTA_EXCEEDED: The number of concurrent analytics jobs reached your service quota.
*
*
* -
*
* INSUFFICIENT_CONVERSATION_CONTENT: The conversation needs to have at least one turn from both
* the participants in order to generate the summary.
*
*
* -
*
* FAILED_SAFETY_GUIDELINES: The generated summary cannot be provided because it failed to meet
* system safety guidelines.
*
*
* -
*
* INVALID_ANALYSIS_CONFIGURATION: This code occurs when, for example, you're using a language that isn't supported by generative AI-powered post-contact summaries.
*
*
* -
*
* INTERNAL_ERROR: Internal system error.
*
*
*
*
* @param failureCode
* If the summary failed to be generated, one of the following failure codes occurs:
*
* -
*
* QUOTA_EXCEEDED: The number of concurrent analytics jobs reached your service quota.
*
*
* -
*
* INSUFFICIENT_CONVERSATION_CONTENT: The conversation needs to have at least one turn from
* both the participants in order to generate the summary.
*
*
* -
*
* FAILED_SAFETY_GUIDELINES: The generated summary cannot be provided because it failed to
* meet system safety guidelines.
*
*
* -
*
* INVALID_ANALYSIS_CONFIGURATION: This code occurs when, for example, you're using a language that isn't supported by generative AI-powered post-contact summaries.
*
*
* -
*
* INTERNAL_ERROR: Internal system error.
*
*
* @see RealTimeContactAnalysisPostContactSummaryFailureCode
* @return Returns a reference to this object so that method calls can be chained together.
* @see RealTimeContactAnalysisPostContactSummaryFailureCode
*/
Builder failureCode(RealTimeContactAnalysisPostContactSummaryFailureCode failureCode);
}
static final class BuilderImpl implements Builder {
private String content;
private String status;
private String failureCode;
private BuilderImpl() {
}
private BuilderImpl(RealTimeContactAnalysisSegmentPostContactSummary model) {
content(model.content);
status(model.status);
failureCode(model.failureCode);
}
public final String getContent() {
return content;
}
public final void setContent(String content) {
this.content = content;
}
@Override
public final Builder content(String content) {
this.content = content;
return this;
}
public final String getStatus() {
return status;
}
public final void setStatus(String status) {
this.status = status;
}
@Override
public final Builder status(String status) {
this.status = status;
return this;
}
@Override
public final Builder status(RealTimeContactAnalysisPostContactSummaryStatus status) {
this.status(status == null ? null : status.toString());
return this;
}
public final String getFailureCode() {
return failureCode;
}
public final void setFailureCode(String failureCode) {
this.failureCode = failureCode;
}
@Override
public final Builder failureCode(String failureCode) {
this.failureCode = failureCode;
return this;
}
@Override
public final Builder failureCode(RealTimeContactAnalysisPostContactSummaryFailureCode failureCode) {
this.failureCode(failureCode == null ? null : failureCode.toString());
return this;
}
@Override
public RealTimeContactAnalysisSegmentPostContactSummary build() {
return new RealTimeContactAnalysisSegmentPostContactSummary(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}