software.amazon.awssdk.services.transcribe.model.ListTranscriptionJobsResponse Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of transcribe Show documentation
Show all versions of transcribe Show documentation
The AWS Java SDK for Transcribe module holds the client classes that are used for
communicating with Transcribe.
/*
* 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 ListTranscriptionJobsResponse extends TranscribeResponse implements
ToCopyableBuilder {
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Status")
.getter(getter(ListTranscriptionJobsResponse::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(ListTranscriptionJobsResponse::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final SdkField> TRANSCRIPTION_JOB_SUMMARIES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("TranscriptionJobSummaries")
.getter(getter(ListTranscriptionJobsResponse::transcriptionJobSummaries))
.setter(setter(Builder::transcriptionJobSummaries))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TranscriptionJobSummaries").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(TranscriptionJobSummary::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, TRANSCRIPTION_JOB_SUMMARIES_FIELD));
private final String status;
private final String nextToken;
private final List transcriptionJobSummaries;
private ListTranscriptionJobsResponse(BuilderImpl builder) {
super(builder);
this.status = builder.status;
this.nextToken = builder.nextToken;
this.transcriptionJobSummaries = builder.transcriptionJobSummaries;
}
/**
*
* Lists all transcription jobs that have the status specified in your request. Jobs are ordered by creation date,
* with the newest job first.
*
*
* 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 Lists all transcription jobs that have the status specified in your request. Jobs are ordered by creation
* date, with the newest job first.
* @see TranscriptionJobStatus
*/
public final TranscriptionJobStatus status() {
return TranscriptionJobStatus.fromValue(status);
}
/**
*
* Lists all transcription jobs that have the status specified in your request. Jobs are ordered by creation date,
* with the newest job first.
*
*
* 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 Lists all transcription jobs that have the status specified in your request. Jobs are ordered by creation
* date, with the newest job first.
* @see TranscriptionJobStatus
*/
public final String statusAsString() {
return status;
}
/**
*
* If NextToken is present in your response, it indicates that not all results are displayed. To view
* the next set of results, copy the string associated with the NextToken parameter in your results
* output, then run your request again including NextToken with the value of the copied string. Repeat
* as needed to view all your results.
*
*
* @return If NextToken is present in your response, it indicates that not all results are displayed.
* To view the next set of results, copy the string associated with the NextToken parameter in
* your results output, then run your request again including NextToken with the value of the
* copied string. Repeat as needed to view all your results.
*/
public final String nextToken() {
return nextToken;
}
/**
* For responses, this returns true if the service returned a value for the TranscriptionJobSummaries 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 hasTranscriptionJobSummaries() {
return transcriptionJobSummaries != null && !(transcriptionJobSummaries instanceof SdkAutoConstructList);
}
/**
*
* Provides a summary of information about each result.
*
*
* 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 #hasTranscriptionJobSummaries} method.
*
*
* @return Provides a summary of information about each result.
*/
public final List transcriptionJobSummaries() {
return transcriptionJobSummaries;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(hasTranscriptionJobSummaries() ? transcriptionJobSummaries() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ListTranscriptionJobsResponse)) {
return false;
}
ListTranscriptionJobsResponse other = (ListTranscriptionJobsResponse) obj;
return Objects.equals(statusAsString(), other.statusAsString()) && Objects.equals(nextToken(), other.nextToken())
&& hasTranscriptionJobSummaries() == other.hasTranscriptionJobSummaries()
&& Objects.equals(transcriptionJobSummaries(), other.transcriptionJobSummaries());
}
/**
* 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("ListTranscriptionJobsResponse").add("Status", statusAsString()).add("NextToken", nextToken())
.add("TranscriptionJobSummaries", hasTranscriptionJobSummaries() ? transcriptionJobSummaries() : null).build();
}
public final 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 "TranscriptionJobSummaries":
return Optional.ofNullable(clazz.cast(transcriptionJobSummaries()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ListTranscriptionJobsResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends TranscribeResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* Lists all transcription jobs that have the status specified in your request. Jobs are ordered by creation
* date, with the newest job first.
*
*
* @param status
* Lists all transcription jobs that have the status specified in your request. Jobs are ordered by
* creation date, with the newest job first.
* @see TranscriptionJobStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see TranscriptionJobStatus
*/
Builder status(String status);
/**
*
* Lists all transcription jobs that have the status specified in your request. Jobs are ordered by creation
* date, with the newest job first.
*
*
* @param status
* Lists all transcription jobs that have the status specified in your request. Jobs are ordered by
* creation date, with the newest job first.
* @see TranscriptionJobStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see TranscriptionJobStatus
*/
Builder status(TranscriptionJobStatus status);
/**
*
* If NextToken is present in your response, it indicates that not all results are displayed. To
* view the next set of results, copy the string associated with the NextToken parameter in your
* results output, then run your request again including NextToken with the value of the copied
* string. Repeat as needed to view all your results.
*
*
* @param nextToken
* If NextToken is present in your response, it indicates that not all results are
* displayed. To view the next set of results, copy the string associated with the NextToken
* parameter in your results output, then run your request again including NextToken with
* the value of the copied string. Repeat as needed to view all your results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* Provides a summary of information about each result.
*
*
* @param transcriptionJobSummaries
* Provides a summary of information about each result.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder transcriptionJobSummaries(Collection transcriptionJobSummaries);
/**
*
* Provides a summary of information about each result.
*
*
* @param transcriptionJobSummaries
* Provides a summary of information about each result.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder transcriptionJobSummaries(TranscriptionJobSummary... transcriptionJobSummaries);
/**
*
* Provides a summary of information about each result.
*
* 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 #transcriptionJobSummaries(List)}.
*
* @param transcriptionJobSummaries
* 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 #transcriptionJobSummaries(List)
*/
Builder transcriptionJobSummaries(Consumer... transcriptionJobSummaries);
}
static final class BuilderImpl extends TranscribeResponse.BuilderImpl implements Builder {
private String status;
private String nextToken;
private List transcriptionJobSummaries = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ListTranscriptionJobsResponse model) {
super(model);
status(model.status);
nextToken(model.nextToken);
transcriptionJobSummaries(model.transcriptionJobSummaries);
}
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(TranscriptionJobStatus status) {
this.status(status == null ? null : status.toString());
return this;
}
public final String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final List getTranscriptionJobSummaries() {
List result = TranscriptionJobSummariesCopier
.copyToBuilder(this.transcriptionJobSummaries);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTranscriptionJobSummaries(Collection transcriptionJobSummaries) {
this.transcriptionJobSummaries = TranscriptionJobSummariesCopier.copyFromBuilder(transcriptionJobSummaries);
}
@Override
public final Builder transcriptionJobSummaries(Collection transcriptionJobSummaries) {
this.transcriptionJobSummaries = TranscriptionJobSummariesCopier.copy(transcriptionJobSummaries);
return this;
}
@Override
@SafeVarargs
public final Builder transcriptionJobSummaries(TranscriptionJobSummary... transcriptionJobSummaries) {
transcriptionJobSummaries(Arrays.asList(transcriptionJobSummaries));
return this;
}
@Override
@SafeVarargs
public final Builder transcriptionJobSummaries(Consumer... transcriptionJobSummaries) {
transcriptionJobSummaries(Stream.of(transcriptionJobSummaries)
.map(c -> TranscriptionJobSummary.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public ListTranscriptionJobsResponse build() {
return new ListTranscriptionJobsResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy