software.amazon.awssdk.services.transcribe.model.ListMedicalTranscriptionJobsResponse 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.transcribe.model;
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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class ListMedicalTranscriptionJobsResponse extends TranscribeResponse implements
ToCopyableBuilder {
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Status")
.getter(getter(ListMedicalTranscriptionJobsResponse::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Status").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(ListMedicalTranscriptionJobsResponse::nextToken))
.setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final SdkField> MEDICAL_TRANSCRIPTION_JOB_SUMMARIES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("MedicalTranscriptionJobSummaries")
.getter(getter(ListMedicalTranscriptionJobsResponse::medicalTranscriptionJobSummaries))
.setter(setter(Builder::medicalTranscriptionJobSummaries))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MedicalTranscriptionJobSummaries")
.build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(MedicalTranscriptionJobSummary::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(STATUS_FIELD,
NEXT_TOKEN_FIELD, MEDICAL_TRANSCRIPTION_JOB_SUMMARIES_FIELD));
private final String status;
private final String nextToken;
private final List medicalTranscriptionJobSummaries;
private ListMedicalTranscriptionJobsResponse(BuilderImpl builder) {
super(builder);
this.status = builder.status;
this.nextToken = builder.nextToken;
this.medicalTranscriptionJobSummaries = builder.medicalTranscriptionJobSummaries;
}
/**
*
* The requested status of the medical transcription jobs returned.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link TranscriptionJobStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #statusAsString}.
*
*
* @return The requested status of the medical transcription jobs returned.
* @see TranscriptionJobStatus
*/
public TranscriptionJobStatus status() {
return TranscriptionJobStatus.fromValue(status);
}
/**
*
* The requested status of the medical transcription jobs returned.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link TranscriptionJobStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #statusAsString}.
*
*
* @return The requested status of the medical transcription jobs returned.
* @see TranscriptionJobStatus
*/
public String statusAsString() {
return status;
}
/**
*
* The ListMedicalTranscriptionJobs operation returns a page of jobs at a time. The maximum size of the
* page is set by the MaxResults parameter. If the number of jobs exceeds what can fit on a page,
* Amazon Transcribe Medical returns the NextPage token. Include the token in the next request to the
* ListMedicalTranscriptionJobs operation to return in the next page of jobs.
*
*
* @return The ListMedicalTranscriptionJobs operation returns a page of jobs at a time. The maximum
* size of the page is set by the MaxResults parameter. If the number of jobs exceeds what can
* fit on a page, Amazon Transcribe Medical returns the NextPage token. Include the token in
* the next request to the ListMedicalTranscriptionJobs operation to return in the next page of
* jobs.
*/
public String nextToken() {
return nextToken;
}
/**
* Returns true if the MedicalTranscriptionJobSummaries property was specified by the sender (it may be empty), or
* false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender
* is the AWS service.
*/
public boolean hasMedicalTranscriptionJobSummaries() {
return medicalTranscriptionJobSummaries != null && !(medicalTranscriptionJobSummaries instanceof SdkAutoConstructList);
}
/**
*
* A list of objects containing summary information for a transcription job.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasMedicalTranscriptionJobSummaries()} to see if a value was sent in this field.
*
*
* @return A list of objects containing summary information for a transcription job.
*/
public List medicalTranscriptionJobSummaries() {
return medicalTranscriptionJobSummaries;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode
+ Objects.hashCode(hasMedicalTranscriptionJobSummaries() ? medicalTranscriptionJobSummaries() : null);
return hashCode;
}
@Override
public boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ListMedicalTranscriptionJobsResponse)) {
return false;
}
ListMedicalTranscriptionJobsResponse other = (ListMedicalTranscriptionJobsResponse) obj;
return Objects.equals(statusAsString(), other.statusAsString()) && Objects.equals(nextToken(), other.nextToken())
&& hasMedicalTranscriptionJobSummaries() == other.hasMedicalTranscriptionJobSummaries()
&& Objects.equals(medicalTranscriptionJobSummaries(), other.medicalTranscriptionJobSummaries());
}
/**
* 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 String toString() {
return ToString
.builder("ListMedicalTranscriptionJobsResponse")
.add("Status", statusAsString())
.add("NextToken", nextToken())
.add("MedicalTranscriptionJobSummaries",
hasMedicalTranscriptionJobSummaries() ? medicalTranscriptionJobSummaries() : null).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Status":
return Optional.ofNullable(clazz.cast(statusAsString()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "MedicalTranscriptionJobSummaries":
return Optional.ofNullable(clazz.cast(medicalTranscriptionJobSummaries()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ListMedicalTranscriptionJobsResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends TranscribeResponse.Builder, SdkPojo,
CopyableBuilder {
/**
*
* The requested status of the medical transcription jobs returned.
*
*
* @param status
* The requested status of the medical transcription jobs returned.
* @see TranscriptionJobStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see TranscriptionJobStatus
*/
Builder status(String status);
/**
*
* The requested status of the medical transcription jobs returned.
*
*
* @param status
* The requested status of the medical transcription jobs returned.
* @see TranscriptionJobStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see TranscriptionJobStatus
*/
Builder status(TranscriptionJobStatus status);
/**
*
* The ListMedicalTranscriptionJobs operation returns a page of jobs at a time. The maximum size of
* the page is set by the MaxResults parameter. If the number of jobs exceeds what can fit on a
* page, Amazon Transcribe Medical returns the NextPage token. Include the token in the next
* request to the ListMedicalTranscriptionJobs operation to return in the next page of jobs.
*
*
* @param nextToken
* The ListMedicalTranscriptionJobs operation returns a page of jobs at a time. The maximum
* size of the page is set by the MaxResults parameter. If the number of jobs exceeds what
* can fit on a page, Amazon Transcribe Medical returns the NextPage token. Include the
* token in the next request to the ListMedicalTranscriptionJobs operation to return in the
* next page of jobs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* A list of objects containing summary information for a transcription job.
*
*
* @param medicalTranscriptionJobSummaries
* A list of objects containing summary information for a transcription job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder medicalTranscriptionJobSummaries(Collection medicalTranscriptionJobSummaries);
/**
*
* A list of objects containing summary information for a transcription job.
*
*
* @param medicalTranscriptionJobSummaries
* A list of objects containing summary information for a transcription job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder medicalTranscriptionJobSummaries(MedicalTranscriptionJobSummary... medicalTranscriptionJobSummaries);
/**
*
* A list of objects containing summary information for a transcription job.
*
* This is a convenience 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
* #medicalTranscriptionJobSummaries(List)}.
*
* @param medicalTranscriptionJobSummaries
* 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 #medicalTranscriptionJobSummaries(List)
*/
Builder medicalTranscriptionJobSummaries(
Consumer... medicalTranscriptionJobSummaries);
}
static final class BuilderImpl extends TranscribeResponse.BuilderImpl implements Builder {
private String status;
private String nextToken;
private List medicalTranscriptionJobSummaries = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ListMedicalTranscriptionJobsResponse model) {
super(model);
status(model.status);
nextToken(model.nextToken);
medicalTranscriptionJobSummaries(model.medicalTranscriptionJobSummaries);
}
public final String getStatus() {
return status;
}
@Override
public final Builder status(String status) {
this.status = status;
return this;
}
@Override
public final Builder status(TranscriptionJobStatus status) {
this.status(status == null ? null : status.toString());
return this;
}
public final void setStatus(String status) {
this.status = status;
}
public final String getNextToken() {
return nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
public final Collection getMedicalTranscriptionJobSummaries() {
if (medicalTranscriptionJobSummaries instanceof SdkAutoConstructList) {
return null;
}
return medicalTranscriptionJobSummaries != null ? medicalTranscriptionJobSummaries.stream()
.map(MedicalTranscriptionJobSummary::toBuilder).collect(Collectors.toList()) : null;
}
@Override
public final Builder medicalTranscriptionJobSummaries(
Collection medicalTranscriptionJobSummaries) {
this.medicalTranscriptionJobSummaries = MedicalTranscriptionJobSummariesCopier.copy(medicalTranscriptionJobSummaries);
return this;
}
@Override
@SafeVarargs
public final Builder medicalTranscriptionJobSummaries(MedicalTranscriptionJobSummary... medicalTranscriptionJobSummaries) {
medicalTranscriptionJobSummaries(Arrays.asList(medicalTranscriptionJobSummaries));
return this;
}
@Override
@SafeVarargs
public final Builder medicalTranscriptionJobSummaries(
Consumer... medicalTranscriptionJobSummaries) {
medicalTranscriptionJobSummaries(Stream.of(medicalTranscriptionJobSummaries)
.map(c -> MedicalTranscriptionJobSummary.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final void setMedicalTranscriptionJobSummaries(
Collection medicalTranscriptionJobSummaries) {
this.medicalTranscriptionJobSummaries = MedicalTranscriptionJobSummariesCopier
.copyFromBuilder(medicalTranscriptionJobSummaries);
}
@Override
public ListMedicalTranscriptionJobsResponse build() {
return new ListMedicalTranscriptionJobsResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy