software.amazon.awssdk.services.transcribestreaming.model.MedicalResult Maven / Gradle / Ivy
Show all versions of transcribestreaming 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.transcribestreaming.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;
/**
*
* The Result associated with a
*
* Contains a set of transcription results from one or more audio segments, along with additional information per your
* request parameters. This can include information relating to alternative transcriptions, channel identification,
* partial result stabilization, language identification, and other transcription-related data.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class MedicalResult implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField RESULT_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ResultId").getter(getter(MedicalResult::resultId)).setter(setter(Builder::resultId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ResultId").build()).build();
private static final SdkField START_TIME_FIELD = SdkField. builder(MarshallingType.DOUBLE)
.memberName("StartTime").getter(getter(MedicalResult::startTime)).setter(setter(Builder::startTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StartTime").build()).build();
private static final SdkField END_TIME_FIELD = SdkField. builder(MarshallingType.DOUBLE)
.memberName("EndTime").getter(getter(MedicalResult::endTime)).setter(setter(Builder::endTime))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EndTime").build()).build();
private static final SdkField IS_PARTIAL_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("IsPartial").getter(getter(MedicalResult::isPartial)).setter(setter(Builder::isPartial))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IsPartial").build()).build();
private static final SdkField> ALTERNATIVES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Alternatives")
.getter(getter(MedicalResult::alternatives))
.setter(setter(Builder::alternatives))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Alternatives").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(MedicalAlternative::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField CHANNEL_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ChannelId").getter(getter(MedicalResult::channelId)).setter(setter(Builder::channelId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ChannelId").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(RESULT_ID_FIELD,
START_TIME_FIELD, END_TIME_FIELD, IS_PARTIAL_FIELD, ALTERNATIVES_FIELD, CHANNEL_ID_FIELD));
private static final long serialVersionUID = 1L;
private final String resultId;
private final Double startTime;
private final Double endTime;
private final Boolean isPartial;
private final List alternatives;
private final String channelId;
private MedicalResult(BuilderImpl builder) {
this.resultId = builder.resultId;
this.startTime = builder.startTime;
this.endTime = builder.endTime;
this.isPartial = builder.isPartial;
this.alternatives = builder.alternatives;
this.channelId = builder.channelId;
}
/**
*
* Provides a unique identifier for the Result.
*
*
* @return Provides a unique identifier for the Result.
*/
public final String resultId() {
return resultId;
}
/**
*
* The start time, in milliseconds, of the Result.
*
*
* @return The start time, in milliseconds, of the Result.
*/
public final Double startTime() {
return startTime;
}
/**
*
* The end time, in milliseconds, of the Result.
*
*
* @return The end time, in milliseconds, of the Result.
*/
public final Double endTime() {
return endTime;
}
/**
*
* Indicates if the segment is complete.
*
*
* If IsPartial is true, the segment is not complete. If IsPartial is
* false, the segment is complete.
*
*
* @return Indicates if the segment is complete.
*
* If IsPartial is true, the segment is not complete. If IsPartial is
* false, the segment is complete.
*/
public final Boolean isPartial() {
return isPartial;
}
/**
* For responses, this returns true if the service returned a value for the Alternatives 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 hasAlternatives() {
return alternatives != null && !(alternatives instanceof SdkAutoConstructList);
}
/**
*
* A list of possible alternative transcriptions for the input audio. Each alternative may contain one or more of
* Items, Entities, or Transcript.
*
*
* 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 #hasAlternatives} method.
*
*
* @return A list of possible alternative transcriptions for the input audio. Each alternative may contain one or
* more of Items, Entities, or Transcript.
*/
public final List alternatives() {
return alternatives;
}
/**
*
* Indicates the channel identified for the Result.
*
*
* @return Indicates the channel identified for the Result.
*/
public final String channelId() {
return channelId;
}
@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(resultId());
hashCode = 31 * hashCode + Objects.hashCode(startTime());
hashCode = 31 * hashCode + Objects.hashCode(endTime());
hashCode = 31 * hashCode + Objects.hashCode(isPartial());
hashCode = 31 * hashCode + Objects.hashCode(hasAlternatives() ? alternatives() : null);
hashCode = 31 * hashCode + Objects.hashCode(channelId());
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 MedicalResult)) {
return false;
}
MedicalResult other = (MedicalResult) obj;
return Objects.equals(resultId(), other.resultId()) && Objects.equals(startTime(), other.startTime())
&& Objects.equals(endTime(), other.endTime()) && Objects.equals(isPartial(), other.isPartial())
&& hasAlternatives() == other.hasAlternatives() && Objects.equals(alternatives(), other.alternatives())
&& Objects.equals(channelId(), other.channelId());
}
/**
* 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("MedicalResult").add("ResultId", resultId()).add("StartTime", startTime())
.add("EndTime", endTime()).add("IsPartial", isPartial())
.add("Alternatives", hasAlternatives() ? alternatives() : null).add("ChannelId", channelId()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ResultId":
return Optional.ofNullable(clazz.cast(resultId()));
case "StartTime":
return Optional.ofNullable(clazz.cast(startTime()));
case "EndTime":
return Optional.ofNullable(clazz.cast(endTime()));
case "IsPartial":
return Optional.ofNullable(clazz.cast(isPartial()));
case "Alternatives":
return Optional.ofNullable(clazz.cast(alternatives()));
case "ChannelId":
return Optional.ofNullable(clazz.cast(channelId()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((MedicalResult) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* Provides a unique identifier for the Result.
*
*
* @param resultId
* Provides a unique identifier for the Result.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder resultId(String resultId);
/**
*
* The start time, in milliseconds, of the Result.
*
*
* @param startTime
* The start time, in milliseconds, of the Result.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder startTime(Double startTime);
/**
*
* The end time, in milliseconds, of the Result.
*
*
* @param endTime
* The end time, in milliseconds, of the Result.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder endTime(Double endTime);
/**
*
* Indicates if the segment is complete.
*
*
* If IsPartial is true, the segment is not complete. If IsPartial is
* false, the segment is complete.
*
*
* @param isPartial
* Indicates if the segment is complete.
*
* If IsPartial is true, the segment is not complete. If IsPartial
* is false, the segment is complete.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder isPartial(Boolean isPartial);
/**
*
* A list of possible alternative transcriptions for the input audio. Each alternative may contain one or more
* of Items, Entities, or Transcript.
*
*
* @param alternatives
* A list of possible alternative transcriptions for the input audio. Each alternative may contain one or
* more of Items, Entities, or Transcript.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder alternatives(Collection alternatives);
/**
*
* A list of possible alternative transcriptions for the input audio. Each alternative may contain one or more
* of Items, Entities, or Transcript.
*
*
* @param alternatives
* A list of possible alternative transcriptions for the input audio. Each alternative may contain one or
* more of Items, Entities, or Transcript.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder alternatives(MedicalAlternative... alternatives);
/**
*
* A list of possible alternative transcriptions for the input audio. Each alternative may contain one or more
* of Items, Entities, or Transcript.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.transcribestreaming.model.MedicalAlternative.Builder} avoiding the
* need to create one manually via
* {@link software.amazon.awssdk.services.transcribestreaming.model.MedicalAlternative#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.transcribestreaming.model.MedicalAlternative.Builder#build()} is
* called immediately and its result is passed to {@link #alternatives(List)}.
*
* @param alternatives
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.transcribestreaming.model.MedicalAlternative.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #alternatives(java.util.Collection)
*/
Builder alternatives(Consumer... alternatives);
/**
*
* Indicates the channel identified for the Result.
*
*
* @param channelId
* Indicates the channel identified for the Result.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder channelId(String channelId);
}
static final class BuilderImpl implements Builder {
private String resultId;
private Double startTime;
private Double endTime;
private Boolean isPartial;
private List alternatives = DefaultSdkAutoConstructList.getInstance();
private String channelId;
private BuilderImpl() {
}
private BuilderImpl(MedicalResult model) {
resultId(model.resultId);
startTime(model.startTime);
endTime(model.endTime);
isPartial(model.isPartial);
alternatives(model.alternatives);
channelId(model.channelId);
}
public final String getResultId() {
return resultId;
}
public final void setResultId(String resultId) {
this.resultId = resultId;
}
@Override
public final Builder resultId(String resultId) {
this.resultId = resultId;
return this;
}
public final Double getStartTime() {
return startTime;
}
public final void setStartTime(Double startTime) {
this.startTime = startTime;
}
@Override
public final Builder startTime(Double startTime) {
this.startTime = startTime;
return this;
}
public final Double getEndTime() {
return endTime;
}
public final void setEndTime(Double endTime) {
this.endTime = endTime;
}
@Override
public final Builder endTime(Double endTime) {
this.endTime = endTime;
return this;
}
public final Boolean getIsPartial() {
return isPartial;
}
public final void setIsPartial(Boolean isPartial) {
this.isPartial = isPartial;
}
@Override
public final Builder isPartial(Boolean isPartial) {
this.isPartial = isPartial;
return this;
}
public final List getAlternatives() {
List result = MedicalAlternativeListCopier.copyToBuilder(this.alternatives);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setAlternatives(Collection alternatives) {
this.alternatives = MedicalAlternativeListCopier.copyFromBuilder(alternatives);
}
@Override
public final Builder alternatives(Collection alternatives) {
this.alternatives = MedicalAlternativeListCopier.copy(alternatives);
return this;
}
@Override
@SafeVarargs
public final Builder alternatives(MedicalAlternative... alternatives) {
alternatives(Arrays.asList(alternatives));
return this;
}
@Override
@SafeVarargs
public final Builder alternatives(Consumer... alternatives) {
alternatives(Stream.of(alternatives).map(c -> MedicalAlternative.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final String getChannelId() {
return channelId;
}
public final void setChannelId(String channelId) {
this.channelId = channelId;
}
@Override
public final Builder channelId(String channelId) {
this.channelId = channelId;
return this;
}
@Override
public MedicalResult build() {
return new MedicalResult(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}