software.amazon.awssdk.services.polly.model.SynthesizeSpeechResponse 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.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
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.LocationTrait;
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 SynthesizeSpeechResponse extends PollyResponse implements
ToCopyableBuilder {
private static final SdkField CONTENT_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ContentType").getter(getter(SynthesizeSpeechResponse::contentType)).setter(setter(Builder::contentType))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("Content-Type").build()).build();
private static final SdkField REQUEST_CHARACTERS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("RequestCharacters").getter(getter(SynthesizeSpeechResponse::requestCharacters))
.setter(setter(Builder::requestCharacters))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amzn-RequestCharacters").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CONTENT_TYPE_FIELD,
REQUEST_CHARACTERS_FIELD));
private final String contentType;
private final Integer requestCharacters;
private SynthesizeSpeechResponse(BuilderImpl builder) {
super(builder);
this.contentType = builder.contentType;
this.requestCharacters = builder.requestCharacters;
}
/**
*
* Specifies the type audio stream. This should reflect the OutputFormat parameter in your request.
*
*
* -
*
* If you request mp3 as the OutputFormat, the ContentType returned is
* audio/mpeg.
*
*
* -
*
* If you request ogg_vorbis as the OutputFormat, the ContentType returned is
* audio/ogg.
*
*
* -
*
* If you request pcm as the OutputFormat, the ContentType returned is
* audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.
*
*
* -
*
* If you request json as the OutputFormat, the ContentType returned is
* application/x-json-stream.
*
*
*
*
*
*
* @return Specifies the type audio stream. This should reflect the OutputFormat parameter in your
* request.
*
* -
*
* If you request mp3 as the OutputFormat, the ContentType returned
* is audio/mpeg.
*
*
* -
*
* If you request ogg_vorbis as the OutputFormat, the ContentType
* returned is audio/ogg.
*
*
* -
*
* If you request pcm as the OutputFormat, the ContentType returned
* is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.
*
*
* -
*
* If you request json as the OutputFormat, the ContentType returned
* is application/x-json-stream.
*
*
*
*
*/
public final String contentType() {
return contentType;
}
/**
*
* Number of characters synthesized.
*
*
* @return Number of characters synthesized.
*/
public final Integer requestCharacters() {
return requestCharacters;
}
@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(contentType());
hashCode = 31 * hashCode + Objects.hashCode(requestCharacters());
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 SynthesizeSpeechResponse)) {
return false;
}
SynthesizeSpeechResponse other = (SynthesizeSpeechResponse) obj;
return Objects.equals(contentType(), other.contentType())
&& Objects.equals(requestCharacters(), other.requestCharacters());
}
/**
* 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("SynthesizeSpeechResponse").add("ContentType", contentType())
.add("RequestCharacters", requestCharacters()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ContentType":
return Optional.ofNullable(clazz.cast(contentType()));
case "RequestCharacters":
return Optional.ofNullable(clazz.cast(requestCharacters()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((SynthesizeSpeechResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends PollyResponse.Builder, SdkPojo, CopyableBuilder {
/**
*
* Specifies the type audio stream. This should reflect the OutputFormat parameter in your request.
*
*
* -
*
* If you request mp3 as the OutputFormat, the ContentType returned is
* audio/mpeg.
*
*
* -
*
* If you request ogg_vorbis as the OutputFormat, the ContentType
* returned is audio/ogg.
*
*
* -
*
* If you request pcm as the OutputFormat, the ContentType returned is
* audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.
*
*
* -
*
* If you request json as the OutputFormat, the ContentType returned is
* application/x-json-stream.
*
*
*
*
*
*
* @param contentType
* Specifies the type audio stream. This should reflect the OutputFormat parameter in your
* request.
*
* -
*
* If you request mp3 as the OutputFormat, the ContentType
* returned is audio/mpeg.
*
*
* -
*
* If you request ogg_vorbis as the OutputFormat, the ContentType
* returned is audio/ogg.
*
*
* -
*
* If you request pcm as the OutputFormat, the ContentType
* returned is audio/pcm in a signed 16-bit, 1 channel (mono), little-endian format.
*
*
* -
*
* If you request json as the OutputFormat, the ContentType
* returned is application/x-json-stream.
*
*
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder contentType(String contentType);
/**
*
* Number of characters synthesized.
*
*
* @param requestCharacters
* Number of characters synthesized.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder requestCharacters(Integer requestCharacters);
}
static final class BuilderImpl extends PollyResponse.BuilderImpl implements Builder {
private String contentType;
private Integer requestCharacters;
private BuilderImpl() {
}
private BuilderImpl(SynthesizeSpeechResponse model) {
super(model);
contentType(model.contentType);
requestCharacters(model.requestCharacters);
}
public final String getContentType() {
return contentType;
}
public final void setContentType(String contentType) {
this.contentType = contentType;
}
@Override
public final Builder contentType(String contentType) {
this.contentType = contentType;
return this;
}
public final Integer getRequestCharacters() {
return requestCharacters;
}
public final void setRequestCharacters(Integer requestCharacters) {
this.requestCharacters = requestCharacters;
}
@Override
public final Builder requestCharacters(Integer requestCharacters) {
this.requestCharacters = requestCharacters;
return this;
}
@Override
public SynthesizeSpeechResponse build() {
return new SynthesizeSpeechResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}