software.amazon.awssdk.services.transcribestreaming.model.MedicalAlternative Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of transcribestreaming Show documentation
Show all versions of transcribestreaming Show documentation
The AWS Java SDK for AWS Transcribe Streaming module holds the client classes that are used for
communicating with AWS Transcribe Streaming Service
/*
* 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;
/**
*
* A list of possible transcriptions for the audio.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class MedicalAlternative implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField TRANSCRIPT_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Transcript").getter(getter(MedicalAlternative::transcript)).setter(setter(Builder::transcript))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Transcript").build()).build();
private static final SdkField> ITEMS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Items")
.getter(getter(MedicalAlternative::items))
.setter(setter(Builder::items))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Items").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(MedicalItem::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> ENTITIES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Entities")
.getter(getter(MedicalAlternative::entities))
.setter(setter(Builder::entities))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Entities").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(MedicalEntity::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TRANSCRIPT_FIELD, ITEMS_FIELD,
ENTITIES_FIELD));
private static final long serialVersionUID = 1L;
private final String transcript;
private final List items;
private final List entities;
private MedicalAlternative(BuilderImpl builder) {
this.transcript = builder.transcript;
this.items = builder.items;
this.entities = builder.entities;
}
/**
*
* The text that was transcribed from the audio.
*
*
* @return The text that was transcribed from the audio.
*/
public final String transcript() {
return transcript;
}
/**
* For responses, this returns true if the service returned a value for the Items 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 hasItems() {
return items != null && !(items instanceof SdkAutoConstructList);
}
/**
*
* A list of objects that contains words and punctuation marks that represents one or more interpretations of the
* input audio.
*
*
* 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 #hasItems} method.
*
*
* @return A list of objects that contains words and punctuation marks that represents one or more interpretations
* of the input audio.
*/
public final List items() {
return items;
}
/**
* For responses, this returns true if the service returned a value for the Entities 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 hasEntities() {
return entities != null && !(entities instanceof SdkAutoConstructList);
}
/**
*
* Contains the medical entities identified as personal health information in the transcription output.
*
*
* 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 #hasEntities} method.
*
*
* @return Contains the medical entities identified as personal health information in the transcription output.
*/
public final List entities() {
return entities;
}
@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(transcript());
hashCode = 31 * hashCode + Objects.hashCode(hasItems() ? items() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasEntities() ? entities() : null);
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 MedicalAlternative)) {
return false;
}
MedicalAlternative other = (MedicalAlternative) obj;
return Objects.equals(transcript(), other.transcript()) && hasItems() == other.hasItems()
&& Objects.equals(items(), other.items()) && hasEntities() == other.hasEntities()
&& Objects.equals(entities(), other.entities());
}
/**
* 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("MedicalAlternative").add("Transcript", transcript()).add("Items", hasItems() ? items() : null)
.add("Entities", hasEntities() ? entities() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Transcript":
return Optional.ofNullable(clazz.cast(transcript()));
case "Items":
return Optional.ofNullable(clazz.cast(items()));
case "Entities":
return Optional.ofNullable(clazz.cast(entities()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((MedicalAlternative) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The text that was transcribed from the audio.
*
*
* @param transcript
* The text that was transcribed from the audio.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder transcript(String transcript);
/**
*
* A list of objects that contains words and punctuation marks that represents one or more interpretations of
* the input audio.
*
*
* @param items
* A list of objects that contains words and punctuation marks that represents one or more
* interpretations of the input audio.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder items(Collection items);
/**
*
* A list of objects that contains words and punctuation marks that represents one or more interpretations of
* the input audio.
*
*
* @param items
* A list of objects that contains words and punctuation marks that represents one or more
* interpretations of the input audio.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder items(MedicalItem... items);
/**
*
* A list of objects that contains words and punctuation marks that represents one or more interpretations of
* the input audio.
*
* This is a convenience method that creates an instance of the {@link List.Builder} avoiding the
* need to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and its
* result is passed to {@link #items(List)}.
*
* @param items
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #items(List)
*/
Builder items(Consumer... items);
/**
*
* Contains the medical entities identified as personal health information in the transcription output.
*
*
* @param entities
* Contains the medical entities identified as personal health information in the transcription output.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder entities(Collection entities);
/**
*
* Contains the medical entities identified as personal health information in the transcription output.
*
*
* @param entities
* Contains the medical entities identified as personal health information in the transcription output.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder entities(MedicalEntity... entities);
/**
*
* Contains the medical entities identified as personal health information in the transcription output.
*
* This is a convenience method that creates an instance of the {@link List.Builder} avoiding the
* need to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called immediately and
* its result is passed to {@link #entities(List)}.
*
* @param entities
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #entities(List)
*/
Builder entities(Consumer... entities);
}
static final class BuilderImpl implements Builder {
private String transcript;
private List items = DefaultSdkAutoConstructList.getInstance();
private List entities = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(MedicalAlternative model) {
transcript(model.transcript);
items(model.items);
entities(model.entities);
}
public final String getTranscript() {
return transcript;
}
public final void setTranscript(String transcript) {
this.transcript = transcript;
}
@Override
public final Builder transcript(String transcript) {
this.transcript = transcript;
return this;
}
public final List getItems() {
List result = MedicalItemListCopier.copyToBuilder(this.items);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setItems(Collection items) {
this.items = MedicalItemListCopier.copyFromBuilder(items);
}
@Override
public final Builder items(Collection items) {
this.items = MedicalItemListCopier.copy(items);
return this;
}
@Override
@SafeVarargs
public final Builder items(MedicalItem... items) {
items(Arrays.asList(items));
return this;
}
@Override
@SafeVarargs
public final Builder items(Consumer... items) {
items(Stream.of(items).map(c -> MedicalItem.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final List getEntities() {
List result = MedicalEntityListCopier.copyToBuilder(this.entities);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setEntities(Collection entities) {
this.entities = MedicalEntityListCopier.copyFromBuilder(entities);
}
@Override
public final Builder entities(Collection entities) {
this.entities = MedicalEntityListCopier.copy(entities);
return this;
}
@Override
@SafeVarargs
public final Builder entities(MedicalEntity... entities) {
entities(Arrays.asList(entities));
return this;
}
@Override
@SafeVarargs
public final Builder entities(Consumer... entities) {
entities(Stream.of(entities).map(c -> MedicalEntity.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public MedicalAlternative build() {
return new MedicalAlternative(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy