software.amazon.awssdk.services.transcribe.model.ListLanguageModelsResponse Maven / Gradle / Ivy
Show all versions of transcribe 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.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 ListLanguageModelsResponse extends TranscribeResponse implements
ToCopyableBuilder {
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(ListLanguageModelsResponse::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final SdkField> MODELS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Models")
.getter(getter(ListLanguageModelsResponse::models))
.setter(setter(Builder::models))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Models").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(LanguageModel::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays
.asList(NEXT_TOKEN_FIELD, MODELS_FIELD));
private final String nextToken;
private final List models;
private ListLanguageModelsResponse(BuilderImpl builder) {
super(builder);
this.nextToken = builder.nextToken;
this.models = builder.models;
}
/**
*
* 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 Models 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 hasModels() {
return models != null && !(models instanceof SdkAutoConstructList);
}
/**
*
* Provides information about the custom language models that match the criteria specified in your request.
*
*
* 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 #hasModels} method.
*
*
* @return Provides information about the custom language models that match the criteria specified in your request.
*/
public final List models() {
return models;
}
@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(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(hasModels() ? models() : 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 ListLanguageModelsResponse)) {
return false;
}
ListLanguageModelsResponse other = (ListLanguageModelsResponse) obj;
return Objects.equals(nextToken(), other.nextToken()) && hasModels() == other.hasModels()
&& Objects.equals(models(), other.models());
}
/**
* 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("ListLanguageModelsResponse").add("NextToken", nextToken())
.add("Models", hasModels() ? models() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "Models":
return Optional.ofNullable(clazz.cast(models()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ListLanguageModelsResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends TranscribeResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* 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 information about the custom language models that match the criteria specified in your request.
*
*
* @param models
* Provides information about the custom language models that match the criteria specified in your
* request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder models(Collection models);
/**
*
* Provides information about the custom language models that match the criteria specified in your request.
*
*
* @param models
* Provides information about the custom language models that match the criteria specified in your
* request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder models(LanguageModel... models);
/**
*
* Provides information about the custom language models that match the criteria specified in your request.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.transcribe.model.LanguageModel.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.transcribe.model.LanguageModel#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.transcribe.model.LanguageModel.Builder#build()} is called immediately
* and its result is passed to {@link #models(List)}.
*
* @param models
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.transcribe.model.LanguageModel.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #models(java.util.Collection)
*/
Builder models(Consumer... models);
}
static final class BuilderImpl extends TranscribeResponse.BuilderImpl implements Builder {
private String nextToken;
private List models = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ListLanguageModelsResponse model) {
super(model);
nextToken(model.nextToken);
models(model.models);
}
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 getModels() {
List result = ModelsCopier.copyToBuilder(this.models);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setModels(Collection models) {
this.models = ModelsCopier.copyFromBuilder(models);
}
@Override
public final Builder models(Collection models) {
this.models = ModelsCopier.copy(models);
return this;
}
@Override
@SafeVarargs
public final Builder models(LanguageModel... models) {
models(Arrays.asList(models));
return this;
}
@Override
@SafeVarargs
public final Builder models(Consumer... models) {
models(Stream.of(models).map(c -> LanguageModel.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@Override
public ListLanguageModelsResponse build() {
return new ListLanguageModelsResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}