software.amazon.awssdk.services.polly.model.DescribeVoicesResponse Maven / Gradle / Ivy
Show all versions of polly 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.polly.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 DescribeVoicesResponse extends PollyResponse implements
ToCopyableBuilder {
private static final SdkField> VOICES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Voices")
.getter(getter(DescribeVoicesResponse::voices))
.setter(setter(Builder::voices))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Voices").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Voice::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(DescribeVoicesResponse::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays
.asList(VOICES_FIELD, NEXT_TOKEN_FIELD));
private final List voices;
private final String nextToken;
private DescribeVoicesResponse(BuilderImpl builder) {
super(builder);
this.voices = builder.voices;
this.nextToken = builder.nextToken;
}
/**
* For responses, this returns true if the service returned a value for the Voices 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 hasVoices() {
return voices != null && !(voices instanceof SdkAutoConstructList);
}
/**
*
* A list of voices with their properties.
*
*
* 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 #hasVoices} method.
*
*
* @return A list of voices with their properties.
*/
public final List voices() {
return voices;
}
/**
*
* The pagination token to use in the next request to continue the listing of voices. NextToken is
* returned only if the response is truncated.
*
*
* @return The pagination token to use in the next request to continue the listing of voices. NextToken
* is returned only if the response is truncated.
*/
public final String nextToken() {
return nextToken;
}
@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(hasVoices() ? voices() : null);
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
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 DescribeVoicesResponse)) {
return false;
}
DescribeVoicesResponse other = (DescribeVoicesResponse) obj;
return hasVoices() == other.hasVoices() && Objects.equals(voices(), other.voices())
&& Objects.equals(nextToken(), other.nextToken());
}
/**
* 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("DescribeVoicesResponse").add("Voices", hasVoices() ? voices() : null)
.add("NextToken", nextToken()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Voices":
return Optional.ofNullable(clazz.cast(voices()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeVoicesResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends PollyResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* A list of voices with their properties.
*
*
* @param voices
* A list of voices with their properties.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder voices(Collection voices);
/**
*
* A list of voices with their properties.
*
*
* @param voices
* A list of voices with their properties.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder voices(Voice... voices);
/**
*
* A list of voices with their properties.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.polly.model.Voice.Builder} avoiding the need to create one manually
* via {@link software.amazon.awssdk.services.polly.model.Voice#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.polly.model.Voice.Builder#build()} is called immediately and its
* result is passed to {@link #voices(List)}.
*
* @param voices
* a consumer that will call methods on {@link software.amazon.awssdk.services.polly.model.Voice.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #voices(java.util.Collection)
*/
Builder voices(Consumer... voices);
/**
*
* The pagination token to use in the next request to continue the listing of voices. NextToken is
* returned only if the response is truncated.
*
*
* @param nextToken
* The pagination token to use in the next request to continue the listing of voices.
* NextToken is returned only if the response is truncated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
}
static final class BuilderImpl extends PollyResponse.BuilderImpl implements Builder {
private List voices = DefaultSdkAutoConstructList.getInstance();
private String nextToken;
private BuilderImpl() {
}
private BuilderImpl(DescribeVoicesResponse model) {
super(model);
voices(model.voices);
nextToken(model.nextToken);
}
public final List getVoices() {
List result = VoiceListCopier.copyToBuilder(this.voices);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setVoices(Collection voices) {
this.voices = VoiceListCopier.copyFromBuilder(voices);
}
@Override
public final Builder voices(Collection voices) {
this.voices = VoiceListCopier.copy(voices);
return this;
}
@Override
@SafeVarargs
public final Builder voices(Voice... voices) {
voices(Arrays.asList(voices));
return this;
}
@Override
@SafeVarargs
public final Builder voices(Consumer... voices) {
voices(Stream.of(voices).map(c -> Voice.builder().applyMutation(c).build()).collect(Collectors.toList()));
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;
}
@Override
public DescribeVoicesResponse build() {
return new DescribeVoicesResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}